Get an autolink reference of a repository

GET

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

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

Information about autolinks are only available to repository administrators.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.github.com/repos///autolinks/'

Response Example

200 - Example 1

{
    "id": 3,
    "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.

autolink_id

integer

required

The unique identifier of the autolink.

Responses

🟢200Response

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>

🟠404404

Modified at 2023-08-15 02:59:24

Delete an autolink reference from a repository

Disable automated security fixes