We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.
Autolinks für Repositorys
Verwende die REST-API, um automatische Links zu externen Ressourcen hinzuzufügen.
Informationen zu automatischen Links für Repositorys
Um deinen Workflow zu optimieren, kannst du die REST-API verwenden, um automatische Links zu externen Ressourcen wie JIRA-Issues und Zendesk-Tickets hinzuzufügen. Weitere Informationen findest du unter Automatische Verlinkungen von externen Ressourcen konfigurieren.
GitHub Apps erfordern Verwaltungsberechtigungen für das Repository mit Lese- oder Schreibzugriff, damit diese Endpunkte verwendet werden können.
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"
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Path parameters |
Name, Type, Description |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Query parameters |
Name, Type, Description |
page integerPage 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>"
}
]
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"
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Path parameters |
Name, Type, Description |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Body parameters |
Name, Type, Description |
key_prefix stringRequiredThe prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit. |
url_template stringRequiredThe URL must contain |
is_alphanumeric booleanWhether 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>"
}
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"
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Path parameters |
Name, Type, Description |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
autolink_id integerRequiredThe 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>"
}
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"
Headers |
---|
Name, Type, Description |
accept stringSetting to |
Path parameters |
Name, Type, Description |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
autolink_id integerRequiredThe 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