This version of GitHub Enterprise Server was discontinued on 2024-01-04. No patch releases will be made, even for critical security issues. For better performance, improved security, and new features, upgrade to the latest version of GitHub Enterprise Server. For help with the upgrade, contact GitHub Enterprise support.
Repository autolinks
Use the REST API to add autolinks to external resources.
About repository autolinks
To help streamline your workflow, you can use the REST API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "Configuring autolinks to reference external resources."
GitHub Apps require repository administration permissions with read or write access to use these endpoints.
List all autolinks of a repository
This returns a list of autolinks configured for the given repository.
Information about autolinks are only available to repository administrators.
Parameters for "List all autolinks of a repository"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
Name, Type, Description |
---|
page integer Page number of the results to fetch. Default: |
HTTP response status codes for "List all autolinks of a repository"
Status code | Description |
---|---|
200 | OK |
Code samples for "List all autolinks of a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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
}
]
Create an autolink reference for a repository
Users with admin access to the repository can create an autolink.
Parameters for "Create an autolink reference for a repository"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
Name, Type, Description |
---|
key_prefix string RequiredThis prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. |
url_template string RequiredThe URL must contain |
is_alphanumeric boolean Whether this autolink reference matches alphanumeric characters. If true, the Default: |
HTTP response status codes for "Create an autolink reference for a repository"
Status code | Description |
---|---|
201 | Created |
422 | Validation failed, or the endpoint has been spammed. |
Code samples for "Create an autolink reference for a repository"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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
}
Get an autolink reference of a repository
This returns a single autolink reference by ID that was configured for the given repository.
Information about autolinks are only available to repository administrators.
Parameters for "Get an autolink reference of a repository"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
autolink_id integer RequiredThe unique identifier of the autolink. |
HTTP response status codes for "Get an autolink reference of a repository"
Status code | Description |
---|---|
200 | OK |
404 | Resource not found |
Code samples for "Get an autolink reference of a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
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
}
Delete an autolink reference from a repository
This deletes a single autolink reference by ID that was configured for the given repository.
Information about autolinks are only available to repository administrators.
Parameters for "Delete an autolink reference from a repository"
Name, Type, Description |
---|
accept string Setting to |
Name, Type, Description |
---|
owner string RequiredThe account owner of the repository. The name is not case sensitive. |
repo string RequiredThe name of the repository without the |
autolink_id integer RequiredThe unique identifier of the autolink. |
HTTP response status codes for "Delete an autolink reference from a repository"
Status code | Description |
---|---|
204 | No Content |
404 | Resource not found |
Code samples for "Delete an autolink reference from a repository"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_ID
Response
Status: 204