curl -X POST 'https://api.github.com/repos/example-owner/example-repo/autolinks' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "key_prefix": "example-key-prefix",
  "url_template": "example-url-template"
}'

# POST /repos/{owner}/{repo}/autolinks (GitHub API)
Base URL: https://api.github.com
Auth: Authorization; GitHub token; required.
Request formats: application/json.
Last verified: 2026-10-20

> Create an autolink reference for a repository

## Critical Gotchas
* GitHub recommends an `Accept: application/vnd.github+json` header and an explicit `X-GitHub-Api-Version` header.
* Fine-grained tokens only authorize repositories and permissions selected when the token is created.

## cURL
curl -X POST 'https://api.github.com/repos/example-owner/example-repo/autolinks' \
  -H "Authorization: Bearer $GITHUB_TOKEN" \
  -H 'Accept: application/vnd.github+json' \
  -H 'X-GitHub-Api-Version: 2026-03-10' \
  -H 'Content-Type: application/json' \
  -d '{
  "key_prefix": "example-key-prefix",
  "url_template": "example-url-template"
}'

## Parameters
| Name | In | Type | Required | Description |
| :--- | :--- | :--- | :--- | :--- |
| owner | path | string | Yes | The account owner of the repository. The name is not case sensitive. |
| repo | path | string | Yes | The name of the repository without the `.git` extension. The name is not case... |
| key_prefix | body | string | Yes | This prefix appended by certain characters will generate a link any time it i... |
| url_template | body | string | Yes | The URL must contain `<num>` for the reference number. `<num>` matches differ... |
| is_alphanumeric | body | boolean | No | Whether this autolink reference matches alphanumeric characters. If true, the... |

## Response example
{"id":3,"key_prefix":"TICKET-"}

---
Need an API key? Get one at https://github.com/settings/tokens

POST

POST /repos/{owner}/{repo}/autolinks — GitHub API

GitHub token (required); https://api.github.com

GitHub API

Create an autolink reference for a repository

Base URL: https://api.github.com
Auth: Authorization: Bearer <GITHUB_API_KEY>
Last verified: 2026-10-20 · upstream hash matched

Actions Try in browser→

Agents: curl -H "Accept: text/markdown" this URL
→ 307 tokens · Vary: Accept

Critical gotchas

GitHub recommends an Accept: application/vnd.github+json header and an explicit X-GitHub-Api-Version header.

Fine-grained tokens only authorize repositories and permissions selected when the token is created.

cURL

curl -X POST 'https://api.github.com/repos/example-owner/example-repo/autolinks' \  -H "Authorization: Bearer $GITHUB_TOKEN" \  -H 'Accept: application/vnd.github+json' \  -H 'X-GitHub-Api-Version: 2026-03-10' \  -H 'Content-Type: application/json' \  -d '{  "key_prefix": "example-key-prefix",  "url_template": "example-url-template"}'

Parameters

Name	In	Type	Required	Description
owner	path	string	Yes	The account owner of the repository. The name is not case sensitive.
repo	path	string	Yes	The name of the repository without the `.git` extension. The name is not case sensitive.
key_prefix	body	string	Yes	This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.
url_template	body	string	Yes	The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`.
is_alphanumeric	body	boolean	No	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.

Response 200 OK

{
  "id": 3,
  "key_prefix": "TICKET-",
  "url_template": "https://example.com/TICKET?query=<num>",
  "is_alphanumeric": true,
  "updated_at": "2026-09-03T00:00:00Z"
}

Get a free GitHub API key → sponsored

Affiliate link - we may earn a commission, at no extra cost to you.