Ahora la API REST está versionada. Para obtener más información, consulta "Acerca del control de versiones de la API".

Puntos de conexión de la API de REST para vínculos automáticos del repositorio

Usa la API REST para agregar vínculos automáticos a recursos externos.

Para ayudar a optimizar tu flujo de trabajo, puedes utilizar la API REST para agregar vínculos automáticos a recursos externos como incidencias de JIRA y vales de Zendesk. Para más información, consulta Configurar enlaces automáticos para referenciar recursos externos.

Las GitHub Apps requieren permisos de administración de repositorios con acceso de lectura o escritura para utilizar estos puntos de conexión.

Gets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Administration" repository permissions (read)

Parámetros para "Get all autolinks of a repository"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
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.

http_status_code

status_codeDescripción
200

OK

code_samples

request_example

get/repos/{owner}/{repo}/autolinks
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/autolinks

Response

Status: 200
[ { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true } ]

Users with admin access to the repository can create an autolink.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Administration" repository permissions (write)

Parámetros para "Create an autolink reference for a repository"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
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
key_prefix string Obligatorio

This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.

url_template string Obligatorio

The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.

is_alphanumeric boolean

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

Valor predeterminado: true

http_status_code

status_codeDescripción
201

Created

422

Validation failed, or the endpoint has been spammed.

code_samples

request_example

post/repos/{owner}/{repo}/autolinks
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/autolinks \ -d '{"key_prefix":"TICKET-","url_template":"https://example.com/TICKET?query=<num>","is_alphanumeric":true}'

response

Status: 201
{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }

This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Administration" repository permissions (read)

Parámetros para "Get an autolink reference of a repository"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
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.

autolink_id integer Obligatorio

The unique identifier of the autolink.

http_status_code

status_codeDescripción
200

OK

404

Resource not found

code_samples

request_example

get/repos/{owner}/{repo}/autolinks/{autolink_id}
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/autolinks/AUTOLINK_ID

Response

Status: 200
{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }

This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.

fine_grained_access

works_with_fine_grained_tokens:

permission_set:

  • "Administration" repository permissions (write)

Parámetros para "Delete an autolink reference from a repository"

Encabezados
accept string

Setting to application/vnd.github+json is recommended.

Parámetros de ruta
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.

autolink_id integer Obligatorio

The unique identifier of the autolink.

http_status_code

status_codeDescripción
204

No Content

404

Resource not found

code_samples

request_example

delete/repos/{owner}/{repo}/autolinks/{autolink_id}
curl -L \ -X DELETE \ -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/autolinks/AUTOLINK_ID

Response

Status: 204