Create an autolink reference for a repository

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

curl --location --request POST 'https://api.github.com/repos///autolinks' \ --header 'Content-Type: application/json' \ --data-raw '{ "is_alphanumeric": true, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>" }'

Request

Path Params

owner

string

required

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

repo

string

required

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

Body Params application/json

is_alphanumeric

boolean

optional

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

key_prefix

string

required

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

required

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

Examples

Responses

🟢201response

application/json

Body

An autolink reference.

integer

required

Example:

is_alphanumeric

boolean

required

Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.

Example:

true

key_prefix

string

required

The prefix of a key that is linkified.

Example:

TICKET-

url_template

string

required

A template for the target URL that is generated if a key was found.

Example:

https://example.com/TICKET?query=<num>

🟠422422