Skip to main content

autolinks

Overview

Nameautolinks
TypeResource
Idgithub.repos.autolinks

Fields

NameDatatypeDescription
idinteger
is_alphanumericbooleanWhether this autolink reference matches alphanumeric characters. If false, this autolink reference only matches numeric characters.
key_prefixstringThe prefix of a key that is linkified.
url_templatestringA template for the target URL that is generated if a key was found.

Methods

NameAccessible byRequired ParamsDescription
get_autolinkSELECTautolink_id, owner, repoThis returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.
list_autolinksSELECTowner, repoThis returns a list of autolinks configured for the given repository.

Information about autolinks are only available to repository administrators.
create_autolinkINSERTowner, repo, data__key_prefix, data__url_templateUsers with admin access to the repository can create an autolink.
delete_autolinkDELETEautolink_id, owner, repoThis deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.