openapi: 3.1.0 info: title: GoDaddy description: GoDaddy Abuse API Terms of Use:

GoDaddy’s Abuse API is provided to simplify and standardize the abuse reporting experience. To help us streamline the review of abuse reports, you acknowledge and agree that your use of GoDaddy’s Abuse API is subject to the following quality metrics and terms of use.

GoDaddy may, in its sole and absolute discretion, change or modify these terms, and such changes or modifications shall be effective immediately upon notice to you. Your use of GoDaddy’s Abuse API after such changes or modifications shall constitute your acceptance of these terms as last revised. If you do not agree to be bound by these terms as last revised, do not use (or continue to use) our Abuse API.

As an Abuse API user, you must only submit abuse reports via the API portal and cease all email submissions, including but not limited, to phishing@godaddy.com, netabuse@godaddy.com, malware@godaddy.com, or spam@godaddy.com, etc. Any additional or duplicate submission outside of the API portal will be deprioritized for review. Submissions related to trademark, copyright or content issues may still be sent to trademarkclaims@godaddy.com, coyprightclaims@godaddy.com, and contentcomplaints@godaddy.com, respectively. Our [Front of Site](https://supportcenter.godaddy.com/AbuseReport) also describes other scenarios not covered by the API.

When you submit abuse reports via GoDaddy’s Abuse API, you must ensure that you accurately categorize the abuse type of each report to match our definitions in the API documentations provided to you. Any submission that fails to match our definitions or is miscategorized will be marked as a false positive. Examples include, but are not limited to, submissions of trademark complaints marked as phishing or malware, or submissions of copyright complaints marked as phishing or malware, etc.

If, at any time, the false positive rate of submissions exceeds 40% of your total submissions, as determined by GoDaddy, GoDaddy may in its sole discretion deprioritize any subsequent reports submitted by you and/or your organization.

You acknowledge and agree that submitting every URL for a single domain is not necessary and will not expedite the review process. If your submissions exceed five (5) URLs for a single domain, your report will be marked as a duplicate submission taking into account that the final outcome of such submissions would yield the same result as the original report. GoDaddy may in its sole discretion deprioritize reports submitted by you and/or your organization in the event more than 20% of your submissions are classified as duplicate submissions.

You further acknowledge and agree that our Customer Support lines are not intended to address abuse reporting matters or your use of GoDaddy’s Abuse API. Contacting Customer Support will not expedite the review process and may result in abuse reports being deprioritized, to be determined in our sole discretion.

Should you have any questions about GoDaddy’s Abuse API or any of the terms and conditions set forth above, please contact abuseapisupport@godaddy.com.

contact: {} version: '2' jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema servers: - url: http://api.ote-godaddy.com variables: {} paths: /v1/abuse/tickets: get: tags: - Abuse summary: getTickets description: List all abuse tickets ids that match user provided filters operationId: getTickets parameters: - name: type in: query description: The type of abuse. style: form explode: true schema: allOf: - $ref: '#/components/schemas/type15' - description: The type of abuse. - name: closed in: query description: Is this abuse ticket closed? style: form explode: true schema: type: boolean default: false - name: sourceDomainOrIp in: query description: The domain name or ip address the abuse originated from style: form explode: true schema: type: string - name: target in: query description: 'The brand/company the abuse is targeting. ie: brand name/bank name' style: form explode: true schema: type: string - name: createdStart in: query description: The earliest abuse ticket creation date to pull abuse tickets for style: form explode: true schema: type: string - name: createdEnd in: query description: The latest abuse ticket creation date to pull abuse tickets for style: form explode: true schema: type: string - name: limit in: query description: Number of abuse ticket numbers to return. style: form explode: true schema: maximum: 100 type: integer contentEncoding: int32 default: 100 - name: offset in: query description: The earliest result set record number to pull abuse tickets for style: form explode: true schema: type: integer contentEncoding: int32 default: 0 responses: '200': description: Success headers: {} content: text/plain: schema: $ref: '#/components/schemas/AbuseTicketList' '401': description: Authentication info not sent or invalid headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '422': description: Error headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' deprecated: false post: tags: - Abuse summary: createTicket description: Create a new abuse ticket operationId: createTicket parameters: [] requestBody: description: The endpoint which allows the Reporter to create a new abuse ticket content: application/json: schema: allOf: - $ref: '#/components/schemas/AbuseTicketCreate' - description: The endpoint which allows the Reporter to create a new abuse ticket contentMediaType: application/json required: true responses: '200': description: No response was specified headers: {} content: {} '201': description: Success headers: {} content: text/plain: schema: $ref: '#/components/schemas/AbuseTicketId' '401': description: Authentication info not sent or invalid headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '422': description: Error headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/abuse/tickets/{ticketId}: get: tags: - Abuse summary: getTicketInfo description: Return the abuse ticket data for a given ticket id operationId: getTicketInfo parameters: - name: ticketId in: path description: A unique abuse ticket identifier required: true style: simple schema: type: string responses: '200': description: Success headers: {} content: text/plain: schema: $ref: '#/components/schemas/AbuseTicket' '401': description: Authentication info not sent or invalid headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '404': description: Invalid ticket id provided headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/aftermarket/listings: delete: tags: - Aftermarket summary: deleteListings description: Remove listings from GoDaddy Auction operationId: deleteListings parameters: - name: domains in: query description: A comma separated list of domain names required: true style: form explode: true schema: type: array items: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/AftermarketListingAction' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/AftermarketListingAction' - xml: name: AftermarketListingAction attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/AftermarketListingAction' - xml: name: AftermarketListingAction attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Required parameters must be specified in correct format headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/aftermarket/listings/expiry: post: tags: - Aftermarket summary: addExpiryListings description: Add expiry listings into GoDaddy Auction operationId: addExpiryListings parameters: [] requestBody: description: An array of expiry listings to be loaded content: application/json: schema: type: array items: $ref: '#/components/schemas/AftermarketListingExpiryCreate' description: An array of expiry listings to be loaded contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/AftermarketListingAction' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/AftermarketListingAction' - xml: name: AftermarketListingAction attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/AftermarketListingAction' - xml: name: AftermarketListingAction attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Required parameters must be specified in correct format
Too many Listings provided
Invalid Losing Registrar Id headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/agreements: get: tags: - Agreements summary: getAgreements description: Retrieve Legal Agreements for provided agreements keys operationId: getAgreements parameters: - name: X-Private-Label-Id in: header description: PrivateLabelId to operate as, if different from JWT style: simple schema: type: integer contentEncoding: int32 - name: X-Market-Id in: header description: Unique identifier of the Market used to retrieve/translate Legal Agreements style: simple schema: type: string default: en-US - name: keys in: query description: Keys for Agreements whose details are to be retrieved required: true style: form explode: true schema: type: array items: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/LegalAgreement' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/LegalAgreement' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/LegalAgreement' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/countries: get: tags: - Countries summary: getCountries description: Authorization is not required operationId: getCountries parameters: - name: marketId in: query description: MarketId in which the request is being made, and for which responses should be localized required: true style: form explode: true schema: type: string - name: regionTypeId in: query description: Restrict countries to this region type; required if regionName is supplied style: form explode: true schema: type: integer contentEncoding: int32 - name: regionName in: query description: Restrict countries to this region name; required if regionTypeId is supplied style: form explode: true schema: type: string - name: sort in: query description: The term to sort the result countries by. style: form explode: true schema: allOf: - $ref: '#/components/schemas/sort' - description: The term to sort the result countries by. - name: order in: query description: The direction to sort the result countries by. style: form explode: true schema: allOf: - $ref: '#/components/schemas/order1' - description: The direction to sort the result countries by. - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/CountrySummary' description: '' contentMediaType: application/json '422': description: marketId is required
regionTypeId is not a valid integer
regionName is required when regionTypeId is provided
regionTypeId is required when regionName is provided headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/countries/{countryKey}: get: tags: - Countries summary: getCountry description: Authorization is not required operationId: getCountry parameters: - name: countryKey in: path description: The country key required: true style: simple schema: type: string - name: marketId in: query description: MarketId in which the request is being made, and for which responses should be localized required: true style: form explode: true schema: type: string - name: sort in: query description: The term to sort the result country states by. style: form explode: true schema: allOf: - $ref: '#/components/schemas/sort' - description: The term to sort the result country states by. - name: order in: query description: The direction to sort the result country states by. style: form explode: true schema: allOf: - $ref: '#/components/schemas/order1' - description: The direction to sort the result country states by. - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Country' description: '' contentMediaType: application/json '404': description: Country not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: marketId is required headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/domains: get: tags: - Domains summary: list Domains description: Retrieve a list of Domains for the specified Shopper operationId: listDomains parameters: - name: X-Shopper-Id in: header description: Shopper ID whose domains are to be retrieved style: simple schema: type: string - name: statuses in: query description: Only include results with `status` value in the specified set style: form explode: true schema: type: array items: $ref: '#/components/schemas/status16' - name: statusGroups in: query description: Only include results with `status` value in any of the specified groups style: form explode: true schema: type: array items: $ref: '#/components/schemas/statusGroup' - name: limit in: query description: Maximum number of domains to return style: form explode: true schema: maximum: 1000 minimum: 1 type: integer contentEncoding: int32 - name: marker in: query description: Marker Domain to use as the offset in results style: form explode: true schema: type: string - name: includes in: query description: Optional details to be included in the response style: form explode: true schema: type: array items: $ref: '#/components/schemas/include' - name: modifiedDate in: query description: Only include results that have been modified since the specified date style: form explode: true schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DomainSummary' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/DomainSummary' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/DomainSummary' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Limit must have a value no greater than 1000 headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/agreements: get: tags: - Domains summary: getAgreement description: Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons operationId: getAgreement parameters: - name: X-Market-Id in: header description: Unique identifier of the Market used to retrieve/translate Legal Agreements style: simple schema: type: string default: en-US - name: tlds in: query description: list of TLDs whose legal agreements are to be retrieved required: true style: form explode: true schema: type: array items: type: string - name: privacy in: query description: Whether or not privacy has been requested required: true style: form explode: true schema: type: boolean - name: forTransfer in: query description: Whether or not domain tranfer has been requested style: form explode: true schema: type: boolean - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/LegalAgreement' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/LegalAgreement' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/LegalAgreement' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/available: get: tags: - Domains summary: available description: Determine whether or not the specified domain is available for purchase operationId: available parameters: - name: domain in: query description: Domain name whose availability is to be checked required: true style: form explode: true schema: type: string - name: checkType in: query description: Optimize for time ('FAST') or accuracy ('FULL') style: form explode: true schema: allOf: - $ref: '#/components/schemas/checkType' - description: Optimize for time ('FAST') or accuracy ('FULL') - name: forTransfer in: query description: Whether or not to include domains available for transfer. If set to True, checkType is ignored style: form explode: true schema: type: boolean default: false - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainAvailableResponse' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainAvailableResponse' - xml: name: DomainAvailableResponse attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainAvailableResponse' - xml: name: DomainAvailableResponse attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Cannot convert domain label error
Domain is missing IDN script
Domain segment ends with dash
Domain starts with dashbr>Domain uses unsupported IDN script
FQDN fails generic validity regex
Invalid character(s) error
Invalid tld error
Non-IDN domain name must not have dashes at the third and fourth position
Reserved name error
domain must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false post: tags: - Domains summary: availableBulk description: Determine whether or not the specified domains are available for purchase operationId: availableBulk parameters: - name: checkType in: query description: Optimize for time ('FAST') or accuracy ('FULL') style: form explode: true schema: allOf: - $ref: '#/components/schemas/checkType' - description: Optimize for time ('FAST') or accuracy ('FULL') requestBody: description: Domain names for which to check availability content: application/json: schema: type: array items: type: string description: Domain names for which to check availability contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainAvailableBulk' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainAvailableBulk' - xml: name: DomainAvailableBulk attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainAvailableBulk' - xml: name: DomainAvailableBulk attribute: false wrapped: false contentMediaType: text/xml '203': description: Request was partially successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainAvailableBulkMixed' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainAvailableBulkMixed' - xml: name: DomainAvailableBulkMixed attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainAvailableBulkMixed' - xml: name: DomainAvailableBulkMixed attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Cannot convert domain label error
Domain is missing IDN script
Domain segment ends with dash
Domain starts with dash
Domain uses unsupported IDN script
FQDN fails generic validity regex
Invalid character(s) error
Invalid tld error
Non-IDN domain name must not have dashes at the third and fourth position
Reserved name error
Reserved name error
domain must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/contacts/validate: post: tags: - Domains summary: ContactsValidate description: All contacts specified in request will be validated against all domains specifed in "domains". As an alternative, you can also pass in tlds, with the exception of `uk`, which requires full domain names operationId: ContactsValidate parameters: - name: X-Private-Label-Id in: header description: PrivateLabelId to operate as, if different from JWT style: simple schema: type: integer contentEncoding: int32 default: 1 - name: marketId in: query description: MarketId in which the request is being made, and for which responses should be localized style: form explode: true schema: type: string default: en-US requestBody: description: An instance document expected for domains contacts validation content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainsContactsBulk' - description: An instance document expected for domains contacts validation contentMediaType: application/json required: true responses: '200': description: No response was specified headers: {} content: {} '204': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Request body doesn't fulfill schema, see details in `fields` headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorDomainContactsValidate' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorDomainContactsValidate' - xml: name: ErrorDomainContactsValidate attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorDomainContactsValidate' - xml: name: ErrorDomainContactsValidate attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/purchase: post: tags: - Domains summary: purchase description: Purchase and register the specified Domain operationId: purchase parameters: - name: X-Shopper-Id in: header description: The Shopper for whom the domain should be purchased style: simple schema: type: string requestBody: description: An instance document expected to match the JSON schema returned by `./schema/{tld}` content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainPurchase' - description: An instance document expected to match the JSON schema returned by `./schema/{tld}` contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainPurchaseResponse' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: domain must be specified
Based on restrictions declared in JSON schema returned by `./schema/{tld}`
Cannot convert domain label error
Domain is missing IDN script
Domain segment ends with dash
Domain starts with dash
Domain uses unsupported IDN script
FQDN fails generic validity regex
Invalid character(s) error
Invalid tld error
Non-IDN domain name must not have dashes at the third and fourth position
Reserved name error
`body` must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/purchase/schema/{tld}: get: tags: - Domains summary: schema description: Retrieve the schema to be submitted when registering a Domain for the specified TLD operationId: schema parameters: - name: tld in: path description: The Top-Level Domain whose schema should be retrieved required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/JsonSchema' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/JsonSchema' - xml: name: JsonSchema attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/JsonSchema' - xml: name: JsonSchema attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`tld` must be specified' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/purchase/validate: post: tags: - Domains summary: validate description: Validate the request body using the Domain Purchase Schema for the specified TLD operationId: validate parameters: [] requestBody: description: An instance document expected to match the JSON schema returned by `./schema/{tld}` content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainPurchase' - description: An instance document expected to match the JSON schema returned by `./schema/{tld}` contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Based on restrictions declared in JSON schema returned by `./schema/{tld}` headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/suggest: get: tags: - Domains summary: suggest description: Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history operationId: suggest parameters: - name: X-Shopper-Id in: header description: Shopper ID for which the suggestions are being generated style: simple schema: type: string - name: query in: query description: Domain name or set of keywords for which alternative domain names will be suggested style: form explode: true schema: type: string - name: country in: query description: >- Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more style: form explode: true schema: allOf: - $ref: '#/components/schemas/country1' - description: >- Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more - name: city in: query description: Name of city to be used as a hint for target region style: form explode: true schema: type: string - name: sources in: query description: >- Sources to be queried

style: form explode: true schema: type: array items: $ref: '#/components/schemas/source' - name: tlds in: query description: >- Top-level domains to be included in suggestions

NOTE: These are sample values, there are many more style: form explode: true schema: type: array items: type: string - name: lengthMax in: query description: Maximum length of second-level domain style: form explode: true schema: type: integer contentEncoding: int32 - name: lengthMin in: query description: Minimum length of second-level domain style: form explode: true schema: type: integer contentEncoding: int32 - name: limit in: query description: Maximum number of suggestions to return style: form explode: true schema: type: integer contentEncoding: int32 - name: waitMs in: query description: >- Maximum amount of time, in milliseconds, to wait for responses If elapses, return the results compiled up to that point style: form explode: true schema: type: integer contentEncoding: int32 default: 1000 - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DomainSuggestion' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/DomainSuggestion' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/DomainSuggestion' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`query` must be specified' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/tlds: get: tags: - Domains summary: tlds description: Retrieves a list of TLDs supported and enabled for sale operationId: tlds parameters: - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/TldSummary' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/TldSummary' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/TldSummary' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}: delete: tags: - Domains summary: cancel description: Cancel a purchased domain operationId: cancel parameters: - name: domain in: path description: Domain to cancel required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Unknown domain error
At least two apex (aka @) `nameServers` must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false get: tags: - Domains summary: getDomain description: Retrieve details for the specified Domain operationId: getDomain parameters: - name: X-Shopper-Id in: header description: Shopper ID expected to own the specified domain style: simple schema: type: string - name: domain in: path description: Domain name whose details are to be retrieved required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainDetail' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainDetail' - xml: name: DomainDetail attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainDetail' - xml: name: DomainDetail attribute: false wrapped: false contentMediaType: text/xml '203': description: Request was partially successful, see verifications.status for further detail headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainDetail' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainDetail' - xml: name: DomainDetail attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainDetail' - xml: name: DomainDetail attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`domain` must be specified' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false patch: tags: - Domains summary: update description: Update details for the specified Domain operationId: update parameters: - name: domain in: path description: Domain whose details are to be updated required: true style: simple schema: type: string - name: X-Shopper-Id in: header description: "Shopper for whom Domain is to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string requestBody: description: Changes to apply to existing Domain content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainUpdate' - description: Changes to apply to existing Domain contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Specified Subaccount not owned by authenticated Shopper headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '409': description: The given domain is not eligible to have its nameservers changed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: At least two apex (aka @) `nameServers` must be specified
Failed to update nameservers headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/contacts: patch: tags: - Domains summary: updateContacts description: Update domain operationId: updateContacts parameters: - name: X-Shopper-Id in: header description: "Shopper for whom domain contacts are to be updated. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose Contacts are to be updated. required: true style: simple schema: type: string requestBody: description: Changes to apply to existing Contacts content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainContacts' - description: Changes to apply to existing Contacts contentMediaType: application/json required: true responses: '200': description: No response was specified headers: {} content: {} '204': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Domain not found
Identity document not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`domain` is not a valid Domain name' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/privacy: delete: tags: - Domains summary: cancelPrivacy description: Submit a privacy cancellation request for the given domain operationId: cancelPrivacy parameters: - name: X-Shopper-Id in: header description: Shopper ID of the owner of the domain style: simple schema: type: string - name: domain in: path description: Domain whose privacy is to be cancelled required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Customer has purchased Domain Ownership Protection and the domain has expired
The domain status does not allow performing the operation
Unknown domain error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/privacy/purchase: post: tags: - Domains summary: purchasePrivacy description: Purchase privacy for a specified domain operationId: purchasePrivacy parameters: - name: X-Shopper-Id in: header description: Shopper ID of the owner of the domain style: simple schema: type: string - name: domain in: path description: Domain for which to purchase privacy required: true style: simple schema: type: string requestBody: description: Options for purchasing privacy content: application/json: schema: allOf: - $ref: '#/components/schemas/PrivacyPurchase' - description: Options for purchasing privacy contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainPurchaseResponse' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '409': description: The domain status does not allow performing the operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: End-user must read and consent to all of the following legal agreements
`domain` must match `sld.tld` headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/records: patch: tags: - Domains summary: recordAdd description: Add the specified DNS Records to the specified Domain operationId: recordAdd parameters: - name: X-Shopper-Id in: header description: "Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose DNS Records are to be augmented required: true style: simple schema: type: string requestBody: description: DNS Records to add to whatever currently exists content: application/json: schema: type: array items: $ref: '#/components/schemas/DNSRecord' description: DNS Records to add to whatever currently exists contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`domain` is not a valid Domain name' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false put: tags: - Domains summary: recordReplace description: Replace all DNS Records for the specified Domain operationId: recordReplace parameters: - name: X-Shopper-Id in: header description: "Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose DNS Records are to be replaced required: true style: simple schema: type: string requestBody: description: DNS Records to replace whatever currently exists content: application/json: schema: type: array items: $ref: '#/components/schemas/DNSRecord' description: DNS Records to replace whatever currently exists contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`domain` is not a valid Domain name
`record` does not fulfill the schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/records/{type}/{name}: get: tags: - Domains summary: recordGet description: Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name operationId: recordGet parameters: - name: X-Shopper-Id in: header description: "Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose DNS Records are to be retrieved required: true style: simple schema: type: string - name: type in: path description: DNS Record Type for which DNS Records are to be retrieved required: true style: simple schema: allOf: - $ref: '#/components/schemas/Type7' - description: DNS Record Type for which DNS Records are to be retrieved - name: name in: path description: DNS Record Name for which DNS Records are to be retrieved required: true style: simple schema: type: string - name: offset in: query description: Number of results to skip for pagination style: form explode: true schema: type: integer contentEncoding: int32 - name: limit in: query description: Maximum number of items to return style: form explode: true schema: type: integer contentEncoding: int32 - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DNSRecord' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/DNSRecord' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/DNSRecord' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`record` does not fulfill the schema
`domain` is not a valid Domain name' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false put: tags: - Domains summary: recordReplaceTypeName description: Replace all DNS Records for the specified Domain with the specified Type and Name operationId: recordReplaceTypeName parameters: - name: X-Shopper-Id in: header description: "Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose DNS Records are to be replaced required: true style: simple schema: type: string - name: type in: path description: DNS Record Type for which DNS Records are to be replaced required: true style: simple schema: allOf: - $ref: '#/components/schemas/Type7' - description: DNS Record Type for which DNS Records are to be replaced - name: name in: path description: DNS Record Name for which DNS Records are to be replaced required: true style: simple schema: type: string requestBody: description: DNS Records to replace whatever currently exists content: application/json: schema: type: array items: $ref: '#/components/schemas/DNSRecordCreateTypeName' description: DNS Records to replace whatever currently exists contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`record` does not fulfill the schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false delete: tags: - Domains summary: recordDeleteTypeName description: Delete all DNS Records for the specified Domain with the specified Type and Name operationId: recordDeleteTypeName parameters: - name: X-Shopper-Id in: header description: "Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose DNS Records are to be deleted required: true style: simple schema: type: string - name: type in: path description: DNS Record Type for which DNS Records are to be deleted required: true style: simple schema: allOf: - $ref: '#/components/schemas/type18' - description: DNS Record Type for which DNS Records are to be deleted - name: name in: path description: DNS Record Name for which DNS Records are to be deleted required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Domain not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '409': description: The given domain is not eligible to have its records changed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`domain` is not a valid Domain name' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/records/{type}: put: tags: - Domains summary: recordReplaceType description: Replace all DNS Records for the specified Domain with the specified Type operationId: recordReplaceType parameters: - name: X-Shopper-Id in: header description: "Shopper ID which owns the domain. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose DNS Records are to be replaced required: true style: simple schema: type: string - name: type in: path description: DNS Record Type for which DNS Records are to be replaced required: true style: simple schema: allOf: - $ref: '#/components/schemas/Type7' - description: DNS Record Type for which DNS Records are to be replaced requestBody: description: DNS Records to replace whatever currently exists content: application/json: schema: type: array items: $ref: '#/components/schemas/DNSRecordCreateType' description: DNS Records to replace whatever currently exists contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`record` does not fulfill the schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/renew: post: tags: - Domains summary: renew description: Renew the specified Domain operationId: renew parameters: - name: X-Shopper-Id in: header description: "Shopper for whom Domain is to be renewed. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain to renew required: true style: simple schema: type: string requestBody: description: Options for renewing existing Domain content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainRenew' - description: Options for renewing existing Domain contentMediaType: application/json required: false responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainPurchaseResponse' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '409': description: The domain status does not allow performing the operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: End-user must read and consent to all of the following legal agreements
`domain` must match `sld.tld` headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/transfer: post: tags: - Domains summary: transferIn description: Purchase and start or restart transfer process operationId: transferIn parameters: - name: X-Shopper-Id in: header description: The Shopper to whom the domain should be transfered style: simple schema: type: string - name: domain in: path description: Domain to transfer in required: true style: simple schema: type: string requestBody: description: Details for domain transfer purchase content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainTransferIn' - description: Details for domain transfer purchase contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainPurchaseResponse' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/DomainPurchaseResponse' - xml: name: DomainPurchaseResponse attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '409': description: "`domain` (domain) isn't available for transfer" headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Based on restrictions declared in JSON schema returned by `./schema/{tld}`
Cannot convert domain label error
Domain is missing IDN script
Domain segment ends with dash
Domain starts with dash
Domain uses unsupported IDN script
End-user must read and consent to all of the following legal agreements
FQDN fails generic validity regex
Invalid character(s) error
Invalid period range
Invalid tld error
Non-IDN domain name must not have dashes at the third and fourth position
Reserved name error
`authCode` cannot be empty
`domain` must match `sld.tld`
domain must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/domains/{domain}/verifyRegistrantEmail: post: tags: - Domains summary: verifyEmail description: Re-send Contact E-mail Verification for specified Domain operationId: verifyEmail parameters: - name: X-Shopper-Id in: header description: "Shopper for whom domain contact e-mail should be verified. NOTE: This is only required if you are a Reseller managing a domain purchased outside the scope of your reseller account. For instance, if you're a Reseller, but purchased a Domain via http://www.godaddy.com" style: simple schema: type: string - name: domain in: path description: Domain whose Contact E-mail should be verified. required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`domain` is not a valid Domain name' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v2/customers/{customerId}/domains/{domain}: get: tags: - Domains summary: Retrieve details for the specified Domain description: Retrieve details for the specified Domain operationId: RetrievedetailsforthespecifiedDomain parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: domain in: path description: Domain name whose details are to be retrieved required: true style: simple schema: type: string - name: includes in: query description: Optional details to be included in the response style: form explode: true schema: type: array items: $ref: '#/components/schemas/include1' responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainDetailV2' '203': description: Request was partially successful, but actions, contacts, and/or verifications may not be included. headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainDetailV2' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The contact does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`domain` must be specified' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/{domain}/redeem: post: tags: - Domains summary: Purchase a restore for the given domain to bring it out of redemption description: Purchase a restore for the given domain to bring it out of redemption operationId: Purchasearestoreforthegivendomaintobringitoutofredemption parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: domain in: path description: Domain to request redeem for required: true style: simple schema: type: string requestBody: description: Options for redeeming existing Domain content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainRedeemV2' - description: Options for redeeming existing Domain contentMediaType: application/json required: false responses: '202': description: Request Accepted. You may use GET /v2/customers/{customerId}/domains/{domain}/actions/REDEEM to poll status headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: There is already a similar action processing headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Domain invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/{domain}/transferOut: post: tags: - Domains summary: Initiate transfer out to another registrar for a .uk domain. description: Initiate transfer out to another registrar for a .uk domain. operationId: Initiatetransferouttoanotherregistrarfora.ukdomain. parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: domain in: path description: Domain to initiate the transfer out for required: true style: simple schema: type: string - name: registrar in: query description: Registrar tag to push transfer to required: true style: form explode: true schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '202': description: Request Accepted. You may use GET /v2/customers/{customerId}/domains/{domain}/actions/TRANSFER_OUT_REQUESTED to poll status headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: There is already a similar action processing headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Domain invalid. TLD must be .uk headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/forwards/{fqdn}: delete: tags: - Domains summary: domainsForwardsDelete description: Notes: operationId: domainsForwardsDelete parameters: - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: fqdn in: path description: The fully qualified domain name whose forwarding details are to be deleted. required: true style: simple schema: type: string responses: '204': description: Request was successful headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The domain status does not allow performing the operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: A valid `fqdn` must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false get: tags: - Domains summary: domainsForwardsGet description: Notes: operationId: domainsForwardsGet parameters: - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: fqdn in: path description: The fully qualified domain name whose forwarding details are to be retrieved. required: true style: simple schema: type: string - name: includeSubs in: query description: Optionally include all sub domains if the fqdn specified is a domain and not a sub domain. style: form explode: true schema: type: boolean responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DomainForwarding' description: '' contentMediaType: application/json '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: A valid `fqdn` must be specified headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false put: tags: - Domains summary: domainsForwardsPut description: Notes: operationId: domainsForwardsPut parameters: - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: fqdn in: path description: The fully qualified domain name whose forwarding details are to be modified. required: true style: simple schema: type: string requestBody: description: Domain forwarding rule to create or replace on the fqdn content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainForwardingCreate' - description: Domain forwarding rule to create or replace on the fqdn contentMediaType: application/json required: true responses: '204': description: Request was successful headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The domain status does not allow performing the operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Request body doesn't fulfill schema, see details in `fields` headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false post: tags: - Domains summary: domainsForwardsPost description: Notes: operationId: domainsForwardsPost parameters: - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your own customer id." required: true style: simple schema: type: string - name: fqdn in: path description: The fully qualified domain name whose forwarding details are to be modified. required: true style: simple schema: type: string requestBody: description: Domain forwarding rule to create for the specified fqdn content: application/json: schema: allOf: - $ref: '#/components/schemas/DomainForwardingCreate' - description: Domain forwarding rule to create for the specified fqdn contentMediaType: application/json required: true responses: '204': description: Request was successful headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Provided `fqdn` already has forwarding setup headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Request body doesn't fulfill schema, see details in `fields` headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/domains/maintenances: get: tags: - Domains summary: Retrieve a list of upcoming system Maintenances description: Retrieve a list of upcoming system Maintenances operationId: RetrievealistofupcomingsystemMaintenances parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: status in: query description: "Only include results with the selected `status` value. Returns all results if omitted
" style: form explode: true schema: allOf: - $ref: '#/components/schemas/status17' - description: "Only include results with the selected `status` value. Returns all results if omitted
" - name: modifiedAtAfter in: query description: Only include results with `modifiedAt` after the supplied date style: form explode: true schema: type: string - name: startsAtAfter in: query description: Only include results with `startsAt` after the supplied date style: form explode: true schema: type: string - name: limit in: query description: Maximum number of results to return style: form explode: true schema: maximum: 100 minimum: 1 type: integer contentEncoding: int32 default: 100 responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/Maintenance' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Filter parameters don't match schema and/or restrictions headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/domains/maintenances/{maintenanceId}: get: tags: - Domains summary: Retrieve the details for an upcoming system Maintenances description: Retrieve the details for an upcoming system Maintenances operationId: RetrievethedetailsforanupcomingsystemMaintenances parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: maintenanceId in: path description: The identifier for the system maintenance required: true style: simple schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/MaintenanceDetail' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The maintenance does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/orders: get: tags: - Orders summary: listOrders description: API Resellers operationId: listOrders parameters: - name: periodStart in: query description: Start of range indicating what time-frame should be returned. Inclusive style: form explode: true schema: type: string - name: periodEnd in: query description: End of range indicating what time-frame should be returned. Inclusive style: form explode: true schema: type: string - name: domain in: query description: Domain name to use as the filter of results style: form explode: true schema: type: string - name: productGroupId in: query description: Product group id to use as the filter of results style: form explode: true schema: type: integer contentEncoding: int32 - name: paymentProfileId in: query description: Payment profile id to use as the filter of results style: form explode: true schema: type: integer contentEncoding: int32 - name: parentOrderId in: query description: Parent order id to use as the filter of results style: form explode: true schema: type: string - name: offset in: query description: Number of results to skip for pagination style: form explode: true schema: type: integer contentEncoding: int32 default: 0 - name: limit in: query description: Maximum number of items to return style: form explode: true schema: maximum: 10000 minimum: 1 type: integer contentEncoding: int32 default: 25 - name: sort in: query description: Property name that will be used to sort results. '-' indicates descending style: form explode: true schema: allOf: - $ref: '#/components/schemas/sort2' - description: Property name that will be used to sort results. '-' indicates descending - name: X-Shopper-Id in: header description: Shopper ID to be operated on, if different from JWT
Reseller subaccounts are not supported style: simple schema: type: string - name: X-Market-Id in: header description: Unique identifier of the Market in which the request is happening style: simple schema: type: string default: en-US - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/OrderList' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/OrderList' - xml: name: OrderList attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/OrderList' - xml: name: OrderList attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/orders/{orderId}: get: tags: - Orders summary: get description: API Resellers operationId: get parameters: - name: orderId in: path description: Order id whose details are to be retrieved required: true style: simple schema: type: string - name: X-Shopper-Id in: header description: Shopper ID to be operated on, if different from JWT
Reseller subaccounts are not supported style: simple schema: type: string - name: X-Market-Id in: header description: Unique identifier of the Market in which the request is happening style: simple schema: type: string default: en-US - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/Order' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Order' - xml: name: Order attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Order' - xml: name: Order attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/customers/{customerId}/parking/metrics: get: tags: - Parking summary: getMetrics description: Returns a list of parking metrics for the specified customer, using specified filters operationId: getMetrics parameters: - name: customerId in: path description: An identifier for a customer. A special alias MY is supported when accessing the authenticated customer's own data required: true style: simple schema: type: string - name: periodStartPtz in: query description: Start of range indicating what time-frame should be returned, ***inclusive***. ISO 8601 date `YYYY-MM-DD` in PT. Default value is the day before current date style: form explode: true schema: type: string contentEncoding: date - name: periodEndPtz in: query description: End of range indicating what time-frame should be returned, ***inclusive***. ISO 8601 date `YYYY-MM-DD` in PT. Default value is the day before current date style: form explode: true schema: type: string contentEncoding: date - name: limit in: query description: Maximum number of items to return style: form explode: true schema: maximum: 200 minimum: 1 type: integer contentEncoding: int32 default: 20 - name: offset in: query description: Number of results to skip for pagination style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 0 - name: X-Request-Id in: header description: A unique identifier for the request style: simple schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/MetricList' '401': description: Authentication info not sent or invalid headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '422': description: Required parameters must be specified in correct format headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: text/plain: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/customers/{customerId}/parking/metricsByDomain: get: tags: - Parking summary: getMetricsByDomain description: Returns a list of domain metrics for the specified customer and portfolio, using specified filters operationId: getMetricsByDomain parameters: - name: customerId in: path description: An identifier for a customer. A special alias MY is supported when accessing the authenticated customer's own data required: true style: simple schema: type: string - name: startDate in: query description: Start of range indicating what time-frame should be returned, inclusive. ISO 8601 date YYYY-MM-DD required: true style: form explode: true schema: type: string contentEncoding: date - name: endDate in: query description: End of range indicating what time-frame should be returned, inclusive. ISO 8601 date YYYY-MM-DD required: true style: form explode: true schema: type: string contentEncoding: date - name: domains in: query description: An array of domains to filter the results. If this filter is not provided, all domains will be returned style: form explode: true schema: type: string - name: domainLike in: query description: represent search keyword filtering domains. If not null, `domains` will be ignored style: form explode: true schema: type: string - name: portfolioId in: query description: Unique identifier for the portfolio to filter the results. If not provided, all domains within all porfolios will be returned style: form explode: true schema: type: string contentEncoding: uuid - name: limit in: query description: Maximum number of items to return style: form explode: true schema: maximum: 200 minimum: 1 type: integer contentEncoding: int32 default: 20 - name: offset in: query description: Number of results to skip for pagination style: form explode: true schema: minimum: 0 type: integer contentEncoding: int32 default: 0 - name: X-Request-Id in: header description: A unique identifier for the request style: simple schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/MetricByDomainList' '401': description: Authentication info not sent or invalid headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '422': description: Required parameters must be specified in correct format headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: text/plain: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: text/plain: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/shoppers/subaccount: post: tags: - Shoppers summary: createSubaccount description: Create a Subaccount owned by the authenticated Reseller operationId: createSubaccount parameters: [] requestBody: description: The subaccount to create content: application/json: schema: allOf: - $ref: '#/components/schemas/SubaccountCreate' - description: The subaccount to create contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/ShopperId' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ShopperId' - xml: name: ShopperId attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ShopperId' - xml: name: ShopperId attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`subaccount` does not fulfill the schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/shoppers/{shopperId}: get: tags: - Shoppers summary: getShopper description: Notes: operationId: getShopper parameters: - name: shopperId in: path description: Shopper whose details are to be retrieved required: true style: simple schema: type: string - name: includes in: query description: Additional properties to be included in the response shopper object style: form explode: true schema: type: array items: $ref: '#/components/schemas/include2' - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/Shopper' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Shopper' - xml: name: Shopper attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Shopper' - xml: name: Shopper attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false post: tags: - Shoppers summary: updateShopper description: Notes: operationId: updateShopper parameters: - name: shopperId in: path description: The ID of the Shopper to update required: true style: simple schema: type: string requestBody: description: The Shopper details to update content: application/json: schema: allOf: - $ref: '#/components/schemas/ShopperUpdate' - description: The Shopper details to update contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/ShopperId' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ShopperId' - xml: name: ShopperId attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ShopperId' - xml: name: ShopperId attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: '`Shopper` does not fulfill the schema' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false delete: tags: - Shoppers summary: delete description: Notes: operationId: delete parameters: - name: shopperId in: path description: 'The ID of the shopper to delete. Must agree with the shopper id on the token or header, if present. *Note*: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)' required: true style: simple schema: maxLength: 10 type: string - name: auditClientIp in: query description: The client IP of the user who originated the request leading to this call. required: true style: form explode: true schema: type: string responses: '204': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '409': description: Active and locked shoppers cannot be deleted headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Shopper ID is not supplied or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/shoppers/{shopperId}/status: get: tags: - Shoppers summary: getStatus description: Notes: operationId: getStatus parameters: - name: shopperId in: path description: The ID of the shopper to retrieve. Must agree with the shopper id on the token or header, if present required: true style: simple schema: maxLength: 10 type: string - name: auditClientIp in: query description: The client IP of the user who originated the request leading to this call. required: true style: form explode: true schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/ShopperStatus' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ShopperStatus' - xml: name: ShopperStatus attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ShopperStatus' - xml: name: ShopperStatus attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Shopper ID is not supplied or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/shoppers/{shopperId}/factors/password: put: tags: - Shoppers summary: changePassword description: Notes: operationId: changePassword parameters: - name: shopperId in: path description: Shopper whose password will be set required: true style: simple schema: type: string requestBody: description: The value to set the subaccount's password to content: application/json: schema: allOf: - $ref: '#/components/schemas/Secret' - description: The value to set the subaccount's password to contentMediaType: application/json required: true responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/ShopperId' '400': description: Request was not successful headers: {} content: application/json: schema: $ref: '#/components/schemas/PasswordError' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/subscriptions: get: tags: - Subscriptions summary: list description: Retrieve a list of Subscriptions for the specified Shopper operationId: list parameters: - name: X-Shopper-Id in: header description: Shopper ID to return subscriptions for when not using JWT style: simple schema: type: string - name: X-Market-Id in: header description: The market that the response should be formatted for style: simple schema: type: string default: en-US - name: productGroupKeys in: query description: Only return Subscriptions with the specified product groups style: form explode: true schema: type: array items: type: string - name: includes in: query description: Optional details to be included in the response style: form explode: true schema: type: array items: $ref: '#/components/schemas/includes' - name: offset in: query description: Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit) style: form explode: true schema: type: integer contentEncoding: int32 default: 0 - name: limit in: query description: Number of Subscriptions to retrieve in this page, starting after offset style: form explode: true schema: maximum: 2000 minimum: 1 type: integer contentEncoding: int32 default: 25 - name: sort in: query description: Property name that will be used to sort results. "-" indicates descending style: form explode: true schema: allOf: - $ref: '#/components/schemas/sort3' - description: Property name that will be used to sort results. "-" indicates descending - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/SubscriptionList' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/SubscriptionList' - xml: name: SubscriptionList attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/SubscriptionList' - xml: name: SubscriptionList attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Invalid query parameter (custom message returned for each parameter) headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/subscriptions/productGroups: get: tags: - Subscriptions summary: productGroups description: Retrieve a list of ProductGroups for the specified Shopper operationId: productGroups parameters: - name: X-Shopper-Id in: header description: Shopper ID to return data for when not using JWT style: simple schema: type: string - name: X-Market-Id in: header description: The market that the response should be formatted for style: simple schema: type: string default: en-US - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/ProductGroup' description: '' contentMediaType: application/json application/javascript: schema: contentMediaType: application/javascript application/xml: schema: type: array items: $ref: '#/components/schemas/ProductGroup' description: '' xml: attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: type: array items: $ref: '#/components/schemas/ProductGroup' description: '' xml: attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false parameters: [] /v1/subscriptions/{subscriptionId}: delete: tags: - Subscriptions summary: cancelSubscription description: Cancel the specified Subscription operationId: cancelSubscription parameters: - name: X-Shopper-Id in: header description: Shopper ID to cancel subscriptions for when not using JWT style: simple schema: type: string - name: subscriptionId in: path description: Unique identifier of the Subscription to cancel required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Failed to determine if the domain is protected (invalid domain ID)
Invalid Subscription Id
The Office 365 Subscription cannot be cancelled (shopper is migrating)
The Subscription cannot be cancelled
The Subscription cannot be cancelled (PFID is disabled for cancellation)
The Subscription cannot be cancelled (domain is protected)
The domain alert Subscription cannot be cancelled headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Failed to determine if the Office 365 account is migrating
Failed to determine if the domain alert is cancellable
Failed to determine if the domain is protected
Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false get: tags: - Subscriptions summary: getSubscription description: Retrieve details for the specified Subscription operationId: getSubscription parameters: - name: X-Shopper-Id in: header description: Shopper ID to be operated on, if different from JWT style: simple schema: type: string - name: X-Market-Id in: header description: Unique identifier of the Market in which the request is happening style: simple schema: type: string default: en-US - name: subscriptionId in: path description: Unique identifier of the Subscription to retrieve required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/Subscription' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Subscription' - xml: name: Subscription attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Subscription' - xml: name: Subscription attribute: false wrapped: false contentMediaType: text/xml '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '422': description: Invalid Subscription Id headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/ErrorLimit' - xml: name: ErrorLimit attribute: false wrapped: false contentMediaType: text/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml '504': description: Gateway timeout headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/javascript: schema: contentMediaType: application/javascript application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml text/javascript: schema: contentMediaType: text/javascript text/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: text/xml deprecated: false patch: tags: - Subscriptions summary: updateSubscription description: Only Subscription properties that can be changed without immediate financial impact can be modified via PATCH, whereas some properties can be changed by purchasing a renewal
This endpoint only supports JWT authentication operationId: updateSubscription parameters: - name: subscriptionId in: path description: Unique identifier of the Subscription to update required: true style: simple schema: type: string requestBody: description: Details of the Subscription to change content: application/json: schema: allOf: - $ref: '#/components/schemas/SubscriptionUpdate' - description: Details of the Subscription to change contentMediaType: application/json required: true responses: '204': description: Request was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml '403': description: Authenticated user is not allowed access
This method only supports JWT authentication headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml '404': description: Subscription not found
Payment profile not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' application/xml: schema: allOf: - $ref: '#/components/schemas/Error' - xml: name: Error attribute: false wrapped: false contentMediaType: application/xml deprecated: false parameters: [] /v1/certificates: post: tags: - Certificate summary: certificate_create description: "

Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'.

" operationId: certificate_create parameters: - name: X-Market-Id in: header description: Setting locale for communications such as emails and error messages style: simple schema: type: string default: Default locale for shopper account requestBody: description: The certificate order information content: application/json: schema: allOf: - $ref: '#/components/schemas/CertificateCreate' - description: The certificate order information contentMediaType: application/json required: true responses: '202': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateIdentifier' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow renew headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`email` is not empty
`csr` is invalid' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/validate: post: tags: - Certificate summary: certificate_validate description: Validate a pending order for certificate operationId: certificate_validate parameters: - name: X-Market-Id in: header description: Setting locale for communications such as emails and error messages style: simple schema: type: string default: Default locale for shopper account requestBody: description: The certificate order info content: application/json: schema: allOf: - $ref: '#/components/schemas/CertificateCreate' - description: The certificate order info contentMediaType: application/json required: true responses: '204': description: Request validated successfully headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow renew headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`email` is not empty
`csr` is invalid' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}: get: tags: - Certificate summary: certificate_get description: Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate. operationId: certificate_get parameters: - name: certificateId in: path description: Certificate id to lookup required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Certificate details retrieved headers: {} content: application/json: schema: $ref: '#/components/schemas/Certificate' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/actions: get: tags: - Certificate summary: certificate_action_retrieve description: This method is used to retrieve all stateful actions relating to a certificate lifecycle. operationId: certificate_action_retrieve parameters: - name: certificateId in: path description: Certificate id to register for callback required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Action retrieval successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/CertificateAction' description: '' contentMediaType: application/json '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/email/{emailId}/resend: post: tags: - Certificate summary: certificate_resend_email description: This method can be used to resend emails by providing the certificate id and the email id operationId: certificate_resend_email parameters: - name: certificateId in: path description: Certificate id to resend email required: true style: simple schema: type: string - name: emailId in: path description: Email id for email to resend required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Email sent successfully headers: {} content: {} '404': description: Certificate not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Email Id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/email/resend/{emailAddress}: post: tags: - Certificate summary: certificate_alternate_email_address description: This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address. operationId: certificate_alternate_email_address parameters: - name: certificateId in: path description: Certificate id to resend emails required: true style: simple schema: type: string - name: emailAddress in: path description: Specific email address to resend email required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Alternate email address added and emails re-sent headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateEmailHistory' '404': description: Certificate not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow alternate email address headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/email/{emailId}/resend/{emailAddress}: post: tags: - Certificate summary: certificate_resend_email_address description: This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address operationId: certificate_resend_email_address parameters: - name: certificateId in: path description: Certificate id to resend emails required: true style: simple schema: type: string - name: emailId in: path description: Email id for email to resend required: true style: simple schema: type: string - name: emailAddress in: path description: Specific email address to resend email required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Email sent successfully headers: {} content: {} '404': description: Certificate not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Email Id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/email/history: get: tags: - Certificate summary: certificate_email_history description: This method can be used to retrieve all emails sent for a certificate. operationId: certificate_email_history parameters: - name: certificateId in: path description: Certificate id to retrieve email history required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Email history retrieval successful headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateEmailHistory' '409': description: Email history not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/callback: delete: tags: - Certificate summary: certificate_callback_delete description: Unregister the callback for a particular certificate. operationId: certificate_callback_delete parameters: - name: certificateId in: path description: Certificate id to unregister callback required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Callback removed headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false get: tags: - Certificate summary: certificate_callback_get description: This method is used to retrieve the registered callback url for a certificate. operationId: certificate_callback_get parameters: - name: certificateId in: path description: Certificate id to register for stateful action callback required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Callback registered headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateCallback' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false put: tags: - Certificate summary: certificate_callback_replace description: This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration. operationId: certificate_callback_replace parameters: - name: certificateId in: path description: Certificate id to register/replace for callback required: true style: simple schema: type: string - name: callbackUrl in: query description: Callback url registered/replaced to receive stateful actions required: true style: form explode: true schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Callback replaced/registered headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Callback url is missing
Callback url is malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/cancel: post: tags: - Certificate summary: certificate_cancel description: Use the cancel call to cancel a pending certificate order. operationId: certificate_cancel parameters: - name: certificateId in: path description: Certificate id to cancel required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Certificate order has been canceled headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow cancel headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/download: get: tags: - Certificate summary: certificate_download description: Download certificate operationId: certificate_download parameters: - name: certificateId in: path description: Certificate id to download required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Certificate retrieved headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateBundle' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow download headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/reissue: post: tags: - Certificate summary: certificate_reissue description:

Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of the common name may take additional time to validate. If this API call is made before a previous pending reissue has been validated and issued, the previous reissue request is automatically rejected and replaced with the current request.

operationId: certificate_reissue parameters: - name: certificateId in: path description: Certificate id to reissue required: true style: simple schema: type: string requestBody: description: The reissue request info content: application/json: schema: allOf: - $ref: '#/components/schemas/CertificateReissue' - description: The reissue request info contentMediaType: application/json required: true responses: '202': description: Reissue request created headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow reissue headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`csr` is invalid
Delay revocation exceeds maximum' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/renew: post: tags: - Certificate summary: certificate_renew description: Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the subject alternative names you expect in the renewed certificate. New names added to a certificate that do not share the base domain of the common name may take additional time to validate.

operationId: certificate_renew parameters: - name: certificateId in: path description: Certificate id to renew required: true style: simple schema: type: string requestBody: description: The renew request info content: application/json: schema: allOf: - $ref: '#/components/schemas/CertificateRenew' - description: The renew request info contentMediaType: application/json required: true responses: '202': description: Renew request created headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow renew headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`csr` is invalid' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/revoke: post: tags: - Certificate summary: certificate_revoke description: Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned. operationId: certificate_revoke parameters: - name: certificateId in: path description: Certificate id to revoke required: true style: simple schema: type: string requestBody: description: The certificate revocation request content: application/json: schema: allOf: - $ref: '#/components/schemas/CertificateRevoke' - description: The certificate revocation request contentMediaType: application/json required: true responses: '204': description: Certificate Revoked headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow revoke headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/siteSeal: get: tags: - Certificate summary: certificate_siteseal_get description:

This method is used to obtain the site seal information for an issued certificate. A site seal is a graphic that the certificate purchaser can embed on their web site to show their visitors information about their SSL certificate. If a web site visitor clicks on the site seal image, a pop-up page is displayed that contains detailed information about the SSL certificate. The site seal token is used to link the site seal graphic image to the appropriate certificate details pop-up page display when a user clicks on the site seal. The site seal images are expected to be static images and hosted on the reseller's website, to minimize delays for customer page load times.

operationId: certificate_siteseal_get parameters: - name: certificateId in: path description: Certificate id required: true style: simple schema: type: string - name: theme in: query description: This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present. style: form explode: true schema: allOf: - $ref: '#/components/schemas/theme' - description: This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present. - name: locale in: query description: Determine locale for text displayed in seal image and verification page. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present. style: form explode: true schema: type: string default: en - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Site seal retrieved headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateSiteSeal' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow seal headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: "'locale' is invalid" headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v1/certificates/{certificateId}/verifyDomainControl: post: tags: - Certificate summary: certificate_verifydomaincontrol description: Domain control is a means for verifying the domain included in the certificate order. This resource is useful for resellers that control the domains for their customers, and can expedite the verification process. See https://www.godaddy.com/help/verifying-your-domain-ownership-for-ssl-certificate-requests-html-or-dns-7452 operationId: certificate_verifydomaincontrol parameters: - name: certificateId in: path description: Certificate id to lookup required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Domain control was successful headers: {} content: {} '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Certificate id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Domain control was not successful
Certificate state does not allow domain control headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/certificates: get: tags: - Certificate summary: certificate_get_entitlement description: Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificates associated to an entitlement. operationId: certificate_get_entitlement parameters: - name: entitlementId in: query description: Entitlement id to lookup required: true style: form explode: true schema: type: string - name: latest in: query description: Fetch only the most recent certificate style: form explode: true schema: type: boolean default: true - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Certificate details retrieved headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Certificate' description: '' contentMediaType: application/json '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Entitlement id not provided headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/certificates/download: get: tags: - Certificate summary: certificate_download_entitlement description: Download certificate by entitlement operationId: certificate_download_entitlement parameters: - name: entitlementId in: query description: Entitlement id to download required: true style: form explode: true schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Certificate retrieved headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateBundle' '400': description: Request was malformed headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Entitlement id not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: Certificate state does not allow download headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Entitlement id not provided headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/certificates: get: tags: - Certificate summary: getCustomerCertificatesByCustomerId description: This method can be used to retrieve a list of certificates for a specified customer. operationId: getCustomerCertificatesByCustomerId parameters: - name: customerId in: path description: An identifier for a customer required: true style: simple schema: type: string - name: offset in: query description: Number of results to skip for pagination style: form explode: true schema: pattern: ^[0-9]+$ type: integer contentEncoding: int32 - name: limit in: query description: Maximum number of items to return style: form explode: true schema: pattern: ^[0-9]+$ type: integer contentEncoding: int32 - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Customer certificate information retrieved. headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateSummariesV2' '401': description: Authentication info not sent or is invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Application-specific request error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/certificates/{certificateId}: get: tags: - Certificate summary: getCertificateDetailByCertIdentifier description: Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate. operationId: getCertificateDetailByCertIdentifier parameters: - name: customerId in: path description: An identifier for a customer required: true style: simple schema: type: string - name: certificateId in: path description: Certificate id to lookup required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Certificate details retrieved headers: {} content: application/json: schema: $ref: '#/components/schemas/CertificateDetailV2' '401': description: Authentication info not sent or is invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Application-specific request error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/certificates/{certificateId}/domainVerifications: get: tags: - Certificate summary: getDomainInformationByCertificateId description: This method can be used to retrieve the domain verification status for a certificate request." operationId: getDomainInformationByCertificateId parameters: - name: customerId in: path description: An identifier for a customer required: true style: simple schema: type: string - name: certificateId in: path description: Certificate id to lookup required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Domain verification status list for specified certificateId. headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DomainVerificationSummary' description: '' contentMediaType: application/json '401': description: Authentication info not sent or is invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Application-specific request error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/certificates/{certificateId}/domainVerifications/{domain}: get: tags: - Certificate summary: getDomainDetailsByDomain description: Retrieve detailed information for supplied domain, including domain verification details and Certificate Authority Authorization (CAA) verification details. operationId: getDomainDetailsByDomain parameters: - name: customerId in: path description: An identifier for a customer required: true style: simple schema: type: string - name: certificateId in: path description: Certificate id to lookup required: true style: simple schema: type: string - name: domain in: path description: A valid domain name in the certificate request required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Retrieve detailed information for supplied domain, including domain verification details and Certificate Authority Authorization (CAA) verification details. headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainVerificationDetail' '401': description: Authentication info not sent or is invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Application-specific request error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/certificates/acme/externalAccountBinding: get: tags: - Certificate summary: getAcmeExternalAccountBinding description: Use this endpoint to retrieve a key identifier and Hash-based Message Authentication Code (HMAC) key for Automated Certificate Management Environment (ACME) External Account Binding (EAB). These credentials can be used with an ACME client that supports EAB (ex. CertBot) to automate the issuance request and deployment of DV SSL certificates operationId: getAcmeExternalAccountBinding parameters: - name: customerId in: path description: An identifier for a customer required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '200': description: Acme key identifier and HMAC key for the external account binding. Directory URI is also provided for making ACME requests. headers: {} content: application/json: schema: $ref: '#/components/schemas/ExternalAccountBinding' '401': description: Authentication info not sent or is invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: Resource not found headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: Application-specific request error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/{domain}/actions: get: tags: - Actions summary: Retrieves a list of the most recent actions for the specified domain description: Retrieves a list of the most recent actions for the specified domain operationId: Retrievesalistofthemostrecentactionsforthespecifieddomain parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: domain in: path description: Domain whose actions are to be retrieved required: true style: simple schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/Action' description: '' contentMediaType: application/json '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/{domain}/actions/{type}: delete: tags: - Actions summary: Cancel the most recent user action for the specified domain description: Cancel the most recent user action for the specified domain operationId: Cancelthemostrecentuseractionforthespecifieddomain parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: domain in: path description: Domain whose action is to be cancelled required: true style: simple schema: type: string - name: type in: path description: The type of action to cancel required: true style: simple schema: allOf: - $ref: '#/components/schemas/type20' - description: The type of action to cancel - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Request was successful headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The action status does not allow performing the operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false get: tags: - Actions summary: Retrieves the most recent action for the specified domain description: Retrieves the most recent action for the specified domain operationId: Retrievesthemostrecentactionforthespecifieddomain parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: domain in: path description: Domain whose action is to be retrieved required: true style: simple schema: type: string - name: type in: path description: The type of action to retrieve required: true style: simple schema: allOf: - $ref: '#/components/schemas/type21' - description: The type of action to retrieve responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/Action' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '409': description: The domain status does not allow performing the operation headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/notifications: get: tags: - Notifications summary: Retrieve the next domain notification description: Retrieve the next domain notification operationId: Retrievethenextdomainnotification parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/DomainNotification' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The customer does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/notifications/optIn: get: tags: - Notifications summary: Retrieve a list of notification types that are opted in description: Retrieve a list of notification types that are opted in operationId: Retrievealistofnotificationtypesthatareoptedin parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string responses: '200': description: Request was successful headers: {} content: application/json: schema: type: array items: $ref: '#/components/schemas/DomainNotification' description: '' contentMediaType: application/json '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The customer does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false put: tags: - Notifications summary: Opt in to recieve notifications for the submitted notification types description: Opt in to recieve notifications for the submitted notification types operationId: Optintorecievenotificationsforthesubmittednotificationtypes parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: types in: query description: The notification types that should be opted in required: true style: form explode: true schema: type: array items: $ref: '#/components/schemas/type22' - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Command successful headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The customer does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`type` must be specified' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/notifications/schemas/{type}: get: tags: - Notifications summary: Retrieve the schema for the notification data for the specified notification type description: Retrieve the schema for the notification data for the specified notification type operationId: Retrievetheschemaforthenotificationdataforthespecifiednotificationtype parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: type in: path description: The notification type whose schema should be retrieved required: true style: simple schema: allOf: - $ref: '#/components/schemas/type23' - description: The notification type whose schema should be retrieved responses: '200': description: Request was successful headers: {} content: application/json: schema: $ref: '#/components/schemas/JsonSchema' '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The schema type does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '422': description: '`type` must be specified' headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] /v2/customers/{customerId}/domains/notifications/{notificationId}/acknowledge: post: tags: - Notifications summary: Acknowledge a domain notification description: Acknowledge a domain notification operationId: Acknowledgeadomainnotification parameters: - name: X-Request-Id in: header description: A client provided identifier for tracking this request. style: simple schema: type: string - name: customerId in: path description: "The Customer identifier
Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherwise use your shopper id." required: true style: simple schema: type: string - name: notificationId in: path description: The notification ID to acknowledge required: true style: simple schema: type: string - name: Content-Type in: header description: '' required: true style: simple schema: const: application/json type: string responses: '204': description: Message acknowledged headers: {} content: {} '401': description: Authentication info not sent or invalid headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '403': description: Authenticated user is not allowed access headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: The domain does not exist headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' '429': description: Too many requests received within interval headers: {} content: application/json: schema: $ref: '#/components/schemas/ErrorLimit' '500': description: Internal server error headers: {} content: application/json: schema: $ref: '#/components/schemas/Error' deprecated: false parameters: [] components: schemas: AftermarketListingAction: title: AftermarketListingAction required: - listingActionId type: object properties: listingActionId: type: integer description: Action Id contentEncoding: int32 AftermarketListingExpiryCreate: title: AftermarketListingExpiryCreate required: - domain - expiresAt - losingRegistrarId type: object properties: domain: type: string description: Domain name expiresAt: type: string description: Date when the domain expires losingRegistrarId: minimum: 1 type: integer description: Losing registrar id for the domain contentEncoding: int32 pageViewsMonthly: type: integer description: Monthly traffic page view for the domain contentEncoding: int32 revenueMonthly: type: integer description: Monthly parking revenue (in USD micro unit) for the domain contentEncoding: int32 Error: title: Error required: - code type: object properties: code: type: string description: Short identifier for the error, suitable for indicating the specific error within client code fields: type: array items: $ref: '#/components/schemas/ErrorField' description: List of the specific fields, and the errors found with their contents message: type: string description: Human-readable, English description of the error ErrorField: title: ErrorField required: - code - path type: object properties: code: type: string description: Short identifier for the error, suitable for indicating the specific error within client code message: type: string description: Human-readable, English description of the problem with the contents of the field path: type: string description: >- pathRelated: type: string description: JSONPath referring to a field containing an error, which is referenced by `path` ErrorLimit: title: ErrorLimit required: - code - retryAfterSec type: object properties: code: type: string description: Short identifier for the error, suitable for indicating the specific error within client code fields: type: array items: $ref: '#/components/schemas/ErrorField' description: List of the specific fields, and the errors found with their contents message: type: string description: Human-readable, English description of the error retryAfterSec: type: integer description: Number of seconds to wait before attempting a similar request contentEncoding: int32 expiry: title: expiry type: object properties: id: type: number AbuseTicket: title: AbuseTicket required: - closed - closedAt - createdAt - domainIp - reporter - source - target - ticketId - type type: object properties: closed: type: boolean description: Is this abuse ticket closed? closedAt: type: string description: The date the abuse ticket was closed createdAt: type: string description: The date the abuse ticket was created domainIp: type: string description: The domain or IP the suspected abuse was reported against reporter: type: string description: The shopper id of the person who reported the suspected abuse source: type: string description: The single URL or IP the suspected abuse was reported against target: type: string description: The company the suspected abuse is targeting ticketId: type: string description: Abuse ticket ID type: allOf: - $ref: '#/components/schemas/Type' - description: The type of abuse being reported description: The associated fields returned, given a unique abuse ticket id AbuseTicketCreate: title: AbuseTicketCreate type: object properties: info: type: string description: 'Additional information that may assist the abuse investigator. ie: server logs or email headers/body for SPAM' infoUrl: type: string description: Reporter URL if housing additional information that may assist the abuse investigator intentional: type: boolean description: Do you believe this is intentional abuse by the domain holder? default: false proxy: type: string description: 'The Proxy information required to view the abuse being reported. ie: Specific IP used, or country of IP viewing from' source: type: string description: 'The URL or IP where live abuse content is located at. ie: https://www.example.com/bad_stuff/bad.php' target: type: string description: 'The brand/company the abuse is targeting. ie: brand name/bank name' type: allOf: - $ref: '#/components/schemas/Type1' - description: The type of abuse being reported. AbuseTicketId: title: AbuseTicketId type: object properties: u_number: type: string description: Abuse ticket ID description: The primary key of a newly created abuse ticket AbuseTicketList: title: AbuseTicketList required: - ticketIds type: object properties: pagination: $ref: '#/components/schemas/Pagination' ticketIds: type: array items: type: string description: A list of abuse ticket ids originated by this reporter. Pagination: title: Pagination type: object properties: first: type: string description: Optional link to first list of results last: type: string description: Optional link to last list of results next: type: string description: Optional link to next list of results previous: type: string description: Optional link to previous list of results total: type: integer description: Number of records available contentEncoding: int32 LegalAgreement: title: LegalAgreement required: - agreementKey - content - title type: object properties: agreementKey: type: string description: Unique identifier for the legal agreement content: type: string description: Contents of the legal agreement, suitable for embedding title: type: string description: Title of the legal agreement url: type: string description: URL to a page containing the legal agreement Certificate: title: Certificate required: - certificateId - contact - createdAt - period - productType - status type: object properties: certificateId: type: string description: The unique identifier of the certificate request. Only present if no errors returned commonName: type: string description: Common name of certificate contact: $ref: '#/components/schemas/CertificateContact' createdAt: type: string description: The date the certificate was ordered. deniedReason: type: string description: Only present if certificate order has been denied organization: $ref: '#/components/schemas/CertificateOrganization' period: type: integer description: Validity period of order. Specified in years contentEncoding: int32 productType: allOf: - $ref: '#/components/schemas/ProductType' - description: Certificate product type progress: type: integer description: Percentage of completion for certificate vetting contentEncoding: int32 revokedAt: type: string description: The revocation date of certificate (if revoked). rootType: allOf: - $ref: '#/components/schemas/RootType' - description: Root Type serialNumber: type: string description: Serial number of certificate (if issued or revoked) serialNumberHex: type: string description: Hexadecmial format for Serial number of certificate(if issued or revoked) slotSize: allOf: - $ref: '#/components/schemas/SlotSize' - description: Number of subject alternative names(SAN) to be included in certificate status: allOf: - $ref: '#/components/schemas/Status' - description: Status of certificate subjectAlternativeNames: type: array items: $ref: '#/components/schemas/SubjectAlternativeNameDetails' description: Contains subject alternative names set validEnd: type: string description: The end date of the certificate's validity (if issued or revoked). validStart: type: string description: The start date of the certificate's validity (if issued or revoked). CertificateAction: title: CertificateAction required: - createdAt - type type: object properties: createdAt: type: string description: Date action created type: $ref: '#/components/schemas/Type2' CertificateAddress: title: CertificateAddress required: - address1 - country type: object properties: address1: type: string description: Address line 1 of organization address address2: type: string description: Address line 2 of organization address city: type: string description: City/Locality of organization address country: allOf: - $ref: '#/components/schemas/Country3' - description: Two character country code of organization postalCode: type: string description: Postal code of organization address state: type: string description: Full name of State/Province/Territory of organization address CertificateBundle: title: CertificateBundle required: - pems - serialNumber type: object properties: pems: $ref: '#/components/schemas/PEMCertificates' serialNumber: type: string description: Serial number of certificate requested CertificateCallback: title: CertificateCallback required: - callbackUrl type: object properties: callbackUrl: type: string description: Callback url registered to receive stateful actions CertificateContact: title: CertificateContact required: - email - nameFirst - nameLast - phone type: object properties: email: type: string description: Email address of requestor contact jobTitle: type: string description: Only used for EVSSL. Job title of requestor contact nameFirst: type: string description: First name of requestor contact nameLast: type: string description: Last name of requestor contact nameMiddle: type: string description: Middle initial of requestor contact phone: type: string description: Phone number for requestor contact suffix: type: string description: Suffix of requestor contact CertificateCreate: title: CertificateCreate required: - contact - csr - period - productType type: object properties: callbackUrl: type: string description: Required if client would like to receive stateful actions via callback during certificate lifecyle commonName: type: string description: Name to be secured in certificate. If provided, CN field in CSR will be ignored. contact: $ref: '#/components/schemas/CertificateContact' csr: type: string description: Certificate Signing Request intelVPro: type: boolean description: Only used for OV default: false organization: $ref: '#/components/schemas/CertificateOrganizationCreate' period: type: integer description: Number of years for certificate validity period contentEncoding: int32 productType: allOf: - $ref: '#/components/schemas/ProductType1' - description: Type of product requesting a certificate. Only required non-renewal rootType: allOf: - $ref: '#/components/schemas/RootType1' - description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date slotSize: allOf: - $ref: '#/components/schemas/SlotSize' - description: Number of subject alternative names(SAN) to be included in certificate subjectAlternativeNames: uniqueItems: true type: array items: type: string description: Subject Alternative names. Collection of subjectAlternativeNames to be included in certificate. CertificateIdentifier: title: CertificateIdentifier required: - certificateId type: object properties: certificateId: type: string description: The unique identifier of the certificate request. Only present if verified. CertificateOrganization: title: CertificateOrganization required: - address - name - phone type: object properties: address: $ref: '#/components/schemas/CertificateAddress' assumedName: type: string description: Only for EVSSL. The DBA(does business as) name for the organization. jurisdictionOfIncorporation: $ref: '#/components/schemas/JurisdictionOfIncorporation' name: type: string description: Name of organization that owns common name phone: type: string description: Phone number for organization registrationAgent: type: string description: Only for EVSSL. registrationNumber: type: string description: Only for EVSSL. CertificateOrganizationCreate: title: CertificateOrganizationCreate required: - name - phone type: object properties: address: $ref: '#/components/schemas/CertificateAddress' assumedName: type: string description: Only for EVSSL. The DBA(does business as) name for the organization. name: type: string description: Name of organization that owns common name phone: type: string description: Phone number for organization registrationAgent: type: string description: Only for EVSSL. registrationNumber: type: string description: Only for EVSSL. CertificateReissue: title: CertificateReissue type: object properties: callbackUrl: type: string description: Required if client would like to receive stateful action via callback during certificate lifecyle commonName: type: string description: The common name of certificate to be secured default: Existing common name csr: type: string description: Certificate Signing Request. default: Existing CSR delayExistingRevoke: maximum: 168 type: integer description: In hours, time to delay revoking existing certificate after issuance of new certificate. If revokeExistingCertOnIssuance is enabled, this value will be ignored contentEncoding: int32 default: 72 rootType: allOf: - $ref: '#/components/schemas/RootType1' - description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date subjectAlternativeNames: uniqueItems: true type: array items: type: string description: Only used for UCC products. An array of subject alternative names to include in certificate. forceDomainRevetting: uniqueItems: true type: array items: type: string description: Optional field. Domain verification will be required for each domain listed here. Specify a value of * to indicate that all domains associated with the request should have their domain information reverified. CertificateRenew: title: CertificateRenew type: object properties: callbackUrl: type: string description: Required if client would like to receive stateful actions via callback during certificate lifecyle commonName: type: string description: The common name of certificate to be secured default: Existing common name csr: type: string description: Certificate Signing Request. default: Existing CSR period: type: integer description: Number of years for certificate validity period, if different from previous certificate contentEncoding: int32 default: 0 rootType: allOf: - $ref: '#/components/schemas/RootType1' - description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date subjectAlternativeNames: uniqueItems: true type: array items: type: string description: Only used for UCC products. An array of subject alternative names to include in certificate. Not including a subject alternative name that was in the previous certificate will remove it from the renewed certificate. CertificateRevoke: title: CertificateRevoke required: - reason type: object properties: reason: allOf: - $ref: '#/components/schemas/Reason' - description: Reason for revocation CertificateSiteSeal: title: CertificateSiteSeal required: - html type: object properties: html: type: string description: Certificate Seal HTML CertificateEmailHistory: title: CertificateEmailHistory required: - id - accountId - templateType - fromType - recipients - body - dateEntered - subject type: object properties: id: type: integer description: Email Id contentEncoding: int32 accountId: type: integer description: Shopper Id requested certificate contentEncoding: int32 templateType: type: string description: Email template type name fromType: type: string description: Email from address recipients: type: string description: Email address email was sent body: type: string description: Email message dateEntered: type: string description: Date email sent subject: type: string description: Email subject JurisdictionOfIncorporation: title: JurisdictionOfIncorporation required: - country type: object properties: city: type: string country: type: string county: type: string state: type: string PEMCertificates: title: PEMCertificates required: - certificate type: object properties: certificate: type: string description: End entity certificate in PEM format cross: type: string description: CA Cross Intermediate certificate in PEM format intermediate: type: string description: CA Signing Intermediate certificate in PEM format root: type: string description: CA Root certificate in PEM format SubjectAlternativeNameDetails: title: SubjectAlternativeNameDetails required: - status - subjectAlternativeName type: object properties: status: allOf: - $ref: '#/components/schemas/Status1' - description: Total number of page results subjectAlternativeName: type: string description: Subject alternative name to be included in certificate CertificateDetailV2: title: CertificateDetailV2 required: - certificateId - commonName - period - type - status - createdAt - contact type: object properties: certificateId: type: string description: The unique identifier of the certificate request. Only present if no errors returned commonName: type: string description: Common name of certificate period: type: integer description: Validity period of order. Specified in years contentEncoding: int32 type: allOf: - $ref: '#/components/schemas/Type3' - description: "Certificate type: \n * `DV_SSL` - (Domain Validated Secure Sockets Layer) SSL certificate validated using domain name only\n * `DV_WILDCARD_SSL` - SSL certificate containing subdomains which is validated using domain name only\n * `EV_SSL` - (Extended Validation) SSL certificate validated using organization information, domain name, business legal status, and other factors\n * `OV_CODE_SIGNING` - Code signing SSL certificate used by software developers to digitally sign apps. Validated using organization information\n * `OV_DRIVER_SIGNING` - Driver signing SSL certificate request used by software developers to digitally sign secure code for Windows hardware drivers. Validated using organization information\n * `OV_SSL` - SSL certificate validated using organization information and domain name\n * `OV_WILDCARD_SSL` - SSL certificate containing subdomains which is validated using organization information and domain name\n * `UCC_DV_SSL` - (Unified Communication Certificate) Multi domain SSL certificate validated using domain name only\n * `UCC_EV_SSL` - Multi domain SSL certificate validated using organization information, domain name, business legal status, and other factors\n * `UCC_OV_SSL` - Multi domain SSL certificate validated using organization information and domain name" status: allOf: - $ref: '#/components/schemas/Status2' - description: "Certificate status (if issued or revoked): \n * `CANCELED` - Certificate request was canceled by customer\n * `DENIED` - Certificate request was denied by customer\\n * `EXPIRED` - Issued certificate has exceeded the valid end date\n * `ISSUED` - Certificate has been issued and is within validity period\n * `PENDING_ISSUANCE` - Certificate request has completed domain verification and is in the process of being issued\n * `PENDING_REKEY` - Previously issued certificate was rekeyed by customer and is in the process of being reissued\n * `PENDING_REVOCATION` - Previously issued certificate is in the process of being revoked\n * `REVOKED` - Issued certificate has been revoked\\n * `UNUSED` - Certificate in an error state" createdAt: type: string description: The date the certificate was ordered. completedAt: type: string description: The date the certificate request completed processing. validEndAt: type: string description: The end date of the certificate's validity (if issued or revoked). validStartAt: type: string description: The start date of the certificate's validity (if issued or revoked). revokedAt: type: string description: The revocation date of certificate (if revoked). renewalAvailable: type: boolean description: Only returned when a renewal is available. serialNumber: type: string description: Serial number of certificate (if issued or revoked) serialNumberHex: type: string description: Hexadecmial format for Serial number of certificate(if issued or revoked) slotSize: allOf: - $ref: '#/components/schemas/SlotSize2' - description: "Number of subject alternative names (SAN) to be included in certificate (if UCC): \n * `FIVE` - Five slot UCC request\n * `TEN` - Ten slot UCC request\n * `FIFTEEN` - Fifteen slot UCC request\n * `TWENTY` - Twenty slot UCC request\n * `THIRTY` - Thirty slot UCC request\n * `FOURTY` - Fourty slot UCC request\n * `FIFTY` - Fifty slot UCC request\n * `ONE_HUNDRED` - One hundred slot UCC request" subjectAlternativeNames: uniqueItems: true type: array items: type: string description: Subject Alternative names. Collection of subjectAlternativeNames to be included in certificate. contact: $ref: '#/components/schemas/CertificateContact' organization: $ref: '#/components/schemas/CertificateOrganization' csr: type: string description: Certificate signing request (if present) in PEM format rootType: allOf: - $ref: '#/components/schemas/RootType4' - description: "Root type: \n * `GODADDY_SHA_1` - GoDaddy (Secure Hash Algorithm 1) SHA-1 root type\n * `GODADDY_SHA_2` - GoDaddy (Secure Hash Algorithm 2) SHA-2 root type\n * `STARFIELD_SHA_1` - Starfield SHA-1 root type\n * `STARFIELD_SHA_2` - Starfield SHA-2 root type" deniedReason: type: string description: Only present if certificate order has been denied progress: type: integer description: Percentage of completion for certificate vetting contentEncoding: int32 CertificateSummariesV2: title: CertificateSummariesV2 required: - certificates - pagination type: object properties: certificates: type: array items: $ref: '#/components/schemas/CertificateSummaryV2' description: List of certificates for a specified customer. pagination: $ref: '#/components/schemas/Pagination' CertificateSummaryV2: title: CertificateSummaryV2 required: - certificateId - commonName - period - type - status - createdAt type: object properties: certificateId: type: string description: The unique identifier of the certificate request. commonName: type: string description: Common name for the certificate request. period: type: integer description: Validity period of order. Specified in years. contentEncoding: int32 type: allOf: - $ref: '#/components/schemas/Type3' - description: "Certificate type: \n * `DV_SSL` - (Domain Validated Secure Sockets Layer) SSL certificate validated using domain name only\n * `DV_WILDCARD_SSL` - SSL certificate containing subdomains which is validated using domain name only\n * `EV_SSL` - (Extended Validation) SSL certificate validated using organization information, domain name, business legal status, and other factors\n * `OV_CODE_SIGNING` - Code signing SSL certificate used by software developers to digitally sign apps. Validated using organization information\n * `OV_DRIVER_SIGNING` - Driver signing SSL certificate request used by software developers to digitally sign secure code for Windows hardware drivers. Validated using organization information\n * `OV_SSL` - SSL certificate validated using organization information and domain name\n * `OV_WILDCARD_SSL` - SSL certificate containing subdomains which is validated using organization information and domain name\n * `UCC_DV_SSL` - (Unified Communication Certificate) Multi domain SSL certificate validated using domain name only\n * `UCC_EV_SSL` - Multi domain SSL certificate validated using organization information, domain name, business legal status, and other factors\n * `UCC_OV_SSL` - Multi domain SSL certificate validated using organization information and domain name" status: allOf: - $ref: '#/components/schemas/Status3' - description: "Certificate status (if issued or revoked): \n * `CANCELED` - Certificate request was canceled by customer\n * `DENIED` - Certificate request was denied by customer\n * `EXPIRED` - Issued certificate has exceeded the valid end date\n * `ISSUED` - Certificate has been issued and is within validity period\n * `PENDING_ISSUANCE` - Certificate request has completed domain verification and is in the process of being issued\n * `PENDING_REKEY` - Previously issued certificate was rekeyed by customer and is in the process of being reissued\n * `PENDING_REVOCATION` - Previously issued certificate is in the process of being revoked\n * `REVOKED` - Issued certificate has been revoked\n * `UNUSED` - Certificate in an error state" createdAt: type: string description: Date that the certificate request was received. completedAt: type: string description: The date the certificate request completed processing (if issued or revoked). validEndAt: type: string description: The end date of the certificate's validity (if issued or revoked). validStartAt: type: string description: The start date of the certificate's validity (if issued or revoked). revokedAt: type: string description: The revocation date of certificate (if revoked). renewalAvailable: type: boolean description: Only returned when a renewal is available. serialNumber: type: string description: Serial number of certificate (if issued or revoked). slotSize: allOf: - $ref: '#/components/schemas/SlotSize2' - description: "Number of subject alternative names (SAN) to be included in certificate (if UCC): \n * `FIVE` - Five slot UCC request\n * `TEN` - Ten slot UCC request\n * `FIFTEEN` - Fifteen slot UCC request\n * `TWENTY` - Twenty slot UCC request\n * `THIRTY` - Thirty slot UCC request\n * `FOURTY` - Fourty slot UCC request\n * `FIFTY` - Fifty slot UCC request\n * `ONE_HUNDRED` - One hundred slot UCC request" subjectAlternativeNames: uniqueItems: true type: array items: type: string description: Subject Alternative names (if UCC). Collection of subjectAlternativeNames to be included in certificate. DomainVerificationSummary: title: DomainVerificationSummary required: - domain - domainEntityId - status - createdAt - modifiedAt - type - usage type: object properties: domain: type: string description: Domain name domainEntityId: type: integer description: A unique identifier that can be leveraged for retrieving domain verification related information. Primarily used when troubleshooting a request contentEncoding: int32 dceToken: type: string description: DCE verification type token (if DCE verification type). status: allOf: - $ref: '#/components/schemas/Status4' - description: "Domain verification status: \n * `AWAITING` - Verification pending customer input\n * `INVALID` - SAN connected to a cancelled request\n * `COMPLETED` - Verification completed\n * `FAILED_VERIFICATION` - Verification failed\n * `PENDING_POSSIBLE_FRAUD` - Flagged for a system level fraud review\n * `VERIFIED_POSSIBLE_FRAUD` - Fraud detection reviewed but verified\n * `DROPPED` - SAN dropped from request\n * `REVOKED_CERT` - Certificate revoked\n * `DROPPED_GOOGLE_SAFE_BROWSING` - SAN dropped from request due to Google Safe Browsing check\n * `DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION` - SAN dropped from request due to Certificate Authorization Authority DNS record check" createdAt: type: string description: Timestamp indicating when the domain verification process was started modifiedAt: type: string description: Timestamp indicating when the domain verification process was last updated type: allOf: - $ref: '#/components/schemas/Type5' - description: "Domain verification type: \n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN` - Domain verified using domain control verification email sent to admin@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR` - Domain verified using domain control verification email sent to administrator@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER` - Domain verified using domain control verification email sent to hostmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER` - Domain verified using domain control verification email sent to postmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER` - Domain verified using domain control verification email sent to webmaster@\n * `DOMAIN_ACCESS_EMAIL` - Domain verified using a domain access email\n * `DOMAIN_ACCESS_LETTER` - Customer completed a domain access letter which was used for domain verification\n * `DOMAIN_CONTROL_EMAIL` - Domain verified using HTML file or DNS zone file text value\n * `DOMAIN_ZONE_CONTROL` - DNS zone file containing a pre-generated text value used for domain verification\n * `MANUAL_DOMAIN_ACCESS_EMAIL` - DAE sent to an email address manually entered by a rep\n * `PREVIOUS_DOMAIN_ACCESS_EMAIL` - Customers domain access email for a prior certificate request was used for domain verification\n * `REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER` - Representative reviewed a customer provided domain access letter and verified domain\n * `REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL` - Representative verified domain using a manual domain zone control check\n * `REGISTRATION_AUTHORITY_OVERRIDE` - Representative verified domain using alternative methods\n * `REGISTRATION_AUTHORITY_WEBSITE_CONTROL` - Representative verified domain using a manual website control check\n * `CUSTOMER_OWNED` - Validated customer account information used for domain control verification\n * `WEBSITE_CONTROL` - HTML file in root website directory containing pre-generated value used for domain control verification" usage: allOf: - $ref: '#/components/schemas/Usage' - description: Type of domain name used for domain verification ExternalAccountBinding: title: ExternalAccountBinding required: - directoryUrl - keyId - hmacKey type: object properties: directoryUrl: type: string description: ACME directory resource URL. keyId: type: string description: EAB key identifier for the ACME account. hmacKey: type: string description: EAB HMAC key for the ACME account DomainVerificationDetail: title: DomainVerificationDetail required: - domain - domainEntityId - status - createdAt - modifiedAt - type - usage type: object properties: domain: type: string description: Domain name domainEntityId: type: integer description: A unique identifier that can be leveraged for retrieving domain verification related information. Primarily used when troubleshooting a request contentEncoding: int32 dceToken: type: string description: DCE verification type token (if DCE verification type). status: allOf: - $ref: '#/components/schemas/Status4' - description: "Domain verification status: \n * `AWAITING` - Verification pending customer input\n * `INVALID` - SAN connected to a cancelled request\n * `COMPLETED` - Verification completed\n * `FAILED_VERIFICATION` - Verification failed\n * `PENDING_POSSIBLE_FRAUD` - Flagged for a system level fraud review\n * `VERIFIED_POSSIBLE_FRAUD` - Fraud detection reviewed but verified\n * `DROPPED` - SAN dropped from request\n * `REVOKED_CERT` - Certificate revoked\n * `DROPPED_GOOGLE_SAFE_BROWSING` - SAN dropped from request due to Google Safe Browsing check\n * `DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION` - SAN dropped from request due to Certificate Authorization Authority DNS record check" createdAt: type: string description: Timestamp indicating when the domain verification process was started modifiedAt: type: string description: Timestamp indicating when the domain verification process was last updated type: allOf: - $ref: '#/components/schemas/Type5' - description: "Domain verification type: \n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN` - Domain verified using domain control verification email sent to admin@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR` - Domain verified using domain control verification email sent to administrator@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER` - Domain verified using domain control verification email sent to hostmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER` - Domain verified using domain control verification email sent to postmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER` - Domain verified using domain control verification email sent to webmaster@\n * `DOMAIN_ACCESS_EMAIL` - Domain verified using a domain access email\n * `DOMAIN_ACCESS_LETTER` - Customer completed a domain access letter which was used for domain verification\n * `DOMAIN_CONTROL_EMAIL` - Domain verified using HTML file or DNS zone file text value\n * `DOMAIN_ZONE_CONTROL` - DNS zone file containing a pre-generated text value used for domain verification\n * `MANUAL_DOMAIN_ACCESS_EMAIL` - DAE sent to an email address manually entered by a rep\n * `PREVIOUS_DOMAIN_ACCESS_EMAIL` - Customers domain access email for a prior certificate request was used for domain verification\n * `REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER` - Representative reviewed a customer provided domain access letter and verified domain\n * `REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL` - Representative verified domain using a manual domain zone control check\n * `REGISTRATION_AUTHORITY_OVERRIDE` - Representative verified domain using alternative methods\n * `REGISTRATION_AUTHORITY_WEBSITE_CONTROL` - Representative verified domain using a manual website control check\n * `CUSTOMER_OWNED` - Validated customer account information used for domain control verification\n * `WEBSITE_CONTROL` - HTML file in root website directory containing pre-generated value used for domain control verification" usage: allOf: - $ref: '#/components/schemas/Usage' - description: Type of domain name used for domain verification certificateAuthorityAuthorization: allOf: - $ref: '#/components/schemas/CertificateAuthorityAuthorization' - description: >- Contains information about the last Certificate Authority Authorization (CAA) Lookup details for the specified domain. In order for a domain to be eligible to be included in the certificate, the entire domain hierarchy must be scanned for DNS CAA records, as outlined by RFC 6844. The absence of any CAA records found in the domain hierarchy indicates that the domain may be included in the certificate. Alternatively, if CAA records are found when scanning the domain hierarchy, the domain may be included in the certificate as long as `godaddy.com` or `starfieldtech.com` is found in the DNS record value. However, if CAA records are found, yet `godaddy.com` or `starfieldtech.com` is not found in any CAA record's value, then we must drop the domain from the certificate request. In the case where there are repeated DNS errors when scanning the domain hierarchy for CAA records, thus ending in an unsuccessful scan, then the domain can still be included in the certificate provided the primary domain is not setup with DNSSEC. Conversely, if DNSSEC is found to be setup on the primary domain when scanning following repeated CAA failures, the domain must be dropped from the certificate request. Finally, if DNS errors persist to the point where a successful DNSSEC query could not be obtained, then the domain must be dropped from the certificate request. Country: title: Country type: object properties: callingCode: type: string description: The calling code prefix used for phone numbers in this country countryKey: type: string description: The ISO country-code label: type: string description: The localized name of the country states: type: array items: $ref: '#/components/schemas/State' description: List of states/provinces in this country CountrySummary: title: CountrySummary type: object properties: callingCode: type: string description: The calling code prefix used for phone numbers in this country countryKey: type: string description: The ISO country-code label: type: string description: The localized name of the country State: title: State type: object properties: label: type: string description: The localized name of the state, province, or territory stateKey: type: string description: The state code Action: title: Action required: - type - origination - createdAt - status type: object properties: type: allOf: - $ref: '#/components/schemas/Type6' - description: "The type of action being performed
  • AUTH_CODE_PURCHASE - Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode.
  • AUTH_CODE_REGENERATE - Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode
  • AUTO_RENEWAL - A Domain Auto Renew is in progress.
  • BACKORDER_PURCHASE - Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase.
  • BACKORDER_DELETE - Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}.
  • BACKORDER_UPDATE - Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}.
  • CONTACT_CREATE - Request to create a contact via POST /v2/customers/{customerId}/domains/contacts.
  • CONTACT_DELETE - Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId}
  • CONTACT_UPDATE - Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId}
  • DNS_VERIFICATION - Domain requires zone file setup.
  • DNSSEC_CREATE - Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
  • DNSSEC_DELETE - Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
  • DOMAIN_DELETE - Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain}
  • DOMAIN_UPDATE - Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain}
  • DOMAIN_UPDATE_CONTACTS -Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts
  • DOMAIN_UPDATE_NAME_SERVERS - Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers
  • EXPIRY - A Domain Expiration is in progress.
  • HOST_CREATE - Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
  • HOST_DELETE - Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
  • ICANN_VERIFICATION - Domain requires registrant verification for Icann.
  • PREMIUM - Premium Domain domain sale is in progress.
  • PRIVACY_PURCHASE - Request to purchase privacy for a domain via POST /v2/customers/{customerId}/domains/{domain}/privacy/purchase
  • PRIVACY_DELETE - Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy
  • REDEEM - Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem
  • REGISTER - Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register
  • RENEW - Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew
  • RENEW_UNDO - Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew
  • TRADE - A domain trade request is in progress
  • TRADE_CANCEL - Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel
  • TRADE_PURCHASE - Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase
  • TRADE_PURCHASE_AUTH_TEXT_MESSAGE - Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage
  • TRADE_RESEND_AUTH_EMAIL - Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail
  • TRANSFER - Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer
  • TRANSFER_IN - A domain transfer in request is in progress.
  • TRANSFER_IN_CANCEL - Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel
  • TRANSFER_OUT - A domain transfer out request is in progress.
  • TRANSFER_OUT_ACCEPT - Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept
  • TRANSFER_OUT_REJECT - Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject
  • TRANSFER_OUT_REQUESTED - Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut
  • TRANSIT - Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit
" origination: allOf: - $ref: '#/components/schemas/Origination' - description: "The origination of the action
  • USER - These are user requests.
  • SYSTEM - These are system processing actions.
" createdAt: type: string description: Timestamp indicating when the action was created startedAt: type: string description: Timestamp indicating when the action was started completedAt: type: string description: Timestamp indicating when the action was completed modifiedAt: type: string description: Timestamp indicating when the action was last modified status: allOf: - $ref: '#/components/schemas/Status6' - description: "The current status of the action
  • ACCEPTED - The action has been queued, processing has not started.
  • AWAITING - The action is waiting on a user input.
  • CANCELLED - The action has been cancelled by the user.
  • FAILED - An error occurred while the action was processing, no more processing will be performed.
  • PENDING - The action is being processed.
  • SUCCESS - The action has completed, no additional processing is required.
" reason: $ref: '#/components/schemas/ActionReason' requestId: type: string description: A client provided identifier (via X-Request-Id header) used for tracking individual requests ActionReason: title: ActionReason required: - code type: object properties: code: pattern: ^[A-Z_][A-Z0-9_]*$ type: string description: Short identifier, suitable for indicating the reason for the current status and how to handle within client code message: type: string description: Human-readable, English description of the code fields: type: array items: $ref: '#/components/schemas/ErrorField' description: List of the specific fields, and the errors found with their contents Address: title: Address required: - address1 - city - country - postalCode - state type: object properties: address1: type: string address2: type: string city: type: string country: allOf: - $ref: '#/components/schemas/Country2' - description: >- Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more postalCode: type: string description: Postal or zip code state: type: string description: State or province or territory DNSRecord: title: DNSRecord required: - data - name - type type: object properties: data: type: string name: type: string port: maximum: 65535 minimum: 1 type: integer description: Service port (SRV only) contentEncoding: int32 priority: type: integer description: Record priority (MX and SRV only) contentEncoding: int32 protocol: type: string description: Service protocol (SRV only) service: type: string description: Service type (SRV only) ttl: type: integer contentEncoding: int32 type: $ref: '#/components/schemas/Type7' weight: type: integer description: Record weight (SRV only) contentEncoding: int32 Consent: title: Consent required: - agreedAt - agreedBy - agreementKeys type: object properties: agreedAt: type: string description: Timestamp indicating when the end-user consented to these legal agreements agreedBy: type: string description: Originating client IP address of the end-user's computer when they consented to these legal agreements agreementKeys: type: array items: type: string description: Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint ConsentRedemption: title: ConsentRedemption required: - price - fee - currency - agreedBy - agreedAt type: object properties: price: type: integer description: Price for the domain renewal (if domain renewal required for redemption). Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the redemption price and currency for the domain contentEncoding: int32 fee: type: integer description: Fee charged for the domain redemption. Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the redemption fee and currency for the domain contentEncoding: int32 currency: pattern: ^[A-Z][A-Z][A-Z]$ type: string description: Currency in which the `price` and `fee` are listed agreedBy: type: string description: Originating client IP address of the end-user's computer when they consented to these legal agreements agreedAt: type: string description: Timestamp indicating when the end-user consented to these legal agreements ConsentDomainUpdate: title: ConsentDomainUpdate required: - agreedAt - agreedBy - agreementKeys type: object properties: agreedAt: type: string description: Timestamp indicating when the end-user consented to these agreements agreedBy: type: string description: Originating client IP address of the end-user's computer when they consented to the agreements agreementKeys: type: array items: $ref: '#/components/schemas/AgreementKey' description: "Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated
  • EXPOSE_WHOIS - Required when the exposeWhois field is updated to true
" Contact: title: Contact required: - addressMailing - email - nameFirst - nameLast - phone type: object properties: addressMailing: $ref: '#/components/schemas/Address' email: type: string fax: type: string jobTitle: type: string nameFirst: type: string nameLast: type: string nameMiddle: type: string organization: type: string phone: type: string ContactDomain: title: ContactDomain required: - nameFirst - nameLast - email - phone - addressMailing - exposeWhois type: object properties: contactId: type: string description: Unique identifier for this Contact encoding: allOf: - $ref: '#/components/schemas/Encoding' - description: "The encoding of the contact data
  • ASCII - Data contains only ASCII characters that are not region or language specific
  • UTF-8 - Data contains characters that are specific to a region or language
" nameFirst: maxLength: 30 type: string nameMiddle: type: string nameLast: maxLength: 30 type: string organization: maxLength: 100 type: string jobTitle: type: string email: maxLength: 80 type: string phone: maxLength: 17 type: string fax: maxLength: 17 type: string addressMailing: $ref: '#/components/schemas/Address' exposeWhois: type: boolean description: Whether or not the contact details should be shown in the WHOIS metadata: type: object description: The contact eligibility data fields as specified by GET /v2/customers/{customerId}/domains/contacts/schema/{tld} tlds: type: array items: type: string description: The tlds that this contact can be assigned to _createdAt: type: string description: Timestamp indicating when the contact was created _modifiedAt: type: string description: Timestamp indicating when the contact was last modified _deleted: type: boolean description: Flag indicating if the contact has been logically deleted in the system _revision: type: integer description: The current revision number of the contact. contentEncoding: int32 DNSRecordCreateType: title: DNSRecordCreateType required: - data - name type: object properties: data: type: string name: type: string port: maximum: 65535 minimum: 1 type: integer description: Service port (SRV only) contentEncoding: int32 priority: type: integer description: Record priority (MX and SRV only) contentEncoding: int32 protocol: type: string description: Service protocol (SRV only) service: type: string description: Service type (SRV only) ttl: type: integer contentEncoding: int32 weight: type: integer description: Record weight (SRV only) contentEncoding: int32 DNSRecordCreateTypeName: title: DNSRecordCreateTypeName required: - data type: object properties: data: type: string port: maximum: 65535 minimum: 1 type: integer description: Service port (SRV only) contentEncoding: int32 priority: type: integer description: Record priority (MX and SRV only) contentEncoding: int32 protocol: type: string description: Service protocol (SRV only) service: type: string description: Service type (SRV only) ttl: type: integer contentEncoding: int32 weight: type: integer description: Record weight (SRV only) contentEncoding: int32 DomainAvailableBulk: title: DomainAvailableBulk required: - domains type: object properties: domains: type: array items: $ref: '#/components/schemas/DomainAvailableResponse' description: Domain available response array DomainAvailableBulkMixed: title: DomainAvailableBulkMixed required: - domains type: object properties: domains: type: array items: $ref: '#/components/schemas/DomainAvailableResponse' description: Domain available response array errors: type: array items: $ref: '#/components/schemas/DomainAvailableError' description: Errors encountered while performing a domain available check DomainAvailableError: title: DomainAvailableError required: - code - domain - path - status type: object properties: code: type: string description: Short identifier for the error, suitable for indicating the specific error within client code domain: type: string description: Domain name message: type: string description: Human-readable, English description of the error path: type: string description: >-
  • JSONPath referring to a field containing an error
    • OR
  • JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`
status: type: integer description: HTTP status code that would return for a single check contentEncoding: int32 DomainAvailableResponse: title: DomainAvailableResponse required: - available - definitive - domain type: object properties: available: type: boolean description: Whether or not the domain name is available currency: type: string description: Currency in which the `price` is listed. Only returned if tld is offered default: USD definitive: type: boolean description: Whether or not the `available` answer has been definitively verified with the registry domain: type: string description: Domain name period: type: integer description: Number of years included in the price. Only returned if tld is offered contentEncoding: int32 price: type: integer description: Price of the domain excluding taxes or fees. Only returned if tld is offered contentEncoding: int32 DomainContacts: title: DomainContacts required: - contactRegistrant type: object properties: contactAdmin: $ref: '#/components/schemas/Contact' contactBilling: $ref: '#/components/schemas/Contact' contactRegistrant: $ref: '#/components/schemas/Contact' contactTech: $ref: '#/components/schemas/Contact' DomainContactsV2: title: DomainContactsV2 type: object properties: registrant: $ref: '#/components/schemas/ContactDomain' admin: $ref: '#/components/schemas/ContactDomain' tech: $ref: '#/components/schemas/ContactDomain' billing: $ref: '#/components/schemas/ContactDomain' DomainDetail: title: DomainDetail required: - authCode - contactAdmin - contactBilling - contactRegistrant - contactTech - createdAt - domain - domainId - expirationProtected - holdRegistrar - locked - nameServers - privacy - renewAuto - renewDeadline - status - transferProtected type: object properties: authCode: type: string description: Authorization code for transferring the Domain contactAdmin: $ref: '#/components/schemas/Contact' contactBilling: $ref: '#/components/schemas/Contact' contactRegistrant: $ref: '#/components/schemas/Contact' contactTech: $ref: '#/components/schemas/Contact' createdAt: type: string description: Date and time when this domain was created contentEncoding: date-time deletedAt: type: string description: Date and time when this domain was deleted contentEncoding: date-time transferAwayEligibleAt: type: string description: Date and time when this domain is eligible to transfer contentEncoding: date-time domain: type: string description: Name of the domain domainId: type: number description: Unique identifier for this Domain expirationProtected: type: boolean description: Whether or not the domain is protected from expiration expires: type: string description: Date and time when this domain will expire contentEncoding: date-time exposeWhois: type: boolean description: Whether or not the domain contact details should be shown in the WHOIS holdRegistrar: type: boolean description: Whether or not the domain is on-hold by the registrar locked: type: boolean description: Whether or not the domain is locked to prevent transfers nameServers: type: array items: type: string description: Fully-qualified domain names for DNS servers privacy: type: boolean description: Whether or not the domain has privacy protection registrarCreatedAt: type: string description: Date and time when this domain was created by the registrar renewAuto: type: boolean description: Whether or not the domain is configured to automatically renew renewDeadline: type: string description: Date the domain must renew on contentEncoding: date-time status: type: string description: >- Processing status of the domain
  • ACTIVE - All is well
  • AWAITING* - System is waiting for the end-user to complete an action
  • CANCELLED* - Domain has been cancelled, and may or may not be reclaimable
  • CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud
  • DISABLED* - Domain has been disabled
  • EXCLUDED* - Domain has been excluded from Firehose registration
  • EXPIRED* - Domain has expired
  • FAILED* - Domain has failed a required action, and the system is no longer retrying
  • HELD* - Domain has been placed on hold, and likely requires intervention from Support
  • LOCKED* - Domain has been locked, and likely requires intervention from Support
  • PARKED* - Domain has been parked, and likely requires intervention from Support
  • PENDING* - Domain is working its way through an automated workflow
  • RESERVED* - Domain is reserved, and likely requires intervention from Support
  • REVERTED - Domain has been reverted, and likely requires intervention from Support
  • SUSPENDED* - Domain has been suspended, and likely requires intervention from Support
  • TRANSFERRED* - Domain has been transferred out
  • UNKNOWN - Domain is in an unknown state
  • UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support
  • UNPARKED* - Domain has been unparked, and likely requires intervention from Support
  • UPDATED* - Domain ownership has been transferred to another account
subaccountId: type: string description: Reseller subaccount shopperid who can manage the domain transferProtected: type: boolean description: Whether or not the domain is protected from transfer verifications: $ref: '#/components/schemas/VerificationsDomain' DomainDetailV2: title: DomainDetailV2 required: - domainId - domain - status - expirationProtected - holdRegistrar - locked - privacy - renewAuto - renewDeadline - transferProtected - createdAt - authCode - nameServers - contacts type: object properties: domainId: type: string description: Unique identifier for this Domain domain: type: string description: Name of the domain subaccountId: type: string description: Reseller subaccount shopperid who can manage the domain status: allOf: - $ref: '#/components/schemas/Status9' - description: "The current status of the domain
  • ACTIVE - Domain has been registered and is active.
  • CANCELLED - Domain has been cancelled by the user or system, and is not be reclaimable.
  • DELETED_REDEEMABLE - Domain is deleted but is redeemable.
  • EXPIRED - Domain has expired.
  • FAILED - Domain registration or transfer error.
  • LOCKED_REGISTRAR - Domain is locked at the registrar - this is usually the result of a spam, abuse, etc.
  • PARKED - Domain has been parked.
  • HELD_REGISTRAR - Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute.
  • OWNERSHIP_CHANGED - Domain has been moved to another account.
  • PENDING_TRANSFER - Domain transfer has been requested and is pending the transfer process.
  • PENDING_REGISTRATION - Domain is pending setup at the registry.
  • REPOSSESSED - Domain has been confiscated - this is usually the result of a chargeback, fraud, abuse, etc.).
  • SUSPENDED - Domain is in violation and has been suspended.
  • TRANSFERRED - Domain has been transferred to another registrar.
" expiresAt: type: string description: Date and time when this domain will expire expirationProtected: type: boolean description: Whether or not the domain is protected from expiration holdRegistrar: type: boolean description: Whether or not the domain is on-hold by the registrar locked: type: boolean description: Whether or not the domain is locked to prevent transfers privacy: type: boolean description: Whether or not the domain has privacy protection registrarCreatedAt: type: string description: Date and time when this domain was created by the registrar renewAuto: type: boolean description: Whether or not the domain is configured to automatically renew renewDeadline: type: string description: Date the domain must renew on transferProtected: type: boolean description: Whether or not the domain is protected from transfer createdAt: type: string description: Date and time when this domain was created deletedAt: type: string description: Date and time when this domain was deleted modifiedAt: type: string description: Date and time when this domain was last modified transferAwayEligibleAt: type: string description: Date and time when this domain is eligible to transfer authCode: type: string description: Authorization code for transferring the Domain nameServers: type: array items: type: string description: Fully-qualified domain names for DNS servers hostnames: type: array items: type: string description: Hostnames owned by the domain renewal: $ref: '#/components/schemas/RenewalDetails' verifications: $ref: '#/components/schemas/VerificationsDomainV2' contacts: $ref: '#/components/schemas/DomainContactsV2' actions: type: array items: $ref: '#/components/schemas/Action' description: List of current actions in progress for this domain dnssecRecords: type: array items: $ref: '#/components/schemas/DomainDnssec' description: List of active DNSSEC records for this domain registryStatusCodes: type: array items: $ref: '#/components/schemas/RegistryStatusCode' description: "The current registry status codes of the domain
  • ADD_PERIOD - This grace period is provided after the initial registration of a domain name.
  • AUTO_RENEW_PERIOD - This grace period is provided after a domain name registration period expires and is extended (renewed) automatically by the registry.
  • CLIENT_DELETE_PROHIBITED - This status code tells your domain's registry to reject requests to delete the domain.
  • CLIENT_HOLD - This status code tells your domain's registry to not activate your domain in the DNS and as a consequence, it will not resolve.
  • CLIENT_RENEW_PROHIBITED - This status code tells your domain's registry to reject requests to renew your domain.
  • CLIENT_TRANSFER_PROHIBITED - This status code tells your domain's registry to reject requests to transfer the domain from your current registrar to another.
  • CLIENT_UPDATE_PROHIBITED - This status code tells your domain's registry to reject requests to update the domain.
  • INACTIVE - This status code indicates that delegation information (name servers) has not been associated with your domain.
  • OK - This is the standard status for a domain, meaning it has no pending operations or prohibitions.
  • PENDING_CREATE - This status code indicates that a request to create your domain has been received and is being processed.
  • PENDING_DELETE - This status code indicates that the domain is either in a redemption period if combined with either REDEMPTION_PERIOD or PENDING_RESTORE, if not combined with these, then indicates that the redemption period for the domain has ended and domain will be be purged and dropped from the registry database.
  • PENDING_RENEW - This status code indicates that a request to renew your domain has been received and is being processed.
  • PENDING_RESTORE - This status code indicates that your registrar has asked the registry to restore your domain that was in REDEMPTION_PERIOD status
  • PENDING_TRANSFER - This status code indicates that a request to transfer your domain to a new registrar has been received and is being processed.
  • PENDING_UPDATE - This status code indicates that a request to update your domain has been received and is being processed.
  • REDEMPTION_PERIOD - This status code indicates that your registrar has asked the registry to delete your domain.
  • RENEW_PERIOD - This grace period is provided after a domain name registration period is explicitly extended (renewed) by the registrar.
  • SERVER_DELETE_PROHIBITED - This status code prevents your domain from being deleted.
  • SERVER_HOLD - This status code is set by your domain's Registry Operator. Your domain is not activated in the DNS.
  • SERVER_RENEW_PROHIBITED - This status code indicates your domain's Registry Operator will not allow your registrar to renew your domain.
  • SERVER_TRANSFER_PROHIBITED - This status code prevents your domain from being transferred from your current registrar to another.
  • SERVER_UPDATE_PROHIBITED - This status code locks your domain preventing it from being updated.
  • TRANSFER_PERIOD - This grace period is provided after the successful transfer of a domain name from one registrar to another.
" DomainDnssec: title: DomainDnssec required: - algorithm type: object properties: algorithm: allOf: - $ref: '#/components/schemas/Algorithm' - description: "This identifies the cryptographic algorithm used to generate the signature
  • RSAMD5 - [01] DRSA/MD5
  • DSA - [03] DSA/SHA1
  • RSASHA1 - [05] RSA/SHA-1
  • DSA_NSEC3_SHA1 - [06] DSA-NSEC3-SHA1
  • RSASHA1_NSEC3_SHA1 - [07] RSASHA1-NSEC3-SHA1
  • RSASHA256 - [08] RSA/SHA-256
  • RSASHA512 - [10] RSA/SHA-512
  • ECC_GOST - [12] GOST R 34.10-2001
  • ECDSAP256SHA256 - [13] ECDSA Curve P-256 with SHA-256
  • ECDSAP384SHA384 - [14] ECDSA Curve P-384 with SHA-384
  • ED25519 - [15] Ed25519
  • ED448 - [16] Ed448
" keyTag: maximum: 65536 type: integer description: This is an integer value less than 65536 used to identify the DNSSEC record for the domain name. contentEncoding: int32 digestType: allOf: - $ref: '#/components/schemas/DigestType' - description: "This identifies the algorithm used to construct the digest
  • SHA1 - [01] SHA-1
  • SHA256 - [02] SHA-256
  • GOST - [03] GOST R 34.11-94
  • SHA384 - [04] SHA-384
" digest: type: string description: The digest is an alpha-numeric value flags: allOf: - $ref: '#/components/schemas/Flags' - description: "This identifies the key type; either a Zone-Signing Key or a Key-Signing Key
  • ZSK - [256] Zone-Signing Key
  • KSK - [257] Key-Signing Key
" publicKey: type: string description: Registries use this value to encrypt DS records. Decryption requires a matching public key maxSignatureLife: type: integer description: This specifies the validity period for the signature. The value is expressed in seconds. You can use any integer value larger than zero contentEncoding: int32 DomainNotification: title: DomainNotification required: - notificationId - type - resource - resourceType - status - addedAt type: object properties: notificationId: type: string description: The notification ID to be used in POST /v2/customers/{customerId}/domains/notifications to acknowledge the notification type: allOf: - $ref: '#/components/schemas/Type8' - description: The type of action the notification relates to resource: type: string description: The resource the notification pertains to. resourceType: allOf: - $ref: '#/components/schemas/ResourceType' - description: The type of resource the notification relates to status: allOf: - $ref: '#/components/schemas/Status10' - description: The resulting status of the action. addedAt: type: string description: The date the notification was added requestId: type: string description: A client provided identifier (via X-Request-Id header) indicating the request this notification is for metadata: type: object description: The notification data for the given type as specifed by GET /v2/customers/{customerId}/domains/notifications/schema DomainNotificationType: title: DomainNotificationType required: - type type: object properties: type: allOf: - $ref: '#/components/schemas/Type9' - description: The notification type DomainPurchase: title: DomainPurchase required: - consent - domain type: object properties: consent: $ref: '#/components/schemas/Consent' contactAdmin: $ref: '#/components/schemas/Contact' contactBilling: $ref: '#/components/schemas/Contact' contactRegistrant: $ref: '#/components/schemas/Contact' contactTech: $ref: '#/components/schemas/Contact' domain: type: string description: For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked nameServers: type: array items: type: string description: '' period: maximum: 10 minimum: 1 type: integer contentEncoding: int32 default: 1 privacy: type: boolean default: false renewAuto: type: boolean default: true DomainPurchaseResponse: title: DomainPurchaseResponse required: - itemCount - orderId - total type: object properties: currency: type: string description: Currency in which the `total` is listed default: USD itemCount: type: integer description: Number items included in the order contentEncoding: int32 orderId: type: integer description: Unique identifier of the order processed to purchase the domain contentEncoding: int64 total: type: integer description: Total cost of the domain and any selected add-ons contentEncoding: int32 DomainRenew: title: DomainRenew type: object properties: period: maximum: 10 minimum: 1 type: integer description: Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase contentEncoding: int32 DomainSuggestion: title: DomainSuggestion required: - domain type: object properties: domain: type: string description: Suggested domain name DomainSummary: title: DomainSummary required: - contactRegistrant - createdAt - domain - domainId - expirationProtected - holdRegistrar - locked - privacy - renewAuto - renewDeadline - status - transferProtected type: object properties: authCode: type: string description: Authorization code for transferring the Domain contactAdmin: $ref: '#/components/schemas/Contact' contactBilling: $ref: '#/components/schemas/Contact' contactRegistrant: $ref: '#/components/schemas/Contact' contactTech: $ref: '#/components/schemas/Contact' createdAt: type: string description: Date and time when this domain was created contentEncoding: date-time deletedAt: type: string description: Date and time when this domain was deleted contentEncoding: date-time transferAwayEligibleAt: type: string description: Date and time when this domain is eligible to transfer contentEncoding: date-time domain: type: string description: Name of the domain domainId: type: number description: Unique identifier for this Domain expirationProtected: type: boolean description: Whether or not the domain is protected from expiration expires: type: string description: Date and time when this domain will expire contentEncoding: date-time exposeWhois: type: boolean description: Whether or not the domain contact details should be shown in the WHOIS holdRegistrar: type: boolean description: Whether or not the domain is on-hold by the registrar locked: type: boolean description: Whether or not the domain is locked to prevent transfers nameServers: type: array items: type: string description: Fully-qualified domain names for DNS servers privacy: type: boolean description: Whether or not the domain has privacy protection registrarCreatedAt: type: string description: Date and time when this domain was created by the registrar renewAuto: type: boolean description: Whether or not the domain is configured to automatically renew renewDeadline: type: string description: Date the domain must renew on contentEncoding: date-time renewable: type: boolean description: Whether or not the domain is eligble for renewal based on status status: type: string description: >- Processing status of the domain
  • ACTIVE - All is well
  • AWAITING* - System is waiting for the end-user to complete an action
  • CANCELLED* - Domain has been cancelled, and may or may not be reclaimable
  • CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud
  • DISABLED* - Domain has been disabled
  • EXCLUDED* - Domain has been excluded from Firehose registration
  • EXPIRED* - Domain has expired
  • FAILED* - Domain has failed a required action, and the system is no longer retrying
  • HELD* - Domain has been placed on hold, and likely requires intervention from Support
  • LOCKED* - Domain has been locked, and likely requires intervention from Support
  • PARKED* - Domain has been parked, and likely requires intervention from Support
  • PENDING* - Domain is working its way through an automated workflow
  • RESERVED* - Domain is reserved, and likely requires intervention from Support
  • REVERTED - Domain has been reverted, and likely requires intervention from Support
  • SUSPENDED* - Domain has been suspended, and likely requires intervention from Support
  • TRANSFERRED* - Domain has been transferred out
  • UNKNOWN - Domain is in an unknown state
  • UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support
  • UNPARKED* - Domain has been unparked, and likely requires intervention from Support
  • UPDATED* - Domain ownership has been transferred to another account
transferProtected: type: boolean description: Whether or not the domain is protected from transfer DomainForwardingMask: title: DomainForwardingMask type: object properties: title: type: string description: Displays at the top of the browser window and in search results. description: type: string description: A short description of your website to display in search engine results. keywords: type: string description: A list of comma-separated keywords that describes the content and purpose of your website. DomainForwardingCreate: title: DomainForwardingCreate required: - type - url type: object properties: type: allOf: - $ref: '#/components/schemas/Type10' - description: "The type of fowarding to implement
  • MASKED - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
  • REDIRECT_PERMANENT* - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.
  • REDIRECT_TEMPORARY - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.
" url: type: string description: Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/) mask: $ref: '#/components/schemas/DomainForwardingMask' DomainForwarding: title: DomainForwarding required: - fqdn - type - url type: object properties: fqdn: type: string description: The fqdn (domain or sub domain) to forward (ex somedomain.com or sub.somedomain.com) type: allOf: - $ref: '#/components/schemas/Type10' - description: "The type of fowarding to implement
  • MASKED - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
  • REDIRECT_PERMANENT* - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.
  • REDIRECT_TEMPORARY - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.
" url: type: string description: Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/) mask: $ref: '#/components/schemas/DomainForwardingMask' DomainRedeemV2: title: DomainRedeemV2 required: - consent type: object properties: consent: $ref: '#/components/schemas/ConsentRedemption' DomainTransferIn: title: DomainTransferIn required: - authCode - consent type: object properties: authCode: type: string description: Authorization code from registrar for transferring a domain consent: $ref: '#/components/schemas/Consent' period: maximum: 10 minimum: 1 type: integer description: Can be more than 1 but no more than 10 years total including current registration length contentEncoding: int32 default: 1 privacy: type: boolean description: Whether or not privacy has been requested default: false renewAuto: type: boolean description: Whether or not the domain should be configured to automatically renew default: true contactAdmin: $ref: '#/components/schemas/Contact' contactBilling: $ref: '#/components/schemas/Contact' contactRegistrant: $ref: '#/components/schemas/Contact' contactTech: $ref: '#/components/schemas/Contact' DomainUpdate: title: DomainUpdate type: object properties: locked: type: boolean description: Whether or not the domain should be locked to prevent transfers nameServers: type: array items: {} description: Fully-qualified domain names for Name Servers to associate with the domain renewAuto: type: boolean description: Whether or not the domain should be configured to automatically renew subaccountId: type: string description: Reseller subaccount shopperid who can manage the domain exposeWhois: type: boolean description: Whether or not the domain contact details should be shown in the WHOIS consent: $ref: '#/components/schemas/ConsentDomainUpdate' DomainsContactsBulk: title: DomainsContactsBulk required: - domains type: object properties: contactAdmin: $ref: '#/components/schemas/Contact' contactBilling: $ref: '#/components/schemas/Contact' contactPresence: $ref: '#/components/schemas/Contact' contactRegistrant: $ref: '#/components/schemas/Contact' contactTech: $ref: '#/components/schemas/Contact' domains: type: array items: type: string description: An array of domain names to be validated against. Alternatively, you can specify the extracted tlds. However, full domain names are required if the tld is `uk` entityType: allOf: - $ref: '#/components/schemas/EntityType' - description: Canadian Presence Requirement (CA) ErrorFieldDomainContactsValidate: title: ErrorFieldDomainContactsValidate required: - code - domains - path type: object properties: code: type: string description: Short identifier for the error, suitable for indicating the specific error within client code domains: type: array items: type: string description: An array of domain names the error is for. If tlds are specified in the request, `domains` will contain tlds. For example, if `domains` in request is ["test1.com", "test2.uk", "net"], and the field is invalid for com and net, then one of the `fields` in response will have ["test1.com", "net"] as `domains` message: type: string description: Human-readable, English description of the problem with the contents of the field path: type: string description: 1) JSONPath referring to the field within the data containing an error
or
2) JSONPath referring to an object containing an error pathRelated: type: string description: JSONPath referring to the field on the object referenced by `path` containing an error JsonDataType: title: JsonDataType required: - type type: object properties: format: type: string pattern: type: string type: type: string JsonProperty: title: JsonProperty required: - required - type type: object properties: defaultValue: type: string format: type: string items: type: array items: $ref: '#/components/schemas/JsonDataType' description: '' maxItems: type: integer contentEncoding: int32 maximum: type: integer contentEncoding: int32 minItems: type: integer contentEncoding: int32 minimum: type: integer contentEncoding: int32 pattern: type: string required: type: boolean type: type: string JsonSchema: title: JsonSchema required: - id - models - properties - required type: object properties: id: type: string models: type: array items: $ref: '#/components/schemas/JsonSchema' description: '' properties: type: array items: $ref: '#/components/schemas/JsonProperty' description: '' required: type: array items: type: string description: '' Maintenance: title: Maintenance required: - createdAt - endsAt - environment - maintenanceId - modifiedAt - reason - startsAt - status - summary - type type: object properties: createdAt: type: string description: Date and time (UTC) when this maintenance was created endsAt: type: string description: Date and time (UTC) when this maintenance will complete environment: allOf: - $ref: '#/components/schemas/Environment' - description: "The environment on which the maintenance will be performed
  • OTE - The Operational Testing Environment.
  • PRODUCTION - The Live Production Environment.
" maintenanceId: type: string description: The identifier for the system maintenance modifiedAt: type: string description: Date and time (UTC) when this maintenance was last modified reason: allOf: - $ref: '#/components/schemas/Reason1' - description: "The reason for the maintenance being performed
  • EMERGENCY - Unexpected Emergency maintenance.
  • PLANNED - Planned system maintenance.
" startsAt: type: string description: Date and time (UTC) when this maintenance will start status: allOf: - $ref: '#/components/schemas/Status11' - description: "The status of maintenance
  • ACTIVE - The upcoming maintenance is active.
  • CANCELLED - The upcoming maintenance has been cancelled.
" summary: type: string description: A brief description of what is being performed tlds: type: array items: type: string description: List of tlds that are in maintenance. Generally only applies when `type` is REGISTRY type: allOf: - $ref: '#/components/schemas/Type12' - description: "The type of maintenance being performed
  • API - Programmatic Api components.
  • REGISTRY - The underlying Registry providing the tld(s).
  • UI - User Interface components.
" MaintenanceDetail: title: MaintenanceDetail required: - createdAt - endsAt - environment - maintenanceId - modifiedAt - reason - startsAt - status - summary - type type: object properties: createdAt: type: string description: Date and time (UTC) when this maintenance was created endsAt: type: string description: Date and time (UTC) when this maintenance will complete environment: allOf: - $ref: '#/components/schemas/Environment' - description: "The environment on which the maintenance will be performed
  • OTE - The Operational Testing Environment.
  • PRODUCTION - The Live Production Environment.
" maintenanceId: type: string description: The identifier for the system maintenance modifiedAt: type: string description: Date and time (UTC) when this maintenance was last modified reason: allOf: - $ref: '#/components/schemas/Reason1' - description: "The reason for the maintenance being performed
  • EMERGENCY - Unexpected Emergency maintenance.
  • PLANNED - Planned system maintenance.
" startsAt: type: string description: Date and time (UTC) when this maintenance will start status: allOf: - $ref: '#/components/schemas/Status11' - description: "The status of maintenance
  • ACTIVE - The upcoming maintenance is active.
  • CANCELLED - The upcoming maintenance has been cancelled.
" summary: type: string description: A brief description of what is being performed systems: type: array items: $ref: '#/components/schemas/MaintenanceSystem' description: List of systems that are impacted by the maintenance. tlds: type: array items: type: string description: List of tlds that are in maintenance. Generally only applies when `type` is REGISTRY type: allOf: - $ref: '#/components/schemas/Type12' - description: "The type of maintenance being performed
  • API - Programmatic Api components.
  • REGISTRY - The underlying Registry providing the tld(s).
  • UI - User Interface components.
" MaintenanceSystem: title: MaintenanceSystem required: - name - impact type: object properties: name: allOf: - $ref: '#/components/schemas/Name' - description: "The name of the system affected by the maintenance
  • DOMAIN_CHECKS - Refers to domain availability checks.
  • DOMAIN_MANAGEMENT - Refers to domain management options including various update options on the domain, contacts, records, etc.
  • DOMAIN_REGISTRATION - Refers to domain registrations, renewals, transfers.
  • DOMAIN_REGISTRATION_DATA - Refers to RDAP and WHOIS Service queries for domains.
  • DOMAIN_RESOLUTION - Refers to DNS resolution for domains.
  • RESELLER_ADMIN_PORTAL - Refers to Admin portals to manage the reseller account and settings.
  • RESELLER_STOREFRONT - Refers to the Reseller Storefront features (Standard and Custom).
" impact: type: array items: $ref: '#/components/schemas/Impact' description: "The impact of the maintenance to the system
  • DELAYED - This response generally applies to systems where the request is queued up and processed once the system is back online.
  • DOWN - The system will be entirely offline; errors are expected.
  • NON_AUTHORITATIVE - This response generally applies to DOMAIN_CHECKS and DOMAIN_MANAGEMENT `system` values where a cached answer will be supplied.
  • PARTIAL - The system will experience partial feature outages; some errors are expected.
" PrivacyPurchase: title: PrivacyPurchase required: - consent type: object properties: consent: $ref: '#/components/schemas/Consent' RealNameValidation: title: RealNameValidation type: object properties: status: $ref: '#/components/schemas/Status13' RenewalDetails: title: RenewalDetails required: - price - currency type: object properties: renewable: type: boolean description: Whether or not the domain is eligble for renewal based on status price: type: integer description: Price for the domain renewal excluding taxes or fees contentEncoding: int32 currency: pattern: ^[A-Z][A-Z][A-Z]$ type: string description: Currency in which the `price` is listed TldSummary: title: TldSummary required: - name - type type: object properties: name: type: string description: Name of the top-level domain type: allOf: - $ref: '#/components/schemas/Type14' - description: Type of the top-level domain VerificationDomainName: title: VerificationDomainName required: - status type: object properties: status: allOf: - $ref: '#/components/schemas/Status7' - description: Status of the domain name verification VerificationRealName: title: VerificationRealName required: - status type: object properties: status: allOf: - $ref: '#/components/schemas/Status8' - description: "Status of the real name verification
  • APPROVED - All is well
  • PENDING - Real name verification is working its way through the workflow
  • REJECTED_DOCUMENT_OUTDATED - Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification
  • REJECTED_EXPIRED_BUSINESS_LICENSE - Business license is expired
  • REJECTED_EXPIRED_ORGANIZATION_CODE - Organization code certificate number has expired
  • REJECTED_ILLEGIBLE_DOCUMENT_NAME - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification
  • REJECTED_ILLEGIBLE_IDENTIFICATION - Registrant identification is not clear. Upload a better image to retry
  • REJECTED_INCOMPLETE_IDENTIFICATION - Registrant identification is incomplete
  • REJECTED_INCOMPLETE_REGISTRATION_LETTER - Registration letter is incomplete
  • REJECTED_INCONSISTENT_IDENTITY_CARD - Provided identity card is inconsistent with the identity card on record
  • REJECTED_INCONSISTENT_ORGANIZATION_CODE - Provided organization information is inconsistent with the results obtained using the submitted organization code
  • REJECTED_INCONSISTENT_REGISTRANT_NAME - Name on the registrant identification does not match the name in the system
  • REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - Your document contains an invalid business license or organization code certificate number
  • REJECTED_INVALID_DOCUMENT - Document is invalid. Please upload another document to retry real name verification
  • REJECTED_MISMATCH_BUSINESS_ID - Business id does not match the business id in the document
  • REJECTED_MISMATCH_BUSINESS_NAME - Business name does not match the business name in the document
  • REJECTED_MISMATCH_DOCUMENT_ID - Document id does not match the id in the document
  • REJECTED_MISMATCH_DOCUMENT_NAME - Document name does not match the name in the document
  • REJECTED_MISMATCH_DOCUMENT_TYPE - Document type does not match the document
  • REJECTED_MISMATCH_REGISTRANT_INFO - The information provided for the registrant does not match the document
  • REJECTED_MISMATCH_REGISTRANT_LOCALITY - Registrant region is overseas, but a local identity document was provided
  • REJECTED_MISMATCH_REGISTRANT_NAME - Registrant name has been changed, so the request must be resubmitted
  • REJECTED_UNABLE_TO_OPEN - Registrant identification could not be opened. Please upload the document again to retry real name verification
  • REJECTED_UNABLE_TO_VERIFY - Unable to initiate verification. Please upload the document again to retry real name verification
  • REJECTED_UNKNOWN_ERROR - Document was rejected due to an unknown error. For more information, contact customer support
  • UNABLE_TO_RETRIEVE_STATUS - Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support
" VerificationsDomain: title: VerificationsDomain type: object properties: domainName: $ref: '#/components/schemas/VerificationDomainName' realName: $ref: '#/components/schemas/VerificationRealName' VerificationsDomainV2: title: VerificationsDomainV2 type: object properties: icann: allOf: - $ref: '#/components/schemas/Icann' - description: "Status of the Icann verification of domain registrant contact by completing email and/or phone verification
  • COMPLETED - Icann verification has been completed.
  • PENDING - Icann verification has not been completed.
" realName: allOf: - $ref: '#/components/schemas/RealName' - description: "Status of the real name verification of an identity by comparing registration data against government issued documents
  • APPROVED - All is well
  • PENDING - Real name verification is working its way through the workflow
  • REJECTED_DOCUMENT_OUTDATED - Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification
  • REJECTED_EXPIRED_BUSINESS_LICENSE - Business license is expired
  • REJECTED_EXPIRED_ORGANIZATION_CODE - Organization code certificate number has expired
  • REJECTED_ILLEGIBLE_DOCUMENT_NAME - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification
  • REJECTED_ILLEGIBLE_IDENTIFICATION - Registrant identification is not clear. Upload a better image to retry
  • REJECTED_INCOMPLETE_IDENTIFICATION - Registrant identification is incomplete
  • REJECTED_INCOMPLETE_REGISTRATION_LETTER - Registration letter is incomplete
  • REJECTED_INCONSISTENT_IDENTITY_CARD - Provided identity card is inconsistent with the identity card on record
  • REJECTED_INCONSISTENT_ORGANIZATION_CODE - Provided organization information is inconsistent with the results obtained using the submitted organization code
  • REJECTED_INCONSISTENT_REGISTRANT_NAME - Name on the registrant identification does not match the name in the system
  • REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - Your document contains an invalid business license or organization code certificate number
  • REJECTED_INVALID_DOCUMENT - Document is invalid. Please upload another document to retry real name verification
  • REJECTED_MISMATCH_BUSINESS_ID - Business id does not match the business id in the document
  • REJECTED_MISMATCH_BUSINESS_NAME - Business name does not match the business name in the document
  • REJECTED_MISMATCH_DOCUMENT_ID - Document id does not match the id in the document
  • REJECTED_MISMATCH_DOCUMENT_NAME - Document name does not match the name in the document
  • REJECTED_MISMATCH_DOCUMENT_TYPE - Document type does not match the document
  • REJECTED_MISMATCH_REGISTRANT_INFO - The information provided for the registrant does not match the document
  • REJECTED_MISMATCH_REGISTRANT_LOCALITY - Registrant region is overseas, but a local identity document was provided
  • REJECTED_MISMATCH_REGISTRANT_NAME - Registrant name has been changed, so the request must be resubmitted
  • REJECTED_UNABLE_TO_OPEN - Registrant identification could not be opened. Please upload the document again to retry real name verification
  • REJECTED_UNABLE_TO_VERIFY - Unable to initiate verification. Please upload the document again to retry real name verification
  • REJECTED_UNKNOWN_ERROR - Document was rejected due to an unknown error. For more information, contact customer support
  • UNABLE_TO_RETRIEVE_STATUS - Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support
" domainName: allOf: - $ref: '#/components/schemas/DomainName' - description: Status of the verification of the domain name against a prohibited list maintained by the government domain: title: domain type: object properties: id: type: number ErrorDomainContactsValidate: title: ErrorDomainContactsValidate required: - code type: object properties: code: type: string description: Short identifier for the error, suitable for indicating the specific error within client code fields: type: array items: $ref: '#/components/schemas/ErrorFieldDomainContactsValidate' description: List of the specific fields, and the errors found with their contents message: type: string description: Human-readable, English description of the error stack: type: array items: type: string description: 'Stack trace indicating where the error occurred.
NOTE: This attribute MAY be included for Development and Test environments. However, it MUST NOT be exposed from OTE nor Production systems' BillTo: title: BillTo required: - contact type: object properties: contact: $ref: '#/components/schemas/Contact' taxId: type: string description: Tax id used for calculating the tax the customer is required to pay LineItem: title: LineItem required: - label - pricing - quantity type: object properties: domains: type: array items: type: string description: A collection of domain names purchased if the current product is domain label: type: string description: Human readable description of the current product period: type: number default: 1 periodUnit: allOf: - $ref: '#/components/schemas/PeriodUnit' - description: The unit of time that periodCount is measured in pfid: type: integer description: Unique identifier of the current product contentEncoding: int32 pricing: $ref: '#/components/schemas/LineItemPricing' quantity: type: integer description: Number of the current product included in the specified order contentEncoding: int32 taxCollector: $ref: '#/components/schemas/LineItemTaxCollector' LineItemPricing: title: LineItemPricing required: - discount - fees - list - sale - savings - subtotal - taxes - unit type: object properties: discount: type: integer description: Discount off of sale price for given `quantity` and `period` 
`discount` = `sale` - `subtotal`
contentEncoding: int32 fees: $ref: '#/components/schemas/OrderFee' list: type: integer description: List price for given `quantity` and `period` contentEncoding: int32 sale: type: integer description: Actual price for the current product contentEncoding: int32 savings: type: integer description: Savings off of list price for given `quantity` and `period` 
`savings` = `list` - `subtotal`
contentEncoding: int32 subtotal: type: integer description: Price with any discounts and without taxes or fees for given `quantity` and `period` contentEncoding: int32 taxes: type: integer description: Taxes for given `quantity` and `period` contentEncoding: int32 unit: type: object description: Pricing for a single unit of the given item LineItemSummary: title: LineItemSummary required: - label type: object properties: label: type: string description: Product label of the current line item LineItemTaxCollector: title: LineItemTaxCollector required: - taxCollectorId type: object properties: taxCollectorId: type: integer description: Unique identifier for the company contentEncoding: int32 LineItemPricingTaxDetail: title: LineItemPricingTaxDetail type: object properties: amount: type: integer description: Tax amount contentEncoding: int32 rate: type: number LineItemUnitPricing: title: LineItemUnitPricing required: - discount - fees - list - sale - savings - taxes type: object properties: discount: type: integer description: Discount without consideration of `quantity` and `period` contentEncoding: int32 fees: $ref: '#/components/schemas/OrderFee' list: type: integer description: List price without consideration of `quantity` and `period` contentEncoding: int32 sale: type: integer description: Sale price without consideration of `quantity` and `period` contentEncoding: int32 savings: type: integer description: Savings without consideration of `quantity` and `period` contentEncoding: int32 taxes: type: integer description: Taxes without consideration of `quantity` and `period` contentEncoding: int32 Order: title: Order required: - billTo - createdAt - currency - items - orderId - payments - pricing type: object properties: billTo: $ref: '#/components/schemas/BillTo' createdAt: type: string description: Date and time when the current order is created on currency: type: string description: Currency in which the order has been placed items: type: array items: $ref: '#/components/schemas/LineItem' description: '' orderId: type: string description: Unique identifier of current order parentOrderId: type: string description: >- Unique identifier of the parent order. All refund/chargeback orders are tied to the original order. The orginal order's `orderId` is the `parentOrderId` of refund/chargeback orders payments: type: array items: $ref: '#/components/schemas/Payment' description: '' pricing: $ref: '#/components/schemas/OrderPricing' OrderFee: title: OrderFee required: - total type: object properties: icann: type: integer description: Domain registration transaction fee charged by ICANN contentEncoding: int32 total: type: integer description: Sum of all fees contentEncoding: int32 OrderList: title: OrderList required: - orders - pagination type: object properties: orders: type: array items: $ref: '#/components/schemas/OrderSummary' description: A collection of orders pagination: $ref: '#/components/schemas/Pagination' OrderPricing: title: OrderPricing required: - discount - fees - list - savings - subtotal - taxes - total type: object properties: discount: type: integer description: Discount from promotional pricing contentEncoding: int32 fees: $ref: '#/components/schemas/OrderFee' id: type: number list: type: integer description: Sum of list prices for the entire cart contentEncoding: int32 savings: type: integer description: Savings off of list price 
`savings` = `list` - `subtotal`
contentEncoding: int32 subtotal: type: integer description: Price with `discount` and without taxes or fees contentEncoding: int32 taxes: type: integer description: Taxes for the entire cart contentEncoding: int32 taxDetails: type: array items: $ref: '#/components/schemas/LineItemPricingTaxDetail' description: A collection of line item tax details total: type: integer description: Price the customer pays 
`total` = `subtotal` + `taxes` + `fees.total`
contentEncoding: int32 OrderSummary: title: OrderSummary required: - createdAt - currency - items - orderId - pricing type: object properties: createdAt: type: string description: Date and time when the current order was created currency: type: string description: Currency in which the order was placed items: type: array items: $ref: '#/components/schemas/LineItemSummary' description: Sets of two or more line items in current order orderId: type: string description: Unique identifier of the current order parentOrderId: type: string description: >- Unique identifier of the parent order. All refund/chargeback orders are tied to the original order. The orginal order's `orderId` is the `parentOrderId` of refund/chargeback orders pricing: $ref: '#/components/schemas/OrderSummaryPricing' OrderSummaryPricing: title: OrderSummaryPricing required: - total type: object properties: total: type: string description: Total amount charged for the current order. Negative for Refund and Chargeback Payment: title: Payment required: - amount - category - paymentProfileId type: object properties: amount: type: integer description: Amount paid by the current payment contentEncoding: int32 category: allOf: - $ref: '#/components/schemas/Category' - description: >- The category of payment method used at the time of purchase. Most common values are listed in the enum. paymentProfileId: type: string description: Unique identifier of the payment profile used by current payment subcategory: allOf: - $ref: '#/components/schemas/Subcategory' - description: >- The subcategory of payment method used at the time of purchase. This field is only set for certain payment categories, such as ACH and CREDIT_CARD. Most common values are listed in the enum. MetricList: title: MetricList required: - currencyId - metrics - pagination type: object properties: currencyId: const: USD type: string description: The currencyId in which `revenue` is returned examples: - USD metrics: type: array items: $ref: '#/components/schemas/Metrics' description: Metrics pagination: $ref: '#/components/schemas/Pagination' Metrics: title: Metrics required: - adClickCount - periodPtz - revenue - visitCount type: object properties: adClickCount: type: integer description: Number of ad clicks for the domain contentEncoding: int32 periodPtz: type: string description: Period indicating the day of the result. ISO 8601 date YYYY-MM-DD in Pacific Time Zone revenue: type: integer description: Revenue earned for the domain, using micro unit. 1 currency unit = 1,000,000 micro unit. For example, 1 USD = 1,000,000 micro unit with `USD` as `currency` contentEncoding: int32 visitCount: type: integer description: Number of visits for the domain contentEncoding: int32 examples: - adClickCount: 4 periodPtz: 2020-02-05 revenue: 4000000 visitCount: 22 MetricByDomainList: title: MetricByDomainList required: - currencyId - metrics - pagination - startDate - endDate type: object properties: currencyId: const: USD type: string description: The currencyId in which `revenue` is returned examples: - USD metrics: type: array items: $ref: '#/components/schemas/MetricsByDomain' description: Metrics pagination: $ref: '#/components/schemas/Pagination' startDate: type: string description: Start of range indicating what time-frame should be returned, inclusive. ISO 8601 date YYYY-MM-DD endDate: type: string description: End of range indicating what time-frame should be returned, inclusive. ISO 8601 date YYYY-MM-DD MetricsByDomain: title: MetricsByDomain required: - adClickCount - domain - revenue - visitCount - pageViewCount type: object properties: adClickCount: type: integer description: Number of ad clicks for the domain contentEncoding: int32 domain: type: string description: The root domain without any subdomains revenue: type: integer description: Revenue earned for the domain, using micro unit. 1 currency unit = 1,000,000 micro unit. For example, 1 USD = 1,000,000 micro unit with `USD` as `currency` contentEncoding: int32 visitCount: type: integer description: Number of visits for the domain contentEncoding: int32 pageViewCount: type: integer description: Number of page views for the domain contentEncoding: int32 examples: - adClickCount: 3 domain: example.com pageViewCount: 4 revenue: 3000000 visitCount: 30 Shopper: title: Shopper required: - email - marketId - nameFirst - nameLast - shopperId type: object properties: customerId: type: string description: Identifier for the Customer record associated with this Shopper record. This is an alternate identifier that some systems use to identify an individual shopper record email: type: string externalId: type: integer contentEncoding: int32 marketId: type: string nameFirst: type: string nameLast: type: string shopperId: type: string ShopperId: title: ShopperId required: - shopperId type: object properties: customerId: type: string description: Identifier for the Customer record associated with this Shopper record. This is an alternate identifier that some systems use to identify an individual shopper record shopperId: type: string ShopperStatus: title: ShopperStatus type: object properties: billingState: allOf: - $ref: '#/components/schemas/BillingState' - description: 'Indicates the billing state of the Shopper.
ABANDONED: The shopper has not been billed in at least 10 years and has no active subscriptions.
INACTIVE: The shopper has been billed within the last 10 years but has no active subscriptions.
ACTIVE: The shopper has at least one active subscription.' ShopperUpdate: title: ShopperUpdate type: object properties: email: type: string externalId: type: integer contentEncoding: int32 marketId: allOf: - $ref: '#/components/schemas/MarketId' - maxLength: 50 nameFirst: type: string nameLast: type: string SubaccountCreate: title: SubaccountCreate required: - email - nameFirst - nameLast - password type: object properties: email: type: string externalId: type: integer contentEncoding: int32 marketId: allOf: - $ref: '#/components/schemas/MarketId' - maxLength: 50 nameFirst: type: string nameLast: type: string password: type: string Secret: title: Secret type: object properties: secret: type: string description: The secret value used to set a subaccount's password examples: - P@55w0rd+ PasswordError: title: PasswordError type: object properties: type: type: string description: Response type, always 'error' code: allOf: - $ref: '#/components/schemas/Code' - description: Short identifier for the error, suitable for indicating the specific error within client code message: type: string description: Human-readable, English description of the error ProductGroup: title: ProductGroup required: - productGroupKey - subscriptionCount type: object properties: productGroupKey: type: string description: Primary key of a grouping of related Subscriptions subscriptionCount: type: integer description: The number of Subscriptions that the shopper owns in this group contentEncoding: int32 Subscription: title: Subscription required: - billing - createdAt - priceLocked - product - renewAuto - renewable - status - subscriptionId - upgradeable type: object properties: addons: type: array items: $ref: '#/components/schemas/SubscriptionAddon' description: An array of additional products that have been purchased to augment this Subscription billing: $ref: '#/components/schemas/SubscriptionBilling' cancelable: type: boolean description: Whether or not the Subscription is allowed to be canceled createdAt: type: string description: When the Subscription was created expiresAt: type: string description: When the Subscription will expire label: type: string description: A human readable description of this Subscription launchUrl: type: string description: The url to use or manage this Subscription's active product paymentProfileId: type: integer description: Unique identifier of the payment profile that will be used to automatically renew this Subscription contentEncoding: int32 priceLocked: type: boolean description: Whether the renewal price will be based from the list price or a locked-in price for this shopper product: $ref: '#/components/schemas/SubscriptionProduct' relations: $ref: '#/components/schemas/SubscriptionRelations' renewAuto: type: boolean description: Whether or not the Subscription is set to be automatically renewed via the billing agent renewable: type: boolean description: Whether or not the Subscription is allowed to be renewed status: allOf: - $ref: '#/components/schemas/Status15' - description: Whether the Subscription is active or the specific non-active state subscriptionId: type: string description: Unique identifier of the Subscription upgradeable: type: boolean description: Whether or not the Subscription is allowed to be upgraded SubscriptionAddon: title: SubscriptionAddon required: - commitment - pfid - quantity type: object properties: commitment: allOf: - $ref: '#/components/schemas/Commitment' - description: The financial commitment the customer has in the product pfid: type: integer description: Unique identifier of the add-in product contentEncoding: int32 quantity: type: integer contentEncoding: int32 SubscriptionBilling: title: SubscriptionBilling required: - commitment - renewAt - status type: object properties: commitment: allOf: - $ref: '#/components/schemas/Commitment' - description: The financial commitment the customer has in the product pastDueTypes: type: array items: $ref: '#/components/schemas/PastDueType' description: The types of charges that are past due when `status` is PAST_DUE renewAt: type: string description: The point in time after which the Subscription will bill for automatic renewal status: allOf: - $ref: '#/components/schemas/Status14' - description: Whether payments are past due SubscriptionList: title: SubscriptionList required: - pagination - subscriptions type: object properties: pagination: $ref: '#/components/schemas/Pagination' subscriptions: type: array items: $ref: '#/components/schemas/Subscription' description: A collection of subscriptions SubscriptionProduct: title: SubscriptionProduct required: - label - namespace - pfid - productGroupKey - renewalPeriod - renewalPeriodUnit - renewalPfid - supportBillOn type: object properties: label: type: string description: A human readable description of the Product that is subscribed namespace: type: string description: Grouping of related Subscriptions pfid: type: integer description: Unique identifier of the Product that is subscribed contentEncoding: int32 productGroupKey: type: string description: Primary key of a grouping of related Subscriptions renewalPeriod: type: integer description: The number of `renewalPeriodUnits` that will be added by the `renewalPfid` contentEncoding: int32 renewalPeriodUnit: allOf: - $ref: '#/components/schemas/RenewalPeriodUnit' - description: The unit of time that `renewalPeriod` is measured in renewalPfid: type: integer description: Unique identifier of the renewal Product contentEncoding: int32 supportBillOn: type: boolean description: Whether the product supports the `billOn` option on the renewal endpoint SubscriptionRelations: title: SubscriptionRelations type: object properties: children: type: array items: type: string description: A set of related Subscriptions that will be canceled automatically if this Subscription is canceled parent: type: string description: Unique identifier of this Subscription's parent SubscriptionUpdate: title: SubscriptionUpdate type: object properties: paymentProfileId: type: integer description: Unique identifier of the payment profile you want to be used for automatic renewal contentEncoding: int32 renewAuto: type: boolean description: Whether or not you want the Subscription renew automatically AgreementKey: title: AgreementKey const: EXPOSE_WHOIS type: string Algorithm: title: Algorithm enum: - RSAMD5 - DH - DSA - RSASHA1 - DSA_NSEC3_SHA1 - RSASHA1_NSEC3_SHA1 - RSASHA256 - RSASHA512 - ECC_GOST - ECDSAP256SHA256 - ECDSAP384SHA384 - ED25519 - ED448 - PRIVATEDNS - PRIVATEOID type: string description: "This identifies the cryptographic algorithm used to generate the signature
  • RSAMD5 - [01] DRSA/MD5
  • DSA - [03] DSA/SHA1
  • RSASHA1 - [05] RSA/SHA-1
  • DSA_NSEC3_SHA1 - [06] DSA-NSEC3-SHA1
  • RSASHA1_NSEC3_SHA1 - [07] RSASHA1-NSEC3-SHA1
  • RSASHA256 - [08] RSA/SHA-256
  • RSASHA512 - [10] RSA/SHA-512
  • ECC_GOST - [12] GOST R 34.10-2001
  • ECDSAP256SHA256 - [13] ECDSA Curve P-256 with SHA-256
  • ECDSAP384SHA384 - [14] ECDSA Curve P-384 with SHA-384
  • ED25519 - [15] Ed25519
  • ED448 - [16] Ed448
" BillingState: title: BillingState enum: - ABANDONED - INACTIVE - ACTIVE type: string description: 'Indicates the billing state of the Shopper.
ABANDONED: The shopper has not been billed in at least 10 years and has no active subscriptions.
INACTIVE: The shopper has been billed within the last 10 years but has no active subscriptions.
ACTIVE: The shopper has at least one active subscription.' Category: title: Category enum: - CREDIT_CARD - PAYPAL - ACH - GIFT_CARD - IN_STORE_CREDIT - PREPAID type: string description: >- The category of payment method used at the time of purchase. Most common values are listed in the enum. CertificateAuthorityAuthorization: title: CertificateAuthorityAuthorization type: object properties: status: allOf: - $ref: '#/components/schemas/Status5' - description: >- Returns the status of the CAA Lookup for the specified domain: * `PENDING` - The CAA lookup has not yet been attempted for the specified domain. * `REMOVED_DNS_ERROR` - Repeated errors occurred while scanning for CAA records, thereby resulting in a DNSSEC scan. DNS errors then prevented the system from determining if DNSSEC was enabled for the specified domain, and it had to be removed from the certificate request. * `REMOVED_DNSSEC_ENABLED` - Repeated errors occurred while scanning for CAA records, thereby resulting in a DNSSEC scan. DNSSEC was determined to be enabled for the specified domain, and it had to be removed from the certificate request. * `REMOVED_NOT_FOUND_CA` - CAA records were found during the CAA lookup for the speicified domain, but `godaddy.com` or `starfieldtech.com` was not listed as a value, thereby not allowing us to issue a certificate with this domain. The specified domain was removed from the certificate request. * `REMOVED_UNKNOWN_CRITICAL_TAG` - A CAA record was found during the CAA lookup with its Critical bit set, as outlined by RFC 6844, yet the Tag of the CAA record was not understood (as outlined by RFC 6844). The specified domain was removed from the certificate request. * `SUCCESS_CAA` - The CAA lookup was successful for the specified domain, and the domain can remain in the certificate request. * `SUCCESS_DNSSEC` - Repeated errors occurred while scanning for CAA records, thereby resulting in a DNSSEC scan. The system detemined that DNSSEC was not enabled for the specified domain, so the domain is allowed to remain in the certificate request. queryPaths: type: array items: type: string description: Details all the individual DNS paths that were scanned for CAA records for this domain, as detailed by RFC 6844. This element not only contains the parts determined from parsing the domain, but also any CNAME or DNAME targets specified by any of those individual parts. recommendations: type: array items: $ref: '#/components/schemas/Recommendation' description: Returns a list of fix recommendations if the query was unsuccessful, or if the domain was dropped from the certificate request, so that a subsequent certificate request with the specified domain will successfully pass its CAA scan. completedAt: type: string description: The date the certificate request completed processing. description: >- Contains information about the last Certificate Authority Authorization (CAA) Lookup details for the specified domain. In order for a domain to be eligible to be included in the certificate, the entire domain hierarchy must be scanned for DNS CAA records, as outlined by RFC 6844. The absence of any CAA records found in the domain hierarchy indicates that the domain may be included in the certificate. Alternatively, if CAA records are found when scanning the domain hierarchy, the domain may be included in the certificate as long as `godaddy.com` or `starfieldtech.com` is found in the DNS record value. However, if CAA records are found, yet `godaddy.com` or `starfieldtech.com` is not found in any CAA record's value, then we must drop the domain from the certificate request. In the case where there are repeated DNS errors when scanning the domain hierarchy for CAA records, thus ending in an unsuccessful scan, then the domain can still be included in the certificate provided the primary domain is not setup with DNSSEC. Conversely, if DNSSEC is found to be setup on the primary domain when scanning following repeated CAA failures, the domain must be dropped from the certificate request. Finally, if DNS errors persist to the point where a successful DNSSEC query could not be obtained, then the domain must be dropped from the certificate request. checkType: title: checkType enum: - FAST - FULL - fast - full type: string Code: title: Code enum: - PW_BLACK_LIST - PW_TOO_SHORT - PW_TOO_LONG - PW_MISSING_UC - PW_MISSING_NUM - PW_RECENTLY_USED - PW_NOT_UNIQUE type: string description: Short identifier for the error, suitable for indicating the specific error within client code Commitment: title: Commitment enum: - PAID - FREE - TRIAL type: string description: The financial commitment the customer has in the product country1: title: country1 enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KV - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - NO - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SV - SX - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW type: string Country2: title: Country2 enum: - AC - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KV - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - NO - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SV - SX - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW type: string description: >- Two-letter ISO country code to be used as a hint for target region

NOTE: These are sample values, there are many more Country3: title: Country3 enum: - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BM - BN - BO - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CV - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MG - MH - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - NO - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - ST - SV - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - YU - ZA - ZM - ZW type: string description: Two character country code of organization DigestType: title: DigestType enum: - SHA1 - SHA256 - GOST - SHA384 type: string description: "This identifies the algorithm used to construct the digest
  • SHA1 - [01] SHA-1
  • SHA256 - [02] SHA-256
  • GOST - [03] GOST R 34.11-94
  • SHA384 - [04] SHA-384
" DomainName: title: DomainName enum: - APPROVED - PENDING - REJECTED - UNABLE_TO_RETRIEVE_STATUS type: string description: Status of the verification of the domain name against a prohibited list maintained by the government Encoding: title: Encoding enum: - ASCII - UTF-8 type: string description: "The encoding of the contact data
  • ASCII - Data contains only ASCII characters that are not region or language specific
  • UTF-8 - Data contains characters that are specific to a region or language
" EntityType: title: EntityType enum: - ABORIGINAL - ASSOCIATION - CITIZEN - CORPORATION - EDUCATIONAL - GOVERNMENT - HOSPITAL - INDIAN_BAND - LEGAL_REPRESENTATIVE - LIBRARY_ARCHIVE_MUSEUM - MARK_REGISTERED - MARK_TRADE - PARTNERSHIP - POLITICAL_PARTY - RESIDENT_PERMANENT - TRUST - UNION type: string description: Canadian Presence Requirement (CA) Environment: title: Environment enum: - OTE - PRODUCTION type: string description: "The environment on which the maintenance will be performed
  • OTE - The Operational Testing Environment.
  • PRODUCTION - The Live Production Environment.
" Flags: title: Flags enum: - ZSK - KSK type: string description: "This identifies the key type; either a Zone-Signing Key or a Key-Signing Key
  • ZSK - [256] Zone-Signing Key
  • KSK - [257] Key-Signing Key
" Icann: title: Icann enum: - COMPLETED - PENDING - UNABLE_TO_RETRIEVE_STATUS type: string description: "Status of the Icann verification of domain registrant contact by completing email and/or phone verification
  • COMPLETED - Icann verification has been completed.
  • PENDING - Icann verification has not been completed.
" Impact: title: Impact enum: - DELAYED - DOWN - NON_AUTHORITATIVE - PARTIAL type: string include: title: include enum: - authCode - contacts - nameServers type: string include1: title: include1 enum: - actions - contacts - dnssecRecords - registryStatusCodes type: string include2: title: include2 const: customerId type: string includes: title: includes enum: - addons - relations type: string MarketId: title: MarketId enum: - da-DK - de-AT - de-CH - de-DE - el-GR - en-AE - en-AU - en-CA - en-GB - en-HK - en-IE - en-IL - en-IN - en-MY - en-NZ - en-PH - en-PK - en-SG - en-US - en-ZA - es-AR - es-CL - es-CO - es-ES - es-MX - es-PE - es-US - es-VE - fi-FI - fr-BE - fr-CA - fr-CH - fr-FR - hi-IN - id-ID - it-CH - it-IT - ja-JP - ko-KR - mr-IN - nb-NO - nl-BE - nl-NL - pl-PL - pt-BR - pt-PT - ru-RU - sv-SE - ta-IN - th-TH - tr-TR - uk-UA - vi-VN - zh-HK - zh-SG - zh-TW type: string Name: title: Name enum: - DOMAIN_CHECKS - DOMAIN_MANAGEMENT - DOMAIN_REGISTRATION - DOMAIN_REGISTRATION_DATA - DOMAIN_RESOLUTION - RESELLER_ADMIN_PORTAL - RESELLER_STOREFRONT type: string description: "The name of the system affected by the maintenance
  • DOMAIN_CHECKS - Refers to domain availability checks.
  • DOMAIN_MANAGEMENT - Refers to domain management options including various update options on the domain, contacts, records, etc.
  • DOMAIN_REGISTRATION - Refers to domain registrations, renewals, transfers.
  • DOMAIN_REGISTRATION_DATA - Refers to RDAP and WHOIS Service queries for domains.
  • DOMAIN_RESOLUTION - Refers to DNS resolution for domains.
  • RESELLER_ADMIN_PORTAL - Refers to Admin portals to manage the reseller account and settings.
  • RESELLER_STOREFRONT - Refers to the Reseller Storefront features (Standard and Custom).
" order1: title: order1 enum: - ascending - descending type: string Origination: title: Origination enum: - USER - SYSTEM type: string description: "The origination of the action
  • USER - These are user requests.
  • SYSTEM - These are system processing actions.
" PastDueType: title: PastDueType enum: - ADDON - BURST - SUBSCRIPTION type: string PeriodUnit: title: PeriodUnit enum: - MONTH - QUARTER - SEMI_ANNUAL - YEAR - ONE_TIME type: string description: The unit of time that periodCount is measured in ProductType: title: ProductType enum: - DV_SSL - DV_WILDCARD_SSL - EV_SSL - OV_CS - OV_DS - OV_SSL - OV_WILDCARD_SSL - UCC_DV_SSL - UCC_EV_SSL - UCC_OV_SSL type: string description: Certificate product type ProductType1: title: ProductType1 enum: - DV_SSL - DV_WILDCARD_SSL - EV_SSL - OV_CS - OV_DS - OV_SSL - OV_WILDCARD_SSL - UCC_DV_SSL - UCC_EV_SSL - UCC_OV_SSL type: string description: Type of product requesting a certificate. Only required non-renewal RealName: title: RealName enum: - APPROVED - PENDING - REJECTED_DOCUMENT_OUTDATED - REJECTED_EXPIRED_BUSINESS_LICENSE - REJECTED_EXPIRED_ORGANIZATION_CODE - REJECTED_ILLEGIBLE_DOCUMENT_NAME - REJECTED_ILLEGIBLE_IDENTIFICATION - REJECTED_INCOMPLETE_IDENTIFICATION - REJECTED_INCOMPLETE_REGISTRATION_LETTER - REJECTED_INCONSISTENT_IDENTITY_CARD - REJECTED_INCONSISTENT_ORGANIZATION_CODE - REJECTED_INCONSISTENT_REGISTRANT_NAME - REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - REJECTED_INVALID_DOCUMENT - REJECTED_MISMATCH_BUSINESS_ID - REJECTED_MISMATCH_BUSINESS_NAME - REJECTED_MISMATCH_DOCUMENT_ID - REJECTED_MISMATCH_DOCUMENT_NAME - REJECTED_MISMATCH_DOCUMENT_TYPE - REJECTED_MISMATCH_REGISTRANT_INFO - REJECTED_MISMATCH_REGISTRANT_LOCALITY - REJECTED_MISMATCH_REGISTRANT_NAME - REJECTED_UNABLE_TO_OPEN - REJECTED_UNABLE_TO_VERIFY - REJECTED_UNKNOWN_ERROR - UNABLE_TO_RETRIEVE_STATUS type: string description: "Status of the real name verification of an identity by comparing registration data against government issued documents
  • APPROVED - All is well
  • PENDING - Real name verification is working its way through the workflow
  • REJECTED_DOCUMENT_OUTDATED - Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification
  • REJECTED_EXPIRED_BUSINESS_LICENSE - Business license is expired
  • REJECTED_EXPIRED_ORGANIZATION_CODE - Organization code certificate number has expired
  • REJECTED_ILLEGIBLE_DOCUMENT_NAME - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification
  • REJECTED_ILLEGIBLE_IDENTIFICATION - Registrant identification is not clear. Upload a better image to retry
  • REJECTED_INCOMPLETE_IDENTIFICATION - Registrant identification is incomplete
  • REJECTED_INCOMPLETE_REGISTRATION_LETTER - Registration letter is incomplete
  • REJECTED_INCONSISTENT_IDENTITY_CARD - Provided identity card is inconsistent with the identity card on record
  • REJECTED_INCONSISTENT_ORGANIZATION_CODE - Provided organization information is inconsistent with the results obtained using the submitted organization code
  • REJECTED_INCONSISTENT_REGISTRANT_NAME - Name on the registrant identification does not match the name in the system
  • REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - Your document contains an invalid business license or organization code certificate number
  • REJECTED_INVALID_DOCUMENT - Document is invalid. Please upload another document to retry real name verification
  • REJECTED_MISMATCH_BUSINESS_ID - Business id does not match the business id in the document
  • REJECTED_MISMATCH_BUSINESS_NAME - Business name does not match the business name in the document
  • REJECTED_MISMATCH_DOCUMENT_ID - Document id does not match the id in the document
  • REJECTED_MISMATCH_DOCUMENT_NAME - Document name does not match the name in the document
  • REJECTED_MISMATCH_DOCUMENT_TYPE - Document type does not match the document
  • REJECTED_MISMATCH_REGISTRANT_INFO - The information provided for the registrant does not match the document
  • REJECTED_MISMATCH_REGISTRANT_LOCALITY - Registrant region is overseas, but a local identity document was provided
  • REJECTED_MISMATCH_REGISTRANT_NAME - Registrant name has been changed, so the request must be resubmitted
  • REJECTED_UNABLE_TO_OPEN - Registrant identification could not be opened. Please upload the document again to retry real name verification
  • REJECTED_UNABLE_TO_VERIFY - Unable to initiate verification. Please upload the document again to retry real name verification
  • REJECTED_UNKNOWN_ERROR - Document was rejected due to an unknown error. For more information, contact customer support
  • UNABLE_TO_RETRIEVE_STATUS - Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support
" Reason: title: Reason enum: - AFFILIATION_CHANGED - CESSATION_OF_OPERATION - KEY_COMPROMISE - PRIVILEGE_WITHDRAWN - SUPERSEDED type: string description: Reason for revocation Reason1: title: Reason1 enum: - EMERGENCY - PLANNED type: string description: "The reason for the maintenance being performed
  • EMERGENCY - Unexpected Emergency maintenance.
  • PLANNED - Planned system maintenance.
" Recommendation: title: Recommendation enum: - ADD_CA_TO_CAA - CREATE_TARGET_DOMAIN_CAA - DISABLE_DNSSEC - FIX_CRITICAL_TAG - VALIDATE_SOA type: string description: >- * `ADD_CA_TO_CAA` - The system found a CAA record in the domain hierarchy, but it did not find our CA in the record's values. Add `godaddy.com` or `starfieldtech.com` to the CAA record's values. * `CREATE_TARGET_DOMAIN_CAA` - Create a CAA record on the specified domain with `godaddy.com` or `starfieldtech.com` as the value. If the system finds a CAA record in the specified domain, it will stop scanning the domain hierarchy, thereby preventing potentially problematic parent domain paths from being scanned. * `DISABLE_DNSSEC` - Disable DNSSEC on the domain if CAA lookups fail and a DNSSEC scan is being used as the method for determining if the specified domain can remain in the certificate request. * `FIX_CRITICAL_TAG` - When setting the critical flag in a CAA record, you must ensure you're using a well-known tag, per RFC 6844. * `VALIDATE_SOA` - Make sure all queryPaths for the specified domain have an SOA record pointing to a valid publicly-accessible nameserver and respond in a timely fashion. RegistryStatusCode: title: RegistryStatusCode enum: - ADD_PERIOD - AUTO_RENEW_PERIOD - CLIENT_DELETE_PROHIBITED - CLIENT_HOLD - CLIENT_RENEW_PROHIBITED - CLIENT_TRANSFER_PROHIBITED - CLIENT_UPDATE_PROHIBITED - INACTIVE - OK - PENDING_CREATE - PENDING_DELETE - PENDING_RENEW - PENDING_RESTORE - PENDING_TRANSFER - PENDING_UPDATE - REDEMPTION_PERIOD - RENEW_PERIOD - SERVER_DELETE_PROHIBITED - SERVER_HOLD - SERVER_RENEW_PROHIBITED - SERVER_TRANSFER_PROHIBITED - SERVER_UPDATE_PROHIBITED - TRANSFER_PERIOD type: string RenewalPeriodUnit: title: RenewalPeriodUnit enum: - MONTH - QUARTER - SEMI_ANNUAL - YEAR type: string description: The unit of time that `renewalPeriod` is measured in ResourceType: title: ResourceType enum: - CONTACT - DOMAIN - HOST type: string description: The type of resource the notification relates to RootType: title: RootType enum: - GODADDY_SHA_1 - GODADDY_SHA_2 - STARFIELD_SHA_1 - STARFIELD_SHA_2 type: string description: Root Type RootType1: title: RootType1 enum: - GODADDY_SHA_1 - GODADDY_SHA_2 - STARFIELD_SHA_1 - STARFIELD_SHA_2 type: string description: Root Type. Depending on certificate expiration date, SHA_1 not be allowed. Will default to SHA_2 if expiration date exceeds sha1 allowed date RootType4: title: RootType4 enum: - GODADDY_SHA_1 - GODADDY_SHA_2 - STARFIELD_SHA_1 - STARFIELD_SHA_2 type: string description: "Root type: \n * `GODADDY_SHA_1` - GoDaddy (Secure Hash Algorithm 1) SHA-1 root type\n * `GODADDY_SHA_2` - GoDaddy (Secure Hash Algorithm 2) SHA-2 root type\n * `STARFIELD_SHA_1` - Starfield SHA-1 root type\n * `STARFIELD_SHA_2` - Starfield SHA-2 root type" SlotSize: title: SlotSize enum: - FIVE - TEN - FIFTEEN - TWENTY - THIRTY - FOURTY - FIFTY - ONE_HUNDRED type: string description: Number of subject alternative names(SAN) to be included in certificate SlotSize2: title: SlotSize2 enum: - FIVE - TEN - FIFTEEN - TWENTY - THIRTY - FOURTY - FIFTY - ONE_HUNDRED type: string description: "Number of subject alternative names (SAN) to be included in certificate (if UCC): \n * `FIVE` - Five slot UCC request\n * `TEN` - Ten slot UCC request\n * `FIFTEEN` - Fifteen slot UCC request\n * `TWENTY` - Twenty slot UCC request\n * `THIRTY` - Thirty slot UCC request\n * `FOURTY` - Fourty slot UCC request\n * `FIFTY` - Fifty slot UCC request\n * `ONE_HUNDRED` - One hundred slot UCC request" sort: title: sort enum: - key - label type: string sort2: title: sort2 enum: - createdAt - -createdAt - orderId - -orderId - pricing.total - -pricing.total type: string sort3: title: sort3 enum: - expiresAt - -expiresAt type: string source: title: source enum: - CC_TLD - EXTENSION - KEYWORD_SPIN - PREMIUM - cctld - extension - keywordspin - premium type: string Status: title: Status enum: - PENDING_ISSUANCE - ISSUED - REVOKED - CANCELED - DENIED - PENDING_REVOCATION - PENDING_REKEY - UNUSED - EXPIRED type: string description: Status of certificate Status1: title: Status1 enum: - PENDING - INVALID - COMPLETED - FRAUD type: string description: Total number of page results Status2: title: Status2 enum: - PENDING_ISSUANCE - ISSUED - REVOKED - CANCELED - DENIED - PENDING_REVOCATION - PENDING_REKEY - UNUSED - EXPIRED type: string description: "Certificate status (if issued or revoked): \n * `CANCELED` - Certificate request was canceled by customer\n * `DENIED` - Certificate request was denied by customer\\n * `EXPIRED` - Issued certificate has exceeded the valid end date\n * `ISSUED` - Certificate has been issued and is within validity period\n * `PENDING_ISSUANCE` - Certificate request has completed domain verification and is in the process of being issued\n * `PENDING_REKEY` - Previously issued certificate was rekeyed by customer and is in the process of being reissued\n * `PENDING_REVOCATION` - Previously issued certificate is in the process of being revoked\n * `REVOKED` - Issued certificate has been revoked\\n * `UNUSED` - Certificate in an error state" Status3: title: Status3 enum: - ISSUED - CANCELED - DENIED - EXPIRED - PENDING_ISSUANCE - PENDING_REKEY - PENDING_REVOCATION - REVOKED - UNUSED type: string description: "Certificate status (if issued or revoked): \n * `CANCELED` - Certificate request was canceled by customer\n * `DENIED` - Certificate request was denied by customer\n * `EXPIRED` - Issued certificate has exceeded the valid end date\n * `ISSUED` - Certificate has been issued and is within validity period\n * `PENDING_ISSUANCE` - Certificate request has completed domain verification and is in the process of being issued\n * `PENDING_REKEY` - Previously issued certificate was rekeyed by customer and is in the process of being reissued\n * `PENDING_REVOCATION` - Previously issued certificate is in the process of being revoked\n * `REVOKED` - Issued certificate has been revoked\n * `UNUSED` - Certificate in an error state" Status4: title: Status4 enum: - COMPLETED - FAILED_VERIFICATION - VERIFIED_POSSIBLE_FRAUD - DROPPED - DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION - DROPPED_GOOGLE_SAFE_BROWSING - INVALID - AWAITING - PENDING_POSSIBLE_FRAUD - REVOKED_CERTIFICATE type: string description: "Domain verification status: \n * `AWAITING` - Verification pending customer input\n * `INVALID` - SAN connected to a cancelled request\n * `COMPLETED` - Verification completed\n * `FAILED_VERIFICATION` - Verification failed\n * `PENDING_POSSIBLE_FRAUD` - Flagged for a system level fraud review\n * `VERIFIED_POSSIBLE_FRAUD` - Fraud detection reviewed but verified\n * `DROPPED` - SAN dropped from request\n * `REVOKED_CERT` - Certificate revoked\n * `DROPPED_GOOGLE_SAFE_BROWSING` - SAN dropped from request due to Google Safe Browsing check\n * `DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION` - SAN dropped from request due to Certificate Authorization Authority DNS record check" Status5: title: Status5 enum: - PENDING - REMOVED_DNS_ERROR - REMOVED_DNSSEC_ENABLED - REMOVED_NOT_FOUND_CA - REMOVED_UNKNOWN_CRITICAL_TAG - SUCCESS_CAA - SUCCESS_DNSSEC type: string description: >- Returns the status of the CAA Lookup for the specified domain: * `PENDING` - The CAA lookup has not yet been attempted for the specified domain. * `REMOVED_DNS_ERROR` - Repeated errors occurred while scanning for CAA records, thereby resulting in a DNSSEC scan. DNS errors then prevented the system from determining if DNSSEC was enabled for the specified domain, and it had to be removed from the certificate request. * `REMOVED_DNSSEC_ENABLED` - Repeated errors occurred while scanning for CAA records, thereby resulting in a DNSSEC scan. DNSSEC was determined to be enabled for the specified domain, and it had to be removed from the certificate request. * `REMOVED_NOT_FOUND_CA` - CAA records were found during the CAA lookup for the speicified domain, but `godaddy.com` or `starfieldtech.com` was not listed as a value, thereby not allowing us to issue a certificate with this domain. The specified domain was removed from the certificate request. * `REMOVED_UNKNOWN_CRITICAL_TAG` - A CAA record was found during the CAA lookup with its Critical bit set, as outlined by RFC 6844, yet the Tag of the CAA record was not understood (as outlined by RFC 6844). The specified domain was removed from the certificate request. * `SUCCESS_CAA` - The CAA lookup was successful for the specified domain, and the domain can remain in the certificate request. * `SUCCESS_DNSSEC` - Repeated errors occurred while scanning for CAA records, thereby resulting in a DNSSEC scan. The system detemined that DNSSEC was not enabled for the specified domain, so the domain is allowed to remain in the certificate request. Status6: title: Status6 enum: - ACCEPTED - AWAITING - CANCELLED - FAILED - PENDING - SUCCESS type: string description: "The current status of the action
  • ACCEPTED - The action has been queued, processing has not started.
  • AWAITING - The action is waiting on a user input.
  • CANCELLED - The action has been cancelled by the user.
  • FAILED - An error occurred while the action was processing, no more processing will be performed.
  • PENDING - The action is being processed.
  • SUCCESS - The action has completed, no additional processing is required.
" Status7: title: Status7 enum: - APPROVED - PENDING - REJECTED - UNABLE_TO_RETRIEVE_STATUS type: string description: Status of the domain name verification Status8: title: Status8 enum: - APPROVED - PENDING - REJECTED_DOCUMENT_OUTDATED - REJECTED_EXPIRED_BUSINESS_LICENSE - REJECTED_EXPIRED_ORGANIZATION_CODE - REJECTED_ILLEGIBLE_DOCUMENT_NAME - REJECTED_ILLEGIBLE_IDENTIFICATION - REJECTED_INCOMPLETE_IDENTIFICATION - REJECTED_INCOMPLETE_REGISTRATION_LETTER - REJECTED_INCONSISTENT_IDENTITY_CARD - REJECTED_INCONSISTENT_ORGANIZATION_CODE - REJECTED_INCONSISTENT_REGISTRANT_NAME - REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - REJECTED_INVALID_DOCUMENT - REJECTED_MISMATCH_BUSINESS_ID - REJECTED_MISMATCH_BUSINESS_NAME - REJECTED_MISMATCH_DOCUMENT_ID - REJECTED_MISMATCH_DOCUMENT_NAME - REJECTED_MISMATCH_DOCUMENT_TYPE - REJECTED_MISMATCH_REGISTRANT_INFO - REJECTED_MISMATCH_REGISTRANT_LOCALITY - REJECTED_MISMATCH_REGISTRANT_NAME - REJECTED_UNABLE_TO_OPEN - REJECTED_UNABLE_TO_VERIFY - REJECTED_UNKNOWN_ERROR - UNABLE_TO_RETRIEVE_STATUS type: string description: "Status of the real name verification
  • APPROVED - All is well
  • PENDING - Real name verification is working its way through the workflow
  • REJECTED_DOCUMENT_OUTDATED - Local government verification shows there is a newer version of your document. Upload the latest version of the document and retry real name verification
  • REJECTED_EXPIRED_BUSINESS_LICENSE - Business license is expired
  • REJECTED_EXPIRED_ORGANIZATION_CODE - Organization code certificate number has expired
  • REJECTED_ILLEGIBLE_DOCUMENT_NAME - There isn’t a clear name on your uploaded document, please upload a different document to retry real name verification
  • REJECTED_ILLEGIBLE_IDENTIFICATION - Registrant identification is not clear. Upload a better image to retry
  • REJECTED_INCOMPLETE_IDENTIFICATION - Registrant identification is incomplete
  • REJECTED_INCOMPLETE_REGISTRATION_LETTER - Registration letter is incomplete
  • REJECTED_INCONSISTENT_IDENTITY_CARD - Provided identity card is inconsistent with the identity card on record
  • REJECTED_INCONSISTENT_ORGANIZATION_CODE - Provided organization information is inconsistent with the results obtained using the submitted organization code
  • REJECTED_INCONSISTENT_REGISTRANT_NAME - Name on the registrant identification does not match the name in the system
  • REJECTED_INVALID_BUSINESS_LICENSE_OR_ORGANIZATION_CODE - Your document contains an invalid business license or organization code certificate number
  • REJECTED_INVALID_DOCUMENT - Document is invalid. Please upload another document to retry real name verification
  • REJECTED_MISMATCH_BUSINESS_ID - Business id does not match the business id in the document
  • REJECTED_MISMATCH_BUSINESS_NAME - Business name does not match the business name in the document
  • REJECTED_MISMATCH_DOCUMENT_ID - Document id does not match the id in the document
  • REJECTED_MISMATCH_DOCUMENT_NAME - Document name does not match the name in the document
  • REJECTED_MISMATCH_DOCUMENT_TYPE - Document type does not match the document
  • REJECTED_MISMATCH_REGISTRANT_INFO - The information provided for the registrant does not match the document
  • REJECTED_MISMATCH_REGISTRANT_LOCALITY - Registrant region is overseas, but a local identity document was provided
  • REJECTED_MISMATCH_REGISTRANT_NAME - Registrant name has been changed, so the request must be resubmitted
  • REJECTED_UNABLE_TO_OPEN - Registrant identification could not be opened. Please upload the document again to retry real name verification
  • REJECTED_UNABLE_TO_VERIFY - Unable to initiate verification. Please upload the document again to retry real name verification
  • REJECTED_UNKNOWN_ERROR - Document was rejected due to an unknown error. For more information, contact customer support
  • UNABLE_TO_RETRIEVE_STATUS - Unable to retrieve status for the real name verification process. Retry, if this status persists, contact customer support
" Status9: title: Status9 enum: - ACTIVE - CANCELLED - DELETED_REDEEMABLE - EXPIRED - FAILED - LOCKED_REGISTRAR - PARKED - HELD_REGISTRAR - OWNERSHIP_CHANGED - PENDING_TRANSFER - PENDING_REGISTRATION - REPOSSESSED - SUSPENDED - TRANSFERRED type: string description: "The current status of the domain
  • ACTIVE - Domain has been registered and is active.
  • CANCELLED - Domain has been cancelled by the user or system, and is not be reclaimable.
  • DELETED_REDEEMABLE - Domain is deleted but is redeemable.
  • EXPIRED - Domain has expired.
  • FAILED - Domain registration or transfer error.
  • LOCKED_REGISTRAR - Domain is locked at the registrar - this is usually the result of a spam, abuse, etc.
  • PARKED - Domain has been parked.
  • HELD_REGISTRAR - Domain is held at the registrar and cannot be transferred or modified - this is usually the result of a dispute.
  • OWNERSHIP_CHANGED - Domain has been moved to another account.
  • PENDING_TRANSFER - Domain transfer has been requested and is pending the transfer process.
  • PENDING_REGISTRATION - Domain is pending setup at the registry.
  • REPOSSESSED - Domain has been confiscated - this is usually the result of a chargeback, fraud, abuse, etc.).
  • SUSPENDED - Domain is in violation and has been suspended.
  • TRANSFERRED - Domain has been transferred to another registrar.
" Status10: title: Status10 enum: - AWAITING - CANCELLED - FAILED - PENDING - SUCCESS type: string description: The resulting status of the action. Status11: title: Status11 enum: - ACTIVE - CANCELLED type: string description: "The status of maintenance
  • ACTIVE - The upcoming maintenance is active.
  • CANCELLED - The upcoming maintenance has been cancelled.
" Status13: title: Status13 enum: - APPROVED - PENDING - PENDING_ASSOCIATION_WITH_DOMAIN - PENDING_SUBMISSION_TO_VERIFICATION_SERVICE - PENDING_VERIFICATION_SERVICE_REPLY - PENDING_SUBMISSION_TO_REGISTRY - PENDING_REGISTRY_REPLY - PENDING_DOMAIN_UPDATE - REJECTED type: string Status14: title: Status14 enum: - CURRENT - PAST_DUE type: string description: Whether payments are past due Status15: title: Status15 enum: - ACTIVE - PENDING - CANCELED type: string description: Whether the Subscription is active or the specific non-active state status16: title: status16 enum: - ACTIVE - AWAITING_CLAIM_ACK - AWAITING_DOCUMENT_AFTER_TRANSFER - AWAITING_DOCUMENT_AFTER_UPDATE_ACCOUNT - AWAITING_DOCUMENT_UPLOAD - AWAITING_FAILED_TRANSFER_WHOIS_PRIVACY - AWAITING_PAYMENT - AWAITING_RENEWAL_TRANSFER_IN_COMPLETE - AWAITING_TRANSFER_IN_ACK - AWAITING_TRANSFER_IN_AUTH - AWAITING_TRANSFER_IN_AUTO - AWAITING_TRANSFER_IN_WHOIS - AWAITING_TRANSFER_IN_WHOIS_FIX - AWAITING_VERIFICATION_ICANN - AWAITING_VERIFICATION_ICANN_MANUAL - CANCELLED - CANCELLED_HELD - CANCELLED_REDEEMABLE - CANCELLED_TRANSFER - CONFISCATED - DISABLED_SPECIAL - EXCLUDED_INVALID_CLAIM_FIREHOSE - EXPIRED_REASSIGNED - FAILED_BACKORDER_CAPTURE - FAILED_DROP_IMMEDIATE_THEN_ADD - FAILED_PRE_REGISTRATION - FAILED_REDEMPTION - FAILED_REDEMPTION_REPORT - FAILED_REGISTRATION - FAILED_REGISTRATION_FIREHOSE - FAILED_RESTORATION_REDEMPTION_MOCK - FAILED_SETUP - FAILED_TRANSFER_IN - FAILED_TRANSFER_IN_BAD_STATUS - FAILED_TRANSFER_IN_REGISTRY - HELD_COURT_ORDERED - HELD_DISPUTED - HELD_EXPIRATION_PROTECTION - HELD_EXPIRED_REDEMPTION_MOCK - HELD_REGISTRAR_ADD - HELD_REGISTRAR_REMOVE - HELD_SHOPPER - HELD_TEMPORARY - LOCKED_ABUSE - LOCKED_COPYRIGHT - LOCKED_REGISTRY - LOCKED_SUPER - PARKED_AND_HELD - PARKED_EXPIRED - PARKED_VERIFICATION_ICANN - PENDING_ABORT_CANCEL_SETUP - PENDING_AGREEMENT_PRE_REGISTRATION - PENDING_APPLY_RENEWAL_CREDITS - PENDING_BACKORDER_CAPTURE - PENDING_BLOCKED_REGISTRY - PENDING_CANCEL_REGISTRANT_PROFILE - PENDING_COMPLETE_REDEMPTION_WITHOUT_RECEIPT - PENDING_COMPLETE_REGISTRANT_PROFILE - PENDING_COO - PENDING_COO_COMPLETE - PENDING_DNS - PENDING_DNS_ACTIVE - PENDING_DNS_INACTIVE - PENDING_DOCUMENT_VALIDATION - PENDING_DOCUMENT_VERIFICATION - PENDING_DROP_IMMEDIATE - PENDING_DROP_IMMEDIATE_THEN_ADD - PENDING_EPP_CREATE - PENDING_EPP_DELETE - PENDING_EPP_UPDATE - PENDING_ESCALATION_REGISTRY - PENDING_EXPIRATION - PENDING_EXPIRATION_RESPONSE - PENDING_EXPIRATION_SYNC - PENDING_EXPIRED_REASSIGNMENT - PENDING_EXPIRE_AUTO_ADD - PENDING_EXTEND_REGISTRANT_PROFILE - PENDING_FAILED_COO - PENDING_FAILED_EPP_CREATE - PENDING_FAILED_HELD - PENDING_FAILED_PURCHASE_PREMIUM - PENDING_FAILED_RECONCILE_FIREHOSE - PENDING_FAILED_REDEMPTION_WITHOUT_RECEIPT - PENDING_FAILED_RELEASE_PREMIUM - PENDING_FAILED_RENEW_EXPIRATION_PROTECTION - PENDING_FAILED_RESERVE_PREMIUM - PENDING_FAILED_SUBMIT_FIREHOSE - PENDING_FAILED_TRANSFER_ACK_PREMIUM - PENDING_FAILED_TRANSFER_IN_ACK_PREMIUM - PENDING_FAILED_TRANSFER_IN_PREMIUM - PENDING_FAILED_TRANSFER_PREMIUM - PENDING_FAILED_TRANSFER_SUBMIT_PREMIUM - PENDING_FAILED_UNLOCK_PREMIUM - PENDING_FAILED_UPDATE_API - PENDING_FRAUD_VERIFICATION - PENDING_FRAUD_VERIFIED - PENDING_GET_CONTACTS - PENDING_GET_HOSTS - PENDING_GET_NAME_SERVERS - PENDING_GET_STATUS - PENDING_HOLD_ESCROW - PENDING_HOLD_REDEMPTION - PENDING_LOCK_CLIENT_REMOVE - PENDING_LOCK_DATA_QUALITY - PENDING_LOCK_THEN_HOLD_REDEMPTION - PENDING_PARKING_DETERMINATION - PENDING_PARK_INVALID_WHOIS - PENDING_PARK_INVALID_WHOIS_REMOVAL - PENDING_PURCHASE_PREMIUM - PENDING_RECONCILE - PENDING_RECONCILE_FIREHOSE - PENDING_REDEMPTION - PENDING_REDEMPTION_REPORT - PENDING_REDEMPTION_REPORT_COMPLETE - PENDING_REDEMPTION_REPORT_SUBMITTED - PENDING_REDEMPTION_WITHOUT_RECEIPT - PENDING_REDEMPTION_WITHOUT_RECEIPT_MOCK - PENDING_RELEASE_PREMIUM - PENDING_REMOVAL - PENDING_REMOVAL_HELD - PENDING_REMOVAL_PARKED - PENDING_REMOVAL_UNPARK - PENDING_RENEWAL - PENDING_RENEW_EXPIRATION_PROTECTION - PENDING_RENEW_INFINITE - PENDING_RENEW_LOCKED - PENDING_RENEW_WITHOUT_RECEIPT - PENDING_REPORT_REDEMPTION_WITHOUT_RECEIPT - PENDING_RESERVE_PREMIUM - PENDING_RESET_VERIFICATION_ICANN - PENDING_RESPONSE_FIREHOSE - PENDING_RESTORATION - PENDING_RESTORATION_INACTIVE - PENDING_RESTORATION_REDEMPTION_MOCK - PENDING_RETRY_EPP_CREATE - PENDING_RETRY_HELD - PENDING_SEND_AUTH_CODE - PENDING_SETUP - PENDING_SETUP_ABANDON - PENDING_SETUP_AGREEMENT_LANDRUSH - PENDING_SETUP_AGREEMENT_SUNRISE2_A - PENDING_SETUP_AGREEMENT_SUNRISE2_B - PENDING_SETUP_AGREEMENT_SUNRISE2_C - PENDING_SETUP_AUTH - PENDING_SETUP_DNS - PENDING_SETUP_FAILED - PENDING_SETUP_REVIEW - PENDING_SETUP_SUNRISE - PENDING_SETUP_SUNRISE_PRE - PENDING_SETUP_SUNRISE_RESPONSE - PENDING_SUBMIT_FAILURE - PENDING_SUBMIT_FIREHOSE - PENDING_SUBMIT_HOLD_FIREHOSE - PENDING_SUBMIT_HOLD_LANDRUSH - PENDING_SUBMIT_HOLD_SUNRISE - PENDING_SUBMIT_LANDRUSH - PENDING_SUBMIT_RESPONSE_FIREHOSE - PENDING_SUBMIT_RESPONSE_LANDRUSH - PENDING_SUBMIT_RESPONSE_SUNRISE - PENDING_SUBMIT_SUCCESS_FIREHOSE - PENDING_SUBMIT_SUCCESS_LANDRUSH - PENDING_SUBMIT_SUCCESS_SUNRISE - PENDING_SUBMIT_SUNRISE - PENDING_SUBMIT_WAITING_LANDRUSH - PENDING_SUCCESS_PRE_REGISTRATION - PENDING_SUSPENDED_DATA_QUALITY - PENDING_TRANSFER_ACK_PREMIUM - PENDING_TRANSFER_IN - PENDING_TRANSFER_IN_ACK - PENDING_TRANSFER_IN_ACK_PREMIUM - PENDING_TRANSFER_IN_BAD_REGISTRANT - PENDING_TRANSFER_IN_CANCEL - PENDING_TRANSFER_IN_CANCEL_REGISTRY - PENDING_TRANSFER_IN_COMPLETE_ACK - PENDING_TRANSFER_IN_DELETE - PENDING_TRANSFER_IN_LOCK - PENDING_TRANSFER_IN_NACK - PENDING_TRANSFER_IN_NOTIFICATION - PENDING_TRANSFER_IN_PREMIUM - PENDING_TRANSFER_IN_RELEASE - PENDING_TRANSFER_IN_RESPONSE - PENDING_TRANSFER_IN_UNDERAGE - PENDING_TRANSFER_OUT - PENDING_TRANSFER_OUT_ACK - PENDING_TRANSFER_OUT_NACK - PENDING_TRANSFER_OUT_PREMIUM - PENDING_TRANSFER_OUT_UNDERAGE - PENDING_TRANSFER_OUT_VALIDATION - PENDING_TRANSFER_PREMIUM - PENDING_TRANSFER_PREMUIM - PENDING_TRANSFER_SUBMIT_PREMIUM - PENDING_UNLOCK_DATA_QUALITY - PENDING_UNLOCK_PREMIUM - PENDING_UPDATE - PENDING_UPDATED_REGISTRANT_DATA_QUALITY - PENDING_UPDATE_ACCOUNT - PENDING_UPDATE_API - PENDING_UPDATE_API_RESPONSE - PENDING_UPDATE_AUTH - PENDING_UPDATE_CONTACTS - PENDING_UPDATE_CONTACTS_PRIVACY - PENDING_UPDATE_DNS - PENDING_UPDATE_DNS_SECURITY - PENDING_UPDATE_ELIGIBILITY - PENDING_UPDATE_EPP_CONTACTS - PENDING_UPDATE_MEMBERSHIP - PENDING_UPDATE_OWNERSHIP - PENDING_UPDATE_OWNERSHIP_AUTH_AUCTION - PENDING_UPDATE_OWNERSHIP_HELD - PENDING_UPDATE_REGISTRANT - PENDING_UPDATE_REPO - PENDING_VALIDATION_DATA_QUALITY - PENDING_VERIFICATION_FRAUD - PENDING_VERIFICATION_STATUS - PENDING_VERIFY_REGISTRANT_DATA_QUALITY - RESERVED - RESERVED_PREMIUM - REVERTED - SUSPENDED_VERIFICATION_ICANN - TRANSFERRED_OUT - UNLOCKED_ABUSE - UNLOCKED_SUPER - UNPARKED_AND_UNHELD - UPDATED_OWNERSHIP - UPDATED_OWNERSHIP_HELD type: string status17: title: status17 enum: - ACTIVE - CANCELLED type: string statusGroup: title: statusGroup enum: - INACTIVE - PRE_REGISTRATION - REDEMPTION - RENEWABLE - VERIFICATION_ICANN - VISIBLE type: string Subcategory: title: Subcategory enum: - CHECKING_PERSONAL - CHECKING_BUSINESS - VISA - MASTER_CARD - AMEX - JCB - UNIONPAY type: string description: >- The subcategory of payment method used at the time of purchase. This field is only set for certain payment categories, such as ACH and CREDIT_CARD. Most common values are listed in the enum. theme: title: theme enum: - DARK - LIGHT type: string Type: title: Type enum: - A_RECORD - CHILD_ABUSE - CONTENT - FRAUD_WIRE - IP_BLOCK - MALWARE - NETWORK_ABUSE - PHISHING - SPAM type: string description: The type of abuse being reported Type1: title: Type1 enum: - A_RECORD - CHILD_ABUSE - CONTENT - FRAUD_WIRE - IP_BLOCK - MALWARE - NETWORK_ABUSE - PHISHING - SPAM type: string description: The type of abuse being reported. Type2: title: Type2 enum: - CERTIFICATE_ISSUED - CERTIFICATE_ORDER_CANCELED - CERTIFICATE_ORDER_CREATED - CERTIFICATE_REVOKED - DOMAIN_VALIDATION_COMPLETE - FRAUD_DETECTED - ORG_NAME_CHANGE - ORG_VALIDATION_COMPLETE - SAN_DROP type: string Type3: title: Type3 enum: - DV_SSL - DV_WILDCARD_SSL - EV_SSL - OV_CODE_SIGNING - OV_DRIVER_SIGNING - OV_SSL - OV_WILDCARD_SSL - UCC_DV_SSL - UCC_EV_SSL - UCC_OV_SSL type: string description: "Certificate type: \n * `DV_SSL` - (Domain Validated Secure Sockets Layer) SSL certificate validated using domain name only\n * `DV_WILDCARD_SSL` - SSL certificate containing subdomains which is validated using domain name only\n * `EV_SSL` - (Extended Validation) SSL certificate validated using organization information, domain name, business legal status, and other factors\n * `OV_CODE_SIGNING` - Code signing SSL certificate used by software developers to digitally sign apps. Validated using organization information\n * `OV_DRIVER_SIGNING` - Driver signing SSL certificate request used by software developers to digitally sign secure code for Windows hardware drivers. Validated using organization information\n * `OV_SSL` - SSL certificate validated using organization information and domain name\n * `OV_WILDCARD_SSL` - SSL certificate containing subdomains which is validated using organization information and domain name\n * `UCC_DV_SSL` - (Unified Communication Certificate) Multi domain SSL certificate validated using domain name only\n * `UCC_EV_SSL` - Multi domain SSL certificate validated using organization information, domain name, business legal status, and other factors\n * `UCC_OV_SSL` - Multi domain SSL certificate validated using organization information and domain name" Type5: title: Type5 enum: - DOMAIN_CONTROL_EMAIL - AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN - AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR - AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER - AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER - AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER - DOMAIN_ACCESS_EMAIL - DOMAIN_ACCESS_LETTER - DOMAIN_ZONE_CONTROL - MANUAL_DOMAIN_ACCESS_EMAIL - PREVIOUS_DOMAIN_ACCESS_EMAIL - REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER - REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL - REGISTRATION_AUTHORITY_OVERRIDE - REGISTRATION_AUTHORITY_WEBSITE_CONTROL - CUSTOMER_OWNED - WEBSITE_CONTROL type: string description: "Domain verification type: \n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN` - Domain verified using domain control verification email sent to admin@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR` - Domain verified using domain control verification email sent to administrator@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER` - Domain verified using domain control verification email sent to hostmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER` - Domain verified using domain control verification email sent to postmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER` - Domain verified using domain control verification email sent to webmaster@\n * `DOMAIN_ACCESS_EMAIL` - Domain verified using a domain access email\n * `DOMAIN_ACCESS_LETTER` - Customer completed a domain access letter which was used for domain verification\n * `DOMAIN_CONTROL_EMAIL` - Domain verified using HTML file or DNS zone file text value\n * `DOMAIN_ZONE_CONTROL` - DNS zone file containing a pre-generated text value used for domain verification\n * `MANUAL_DOMAIN_ACCESS_EMAIL` - DAE sent to an email address manually entered by a rep\n * `PREVIOUS_DOMAIN_ACCESS_EMAIL` - Customers domain access email for a prior certificate request was used for domain verification\n * `REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER` - Representative reviewed a customer provided domain access letter and verified domain\n * `REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL` - Representative verified domain using a manual domain zone control check\n * `REGISTRATION_AUTHORITY_OVERRIDE` - Representative verified domain using alternative methods\n * `REGISTRATION_AUTHORITY_WEBSITE_CONTROL` - Representative verified domain using a manual website control check\n * `CUSTOMER_OWNED` - Validated customer account information used for domain control verification\n * `WEBSITE_CONTROL` - HTML file in root website directory containing pre-generated value used for domain control verification" Type6: title: Type6 enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CONTACT_CREATE - CONTACT_DELETE - CONTACT_UPDATE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - HOST_CREATE - HOST_DELETE - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_CANCEL - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT type: string description: "The type of action being performed
  • AUTH_CODE_PURCHASE - Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode.
  • AUTH_CODE_REGENERATE - Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode
  • AUTO_RENEWAL - A Domain Auto Renew is in progress.
  • BACKORDER_PURCHASE - Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase.
  • BACKORDER_DELETE - Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}.
  • BACKORDER_UPDATE - Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}.
  • CONTACT_CREATE - Request to create a contact via POST /v2/customers/{customerId}/domains/contacts.
  • CONTACT_DELETE - Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId}
  • CONTACT_UPDATE - Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId}
  • DNS_VERIFICATION - Domain requires zone file setup.
  • DNSSEC_CREATE - Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
  • DNSSEC_DELETE - Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
  • DOMAIN_DELETE - Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain}
  • DOMAIN_UPDATE - Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain}
  • DOMAIN_UPDATE_CONTACTS -Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts
  • DOMAIN_UPDATE_NAME_SERVERS - Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers
  • EXPIRY - A Domain Expiration is in progress.
  • HOST_CREATE - Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
  • HOST_DELETE - Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
  • ICANN_VERIFICATION - Domain requires registrant verification for Icann.
  • PREMIUM - Premium Domain domain sale is in progress.
  • PRIVACY_PURCHASE - Request to purchase privacy for a domain via POST /v2/customers/{customerId}/domains/{domain}/privacy/purchase
  • PRIVACY_DELETE - Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy
  • REDEEM - Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem
  • REGISTER - Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register
  • RENEW - Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew
  • RENEW_UNDO - Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew
  • TRADE - A domain trade request is in progress
  • TRADE_CANCEL - Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel
  • TRADE_PURCHASE - Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase
  • TRADE_PURCHASE_AUTH_TEXT_MESSAGE - Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage
  • TRADE_RESEND_AUTH_EMAIL - Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail
  • TRANSFER - Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer
  • TRANSFER_IN - A domain transfer in request is in progress.
  • TRANSFER_IN_CANCEL - Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel
  • TRANSFER_OUT - A domain transfer out request is in progress.
  • TRANSFER_OUT_ACCEPT - Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept
  • TRANSFER_OUT_REJECT - Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject
  • TRANSFER_OUT_REQUESTED - Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut
  • TRANSIT - Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit
" Type7: title: Type7 enum: - A - AAAA - CNAME - MX - NS - SOA - SRV - TXT type: string Type8: title: Type8 enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CONTACT_CREATE - CONTACT_DELETE - CONTACT_UPDATE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - HOST_CREATE - HOST_DELETE - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_CANCEL - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT type: string description: The type of action the notification relates to Type9: title: Type9 enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CONTACT_CREATE - CONTACT_DELETE - CONTACT_UPDATE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - HOST_CREATE - HOST_DELETE - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_CANCEL - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT type: string description: The notification type Type10: title: Type10 enum: - MASKED - REDIRECT_PERMANENT - REDIRECT_TEMPORARY type: string description: "The type of fowarding to implement
  • MASKED - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
  • REDIRECT_PERMANENT* - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.
  • REDIRECT_TEMPORARY - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.
" Type12: title: Type12 enum: - API - REGISTRY - UI type: string description: "The type of maintenance being performed
  • API - Programmatic Api components.
  • REGISTRY - The underlying Registry providing the tld(s).
  • UI - User Interface components.
" Type14: title: Type14 enum: - COUNTRY_CODE - GENERIC type: string description: Type of the top-level domain type15: title: type15 enum: - A_RECORD - CHILD_ABUSE - CONTENT - FRAUD_WIRE - IP_BLOCK - MALWARE - NETWORK_ABUSE - PHISHING - SPAM type: string type18: title: type18 enum: - A - AAAA - CNAME - MX - SRV - TXT type: string type20: title: type20 enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - MIGRATE - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN_CANCEL - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT type: string type21: title: type21 enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_CANCEL - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT type: string type22: title: type22 enum: - AUTH_CODE_PURCHASE - AUTH_CODE_REGENERATE - AUTO_RENEWAL - BACKORDER - BACKORDER_PURCHASE - BACKORDER_DELETE - BACKORDER_UPDATE - CONTACT_CREATE - CONTACT_DELETE - CONTACT_UPDATE - DNS_VERIFICATION - DNSSEC_CREATE - DNSSEC_DELETE - DOMAIN_DELETE - DOMAIN_UPDATE - DOMAIN_UPDATE_CONTACTS - DOMAIN_UPDATE_NAME_SERVERS - EXPIRY - HOST_CREATE - HOST_DELETE - ICANN_VERIFICATION - MIGRATE - MIGRATE_IN - PREMIUM - PRIVACY_PURCHASE - PRIVACY_DELETE - REDEEM - REGISTER - RENEW - RENEW_UNDO - TRADE - TRADE_CANCEL - TRADE_PURCHASE - TRADE_PURCHASE_AUTH_TEXT_MESSAGE - TRADE_RESEND_AUTH_EMAIL - TRANSFER - TRANSFER_IN - TRANSFER_IN_CANCEL - TRANSFER_OUT - TRANSFER_OUT_ACCEPT - TRANSFER_OUT_REJECT - TRANSFER_OUT_REQUESTED - TRANSIT type: string type23: title: type23 enum: - AUTO_RENEWAL - BACKORDER - BACKORDER_PURCHASE - EXPIRY - PREMIUM - PRIVACY_PURCHASE - REDEEM - REGISTER - RENEW - TRADE - TRANSFER type: string Usage: title: Usage enum: - COMMON_NAME - SUBJECT_ALTERNATIVE_NAME type: string description: Type of domain name used for domain verification tags: - name: Abuse description: '' - name: Aftermarket description: '' - name: Agreements description: '' - name: Certificates description: '' - name: Countries description: '' - name: Domains description: '' - name: Orders description: '' - name: Parking description: '' - name: Shoppers description: '' - name: Subscriptions description: '' - name: Certificate description: '' - name: Actions description: '' - name: Notifications description: ''