# Registrations (https://developer.godaddy.com/en/docs/references/rest/domains/v3/registrations) *** title: Registrations description: > Top-level registration entity collection. Execute a domain registration by POSTing with a quoteToken, domain, period, and consent. Returns a Registration entity with links to the concrete poll URL (GET /registrations/) and the abstract operation (GET /operations/). full: true \_openapi: toc: * depth: 2 title: Register a domain (requires quoteToken) url: '#register-a-domain-requires-quotetoken' * depth: 2 title: Get a registration record url: '#get-a-registration-record' structuredData: headings: * content: Register a domain (requires quoteToken) id: register-a-domain-requires-quotetoken * content: Get a registration record id: get-a-registration-record contents: * content: > Executes a previously quoted domain registration. \*\*Irreversible once accepted; creates a charge.\*\* Requires a valid unexpired quoteToken from `quoteDomainRegistration`, an `Idempotency-Key` header, and a consent record. The target domain and period are in the request body alongside the quoteToken. Before calling this endpoint, retrieve `requiredAgreements` from the quote response and review each agreement before submitting the registration. Each agreement includes a `title` (display label) and optional `url` (full legal text). The `consent.agreementTypes` array must contain the `agreementType` value from every item in `requiredAgreements`; a mismatch returns `INVALID_AGREEMENT_KEYS`. Idempotency takes precedence over the single-use check: retrying with the same `Idempotency-Key` replays the original operation even after the token is consumed. Returns a `Registration` entity. Poll `links[rel=self]` (`GET /registrations/{registrationId}`) until status is `COMPLETED` or `FAILED`. The `operationId` field is also provided for clients that prefer `GET /operations/{operationId}`; both resolve the same resource. Poll either until status is `COMPLETED` or `FAILED`. The operation is fire-and-forget; always poll at least once even if the server completed it synchronously. When `iscCode` was supplied at quote time, the same value must be provided here or the request fails with `quote_mismatch`. heading: register-a-domain-requires-quotetoken * content: > Returns a single registration record by its server-assigned registrationId, including the current execution status and the domain expiry date once the registration completes. This is the concrete poll endpoint for registration operations; the abstract equivalent is GET /operations/. heading: get-a-registration-record *** ## POST /registrations Register a domain (requires quoteToken) Executes a previously quoted domain registration. **Irreversible once accepted; creates a charge.** Requires a valid unexpired quoteToken from `quoteDomainRegistration`, an `Idempotency-Key` header, and a consent record. The target domain and period are in the request body alongside the quoteToken. Before calling this endpoint, retrieve `requiredAgreements` from the quote response and review each agreement before submitting the registration. Each agreement includes a `title` (display label) and optional `url` (full legal text). The `consent.agreementTypes` array must contain the `agreementType` value from every item in `requiredAgreements`; a mismatch returns `INVALID_AGREEMENT_KEYS`. Idempotency takes precedence over the single-use check: retrying with the same `Idempotency-Key` replays the original operation even after the token is consumed. Returns a `Registration` entity. Poll `links[rel=self]` (`GET /registrations/{registrationId}`) until status is `COMPLETED` or `FAILED`. The `operationId` field is also provided for clients that prefer `GET /operations/{operationId}`; both resolve the same resource. Poll either until status is `COMPLETED` or `FAILED`. The operation is fire-and-forget; always poll at least once even if the server completed it synchronously. When `iscCode` was supplied at quote time, the same value must be provided here or the request fails with `quote_mismatch`. When `period` was supplied at quote time, the same value must be provided here or the request fails with `quote_mismatch`. When `profile` or `profileId` was supplied at quote time, the same value must be provided here or the request fails with `quote_mismatch`. ### Query parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `iscCode` | string | no | ISC (International Shopper Code) for pricing context. When provided, prices reflect the applicable rates for this ISC. | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. | | `Idempotency-Key` | string | yes | Client-generated unique key (UUID recommended). Retrying a mutating request with the same Idempotency-Key returns the original response without creating a duplicate side effect. Required on all execute endpoints. | ### Request body (required) Content-Type: `application/json` ```json { "domain": "example.com", "period": 1, "quoteToken": "7f3a2b1c-9d8e-4012-a5b6-c1d2e3f4a5b6", "consent": { "agreementTypes": [ "API_DPA" ], "agreedAt": "2026-06-12T10:02:00Z" } } ``` Schema: - object — A domain registration entity created when a POST /registrations request is accepted. Registrations are a top-level resource with their own stable registrationId; the domain relationship is captured in the representation. - `registrationId`: allOf(string & unknown) - `domain` (required): string — The domain name to register, in punycode A-label form for IDNs. Must match the domain in the quoteToken. - `period`: integer — Registration period in years. Must match the period in the quote. - `profileId`: allOf(string & unknown) - `profile`: allOf(object & unknown) - `quoteToken` (required): allOf(string & unknown) - `consent` (required): allOf(object & unknown) - `status`: allOf(string & unknown) - `operationId`: allOf(string & unknown) - `expiresAt`: allOf(string & unknown) - `createdAt`: allOf(string & unknown) - `updatedAt`: allOf(string & unknown) - `links`: array — HATEOAS link relations for this registration. rel=self — the canonical URL for this registration record. rel=domain — the registered domain-name resource once the registration is complete. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. ### Responses **202** — Registration accepted. Poll the self link for status. Content-Type: `application/json` ```json { "registrationId": "3a8f1c2d-7e6b-4f9a-b1c0-d2e3f4a5b6c7", "domain": "example.com", "period": 1, "price": { "currencyCode": "USD", "value": 1199 }, "consent": { "agreementTypes": [ "API_DPA" ], "agreedAt": "2026-06-12T10:02:00Z", "agreedBy": { "type": "DIRECT", "principal": "550e8400-e29b-41d4-a716-446655440000", "ip": "203.0.113.7" } }, "status": "CONFIRMED", "operationId": "9f1c2e7a-4b3d-4e8f-a1c2-3d4e5f6a7b8c", "createdAt": "2026-06-12T10:02:05Z", "updatedAt": "2026-06-12T10:02:05Z", "links": [ { "rel": "self", "href": "https://api.godaddy.com/v3/domains/registrations/3a8f1c2d-7e6b-4f9a-b1c0-d2e3f4a5b6c7" } ] } ``` Schema: - object — A domain registration entity created when a POST /registrations request is accepted. Registrations are a top-level resource with their own stable registrationId; the domain relationship is captured in the representation. - `registrationId`: allOf(string & unknown) - `domain` (required): string — The domain name to register, in punycode A-label form for IDNs. Must match the domain in the quoteToken. - `period`: integer — Registration period in years. Must match the period in the quote. - `profileId`: allOf(string & unknown) - `profile`: allOf(object & unknown) - `quoteToken` (required): allOf(string & unknown) - `consent` (required): allOf(object & unknown) - `status`: allOf(string & unknown) - `operationId`: allOf(string & unknown) - `expiresAt`: allOf(string & unknown) - `createdAt`: allOf(string & unknown) - `updatedAt`: allOf(string & unknown) - `links`: array — HATEOAS link relations for this registration. rel=self — the canonical URL for this registration record. rel=domain — the registered domain-name resource once the registration is complete. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **400** — Malformed request syntax, missing required field, or invalid field type. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **401** — Authentication credentials are missing or invalid. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **403** — Authenticated identity is not authorized to perform this operation. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **409** — Conflict — the request cannot be completed in the current state. Used for quote lifecycle errors (quote_expired, quote_mismatch, quote_consumed), domain state conflicts such as domain_already_exists, and immutable DNS records (dns_record_not_mutable) such as GoDaddy-managed SOA and NS records. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **422** — Semantically invalid request — valid structure but violates a business rule, such as an ineligible contact, unsupported TLD, or non-renewable domain status. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **429** — Too many requests — rate limit exceeded. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **Security:** requires `bearerAuth`. ## GET /registrations/{registrationId} Get a registration record Returns a single registration record by its server-assigned registrationId, including the current execution status and the domain expiry date once the registration completes. This is the concrete poll endpoint for registration operations; the abstract equivalent is GET /operations/{operationId}. ### Path parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `registrationId` | string | yes | Server-assigned registration identifier. | ### Header parameters | Name | Type | Required | Description | |------|------|----------|-------------| | `X-Request-Id` | string | no | Optional client-generated request correlation identifier, propagated across services and returned in the response X-Request-Id header. | ### Responses **200** — Registration record returned. Content-Type: `application/json` Schema: - object — A domain registration entity created when a POST /registrations request is accepted. Registrations are a top-level resource with their own stable registrationId; the domain relationship is captured in the representation. - `registrationId`: allOf(string & unknown) - `domain` (required): string — The domain name to register, in punycode A-label form for IDNs. Must match the domain in the quoteToken. - `period`: integer — Registration period in years. Must match the period in the quote. - `profileId`: allOf(string & unknown) - `profile`: allOf(object & unknown) - `quoteToken` (required): allOf(string & unknown) - `consent` (required): allOf(object & unknown) - `status`: allOf(string & unknown) - `operationId`: allOf(string & unknown) - `expiresAt`: allOf(string & unknown) - `createdAt`: allOf(string & unknown) - `updatedAt`: allOf(string & unknown) - `links`: array — HATEOAS link relations for this registration. rel=self — the canonical URL for this registration record. rel=domain — the registered domain-name resource once the registration is complete. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **401** — Authentication credentials are missing or invalid. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **403** — Authenticated identity is not authorized to perform this operation. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **404** — The requested resource was not found. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **429** — Too many requests — rate limit exceeded. Content-Type: `application/json` Schema: - object — The error information. - `name` (required): string — The human-readable, unique name of the error. - `correlationId` (required): string — Internal identifier used for correlation purposes. - `message` (required): string — The message that describes the error. - `informationLink`: string — The URI for detailed information related to this error for the developer. - `details`: array — An array of additional details about the error. Required for client-side `4XX` errors. - items: - `field`: string — The field that caused the error. If the field is in the body, set this value to the JSON pointer to that field. Required for client-side errors. - `value`: string — The value of the field that caused the error. - `location`: string — The location of the field that caused the error. Value is `body`, `path`, or `query`. - `issue` (required): string — The unique fine-grained application-level error code. - `description`: string — The human-readable description for an issue. The description MAY change over the lifetime of an API, so clients MUST NOT depend on this value. - `links`: array — An array of error-related HATEOAS links. - items: - `href` (required): string — The complete target URL, or link, to use in combination with the method to make the related call, as defined by [RFC 6570 - URI Template](https://tools.ietf.org/html/rfc6570), with the addition of the `$`, `(`, and `)` characters for pre-processing. The `href` is the key HATEOAS component that links a completed call with a subsequent call. - `rel` (required): string — The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which is an identifier for a link that unambiguously describes the semantics of the link. For values, see [Link Relationship Types](https://www.iana.org/assignments/link-relations/link-relations.xhtml). - `title`: string — The link title. - `targetMediaType`: string — The [RFC 2046-defined media type](https://www.ietf.org/rfc/rfc2046.txt) that describes the link target. - `targetSchema`: unknown — The schema that describes the link target. - `method`: string — The method to use to request the link target. For example, for HTTP, this might be `GET` or `DELETE`. - `submissionMediaType`: string — The media type with which to submit data with the request. - `submissionSchema`: unknown — The schema that describes the request data. **Security:** requires `bearerAuth`.