Skip to content
Start here

Extensions

List extensions
client.registrar.extensions.list(ExtensionListParams { account_id, cursor, direction, 3 more } params, RequestOptionsoptions?): CursorPagination<ExtensionListResponse { metadata, registration_schema } >
GET/accounts/{account_id}/registrar/extensions
Get extension
client.registrar.extensions.get(stringextension, ExtensionGetParams { account_id } params, RequestOptionsoptions?): ExtensionGetResponse { metadata, registration_schema }
GET/accounts/{account_id}/registrar/extensions/{extension}
ModelsExpand Collapse
ExtensionListResponse { metadata, registration_schema }

Extension entry with metadata and JSON Schema documents for the registration operation.

metadata: Metadata { name, tld }

Extension metadata

name: string

The full name of the extension. For example, “co.uk”, or “uk”

tld: string

The tld of the extension. For example, for “co.uk”, it’s “uk”. For “uk”, it’s “uk”

registration_schema: unknown

JSON Schema describing the expected input structure for registration operations on this extension.

ExtensionGetResponse { metadata, registration_schema }

Extension entry with metadata and JSON Schema documents for the registration operation.

metadata: Metadata { name, tld }

Extension metadata

name: string

The full name of the extension. For example, “co.uk”, or “uk”

tld: string

The tld of the extension. For example, for “co.uk”, it’s “uk”. For “uk”, it’s “uk”

registration_schema: unknown

JSON Schema describing the expected input structure for registration operations on this extension.