Sample - GitHub REST API
POST/repos/{owner}/{repo}/autolinks

Create an autolink reference for a repository

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

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 3 body fields
ownerstringrequired
The account owner of the repository. The name is not case sensitive.
repostringrequired
The name of the repository without the `.git` extension. The name is not case sensitive.
key_prefixstringrequired
This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.
url_templatestringrequired
The URL must contain `<num>` for the reference number. `<num>` matches different characters depending on the value of `is_alphanumeric`.
is_alphanumericbooleanoptional
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

2 status codes
201response
idintegerrequired
key_prefixstringrequired
The prefix of a key that is linkified.
url_templatestringrequired
A template for the target URL that is generated if a key was found.
is_alphanumericbooleanrequired
Whether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
updated_atstringoptional
422Validation failed, or the endpoint has been spammed.
messagestringrequired
documentation_urlstringrequired
errorsarray<object>optional

Error handling

A 422 is returned: Validation failed, or the endpoint has been spammed.