Liens automatiques du référentiel

Utilisez l’API REST pour ajouter des liens automatiques à des ressources externes.

À propos des liens automatiques du référentiel

Pour simplifier votre workflow, vous pouvez utiliser l’API REST afin d’ajouter des liens automatiques à des ressources externes comme des problèmes JIRA et des tickets Zendesk. Pour plus d’informations, consultez « Configuration des liens automatiques pour référencer des ressources externes ».

Les GitHub Apps nécessitent des autorisations d’administration de référentiel avec un accès en lecture ou en écriture pour utiliser ces points de terminaison.

List all autolinks of a repository

Works with GitHub Apps

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

Information about autolinks are only available to repository administrators.

Parameters

Headers
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nom, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Query parameters
Nom, Type, Description
`page`integer Page number of the results to fetch. Default: `1`

HTTP response status codes

Status code	Description
`200`	OK

Code samples

get/repos/{owner}/{repo}/autolinks

curl \
  -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

Works with GitHub Apps

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

Parameters

Headers
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nom, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
Body parameters
Nom, Type, Description
`key_prefix`stringRequired The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
`url_template`stringRequired The URL must contain `<num>` for the reference number.
`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. Default: `true`

HTTP response status codes

Status code	Description
`201`	Created
`422`	Validation failed, or the endpoint has been spammed.

Code samples

post/repos/{owner}/{repo}/autolinks

curl \
  -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

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.

Parameters

Headers
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nom, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`autolink_id`integerRequired The unique identifier of the autolink.

HTTP response status codes

Status code	Description
`200`	OK
`404`	Resource not found

Code samples

get/repos/{owner}/{repo}/autolinks/{autolink_id}

curl \
  -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

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.

Parameters

Headers
Nom, Type, Description
`accept`string Setting to `application/vnd.github+json` is recommended.
Path parameters
Nom, Type, Description
`owner`stringRequired The account owner of the repository. The name is not case sensitive.
`repo`stringRequired The name of the repository. The name is not case sensitive.
`autolink_id`integerRequired The unique identifier of the autolink.

HTTP response status codes

Status code	Description
`204`	No Content
`404`	Resource not found

Code samples

delete/repos/{owner}/{repo}/autolinks/{autolink_id}

curl \
  -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