Skip to main content
The REST API is now versioned. For more information, see "About API versioning".

Links automáticos do repositório

Para ajudar a agilizar o seu fluxo de trabalho, você pode usar a API para adicionar os links automáticos a recursos externos, como problemas do JIRA e tíquetes do Zendesk.

Para obter mais informações, confira "Como configurar links automáticos para referenciar recursos externos".

GitHub Apps exige permissões de administração do repositório com acesso de leitura ou gravação para usar a API de links automáticos.

Works with GitHub Apps

This returns a list of autolinks configured for the given repository.

Information about autolinks are only available to repository administrators.

Headers
Name, Type, Description
acceptstring

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

Path parameters
Name, Type, Description
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

Query parameters
Name, Type, Description
pageinteger

Page number of the results to fetch.

Default: 1

Status codeDescription
200

OK

get/repos/{owner}/{repo}/autolinks
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks

Response

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

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

Headers
Name, Type, Description
acceptstring

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

Path parameters
Name, Type, Description
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

Body parameters
Name, Type, Description
key_prefixstringRequired

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

url_templatestringRequired

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

is_alphanumericboolean

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.

Default: true

Status codeDescription
201

Created

422

Validation failed, or the endpoint has been spammed.

post/repos/{owner}/{repo}/autolinks
curl \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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 }
Works with GitHub Apps

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

Information about autolinks are only available to repository administrators.

Headers
Name, Type, Description
acceptstring

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

Path parameters
Name, Type, Description
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

autolink_idintegerRequired

The unique identifier of the autolink.

Status codeDescription
200

OK

404

Resource not found

get/repos/{owner}/{repo}/autolinks/{autolink_id}
curl \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/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 }
Works with GitHub Apps

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

Information about autolinks are only available to repository administrators.

Headers
Name, Type, Description
acceptstring

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

Path parameters
Name, Type, Description
ownerstringRequired

The account owner of the repository. The name is not case sensitive.

repostringRequired

The name of the repository. The name is not case sensitive.

autolink_idintegerRequired

The unique identifier of the autolink.

Status codeDescription
204

No Content

404

Resource not found

delete/repos/{owner}/{repo}/autolinks/{autolink_id}
curl \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>"\ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204