Puntos de conexión de la API de REST para blobs de Git

Usa la API de REST para interactuar con un blob de Git (objeto binario grande), el tipo de objeto que se usa para almacenar el contenido de cada archivo en un repositorio.

Acerca de los blobs de Git

Un blob (objeto binario grande, por sus siglas en inglés) de Git es el tipo de objeto que se utiliza para almacenar el contenido de cada archivo en un repositorio. El hash SHA-1 del archivo se calcula y almacena en el objeto del blob. Estos puntos de conexión permiten leer y escribir objetos de blob en la base de datos de Git en GitHub. Los blobs aprovechan los tipos de medios personalizados. Para obtener más información sobre el uso de tipos de multimedia en la API, consulta Introducción a la API REST.

Create a blob

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Contents" repository permissions (write)

Parámetros para "Create a blob"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`owner` string Obligatorio The account owner of the repository. The name is not case sensitive.
`repo` string Obligatorio The name of the repository without the `.git` extension. The name is not case sensitive.

Parámetros del cuerpo
Nombre, Tipo, Descripción
`content` string Obligatorio The new blob's content.
`encoding` string The encoding used for `content`. Currently, `"utf-8"` and `"base64"` are supported. Valor predeterminado: `utf-8`

http_status_code

status_code	Descripción
`201`	Created
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed

code_samples

request_example

post/repos/{owner}/{repo}/git/blobs

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/blobs \
  -d '{"content":"Content of the blob","encoding":"utf-8"}'

Response

Status: 201

{
  "url": "https://HOSTNAME/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15"
}

Get a blob

The content in the response will always be Base64 encoded.

This endpoint supports the following custom media types. For more information, see "Media types."

application/vnd.github.raw+json: Returns the raw blob data.
application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified.

Note This endpoint supports blobs up to 100 megabytes in size.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

"Contents" repository permissions (read)

allows_public_read_access

Parámetros para "Get a blob"

Encabezados
Nombre, Tipo, Descripción
`accept` string Setting to `application/vnd.github+json` is recommended.

Parámetros de ruta
Nombre, Tipo, Descripción
`owner` string Obligatorio The account owner of the repository. The name is not case sensitive.
`repo` string Obligatorio The name of the repository without the `.git` extension. The name is not case sensitive.
`file_sha` string Obligatorio

http_status_code

status_code	Descripción
`200`	OK
`403`	Forbidden
`404`	Resource not found
`409`	Conflict
`422`	Validation failed, or the endpoint has been spammed.

code_samples

request_example

get/repos/{owner}/{repo}/git/blobs/{file_sha}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/blobs/FILE_SHA

Response

Status: 200

{
  "content": "Q29udGVudCBvZiB0aGUgYmxvYg==",
  "encoding": "base64",
  "url": "https://HOSTNAME/repos/octocat/example/git/blobs/3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "sha": "3a0f86fb8db8eea7ccbb9a95f325ddbedfb25e15",
  "size": 19,
  "node_id": "Q29udGVudCBvZiB0aGUgYmxvYg=="
}