From e2e9445754340df3a7394aed0a2e2c33459ef458 Mon Sep 17 00:00:00 2001 From: Jeffrey Aven Date: Sat, 16 Dec 2023 14:23:32 +1100 Subject: [PATCH] added godaddy provider --- .../src/godaddy/v00.00.00000/provider.yaml | 90 + .../godaddy/v00.00.00000/services/abuse.yaml | 394 + .../v00.00.00000/services/aftermarket.yaml | 444 + .../v00.00.00000/services/agreements.yaml | 263 + .../v00.00.00000/services/certificates.yaml | 1788 ++++ .../v00.00.00000/services/countries.yaml | 296 + .../v00.00.00000/services/domains.yaml | 7600 +++++++++++++++++ .../godaddy/v00.00.00000/services/orders.yaml | 1149 +++ .../v00.00.00000/services/shoppers.yaml | 647 ++ .../v00.00.00000/services/subscriptions.yaml | 1121 +++ 10 files changed, 13792 insertions(+) create mode 100644 providers/src/godaddy/v00.00.00000/provider.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/abuse.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/aftermarket.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/agreements.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/certificates.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/countries.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/domains.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/orders.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/shoppers.yaml create mode 100644 providers/src/godaddy/v00.00.00000/services/subscriptions.yaml diff --git a/providers/src/godaddy/v00.00.00000/provider.yaml b/providers/src/godaddy/v00.00.00000/provider.yaml new file mode 100644 index 00000000..a79542f4 --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/provider.yaml @@ -0,0 +1,90 @@ +id: godaddy +name: godaddy +version: v00.00.00000 +providerServices: + abuse: + id: 'abuse:v00.00.00000' + name: abuse + preferred: true + service: + $ref: godaddy/v00.00.00000/services/abuse.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + aftermarket: + id: 'aftermarket:v00.00.00000' + name: aftermarket + preferred: true + service: + $ref: godaddy/v00.00.00000/services/aftermarket.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + agreements: + id: 'agreements:v00.00.00000' + name: agreements + preferred: true + service: + $ref: godaddy/v00.00.00000/services/agreements.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + certificates: + id: 'certificates:v00.00.00000' + name: certificates + preferred: true + service: + $ref: godaddy/v00.00.00000/services/certificates.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + countries: + id: 'countries:v00.00.00000' + name: countries + preferred: true + service: + $ref: godaddy/v00.00.00000/services/countries.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + domains: + id: 'domains:v00.00.00000' + name: domains + preferred: true + service: + $ref: godaddy/v00.00.00000/services/domains.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + orders: + id: 'orders:v00.00.00000' + name: orders + preferred: true + service: + $ref: godaddy/v00.00.00000/services/orders.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + shoppers: + id: 'shoppers:v00.00.00000' + name: shoppers + preferred: true + service: + $ref: godaddy/v00.00.00000/services/shoppers.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' + subscriptions: + id: 'subscriptions:v00.00.00000' + name: subscriptions + preferred: true + service: + $ref: godaddy/v00.00.00000/services/subscriptions.yaml + title: Api.Godaddy.Com + version: v00.00.00000 + description: ! '' +config: + auth: + credentialsenvvar: GODADDY_API_KEY + type: api_key + valuePrefix: 'sso-key ' diff --git a/providers/src/godaddy/v00.00.00000/services/abuse.yaml b/providers/src/godaddy/v00.00.00000/services/abuse.yaml new file mode 100644 index 00000000..36397965 --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/abuse.yaml @@ -0,0 +1,394 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 1.0.0 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/abuse/tickets: + get: + parameters: + - description: The type of abuse. + in: query + name: type + required: false + schema: + enum: + - A_RECORD + - CHILD_ABUSE + - CONTENT + - FRAUD_WIRE + - IP_BLOCK + - MALWARE + - NETWORK_ABUSE + - PHISHING + - SPAM + type: string + - description: Is this abuse ticket closed? + in: query + name: closed + required: false + schema: + default: false + type: boolean + - description: The domain name or ip address abuse originated from + in: query + name: sourceDomainOrIp + required: false + schema: + format: host-name-or-ip-address + type: string + - description: 'The brand/company the abuse is targeting. ie: brand name/bank name' + in: query + name: target + required: false + schema: + type: string + - description: The earliest abuse ticket creation date to pull abuse tickets for + in: query + name: createdStart + required: false + schema: + format: iso-datetime + type: string + - description: The latest abuse ticket creation date to pull abuse tickets for + in: query + name: createdEnd + required: false + schema: + format: iso-datetime + type: string + - description: Number of abuse ticket numbers to return. + in: query + name: limit + required: false + schema: + default: 100 + format: integer-positive + maximum: 100 + type: integer + - description: The earliest result set record number to pull abuse tickets for + in: query + name: offset + required: false + schema: + default: 0 + format: integer-positive + type: integer + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AbuseTicketList' + description: Success + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Error + security: + - sso_key: [] + operationId: getTickets + description: List all abuse tickets ids that match user provided filters + post: + responses: + '200': + description: No response was specified + '201': + content: + application/json: + schema: + $ref: '#/components/schemas/AbuseTicketId' + description: Success + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Error + security: + - sso_key: [] + operationId: createTicket + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/AbuseTicketCreate' + description: The endpoint which allows the Reporter to create a new abuse ticket + required: true + description: Create a new abuse ticket + '/v1/abuse/tickets/{ticket_id}': + get: + parameters: + - description: A unique abuse ticket identifier + in: path + name: ticket_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/AbuseTicket' + description: Success + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Invalid ticket id provided + security: + - sso_key: [] + operationId: getTicketInfo + description: Return the abuse ticket data for a given ticket id +components: + schemas: + AbuseTicket: + description: 'The associated fields returned, given a unique abuse ticket id' + properties: + closed: + default: false + description: Is this abuse ticket closed? + type: boolean + closedAt: + description: The date the abuse ticket was closed + format: iso-datetime + type: string + createdAt: + description: The date the abuse ticket was created + format: iso-datetime + type: string + domainIp: + description: The domain or IP the suspected abuse was reported against + type: string + reporter: + description: The shopper id of the person who reported the suspected abuse + type: string + source: + description: The single URL or IP the suspected abuse was reported against + type: string + target: + description: The company the suspected abuse is targeting + type: string + ticketId: + description: Abuse ticket ID + type: string + type: + description: The type of abuse being reported + enum: + - A_RECORD + - CHILD_ABUSE + - CONTENT + - FRAUD_WIRE + - IP_BLOCK + - MALWARE + - NETWORK_ABUSE + - PHISHING + - SPAM + type: string + required: + - ticketId + - reporter + - domainIp + - closed + - type + - target + - source + - createdAt + - closedAt + type: object + AbuseTicketCreate: + properties: + info: + description: 'Additional information that may assist the abuse investigator. ie: server logs or email headers/body for SPAM' + type: string + infoUrl: + description: Reporter URL if housing additional information that may assist the abuse investigator + format: url + type: string + intentional: + default: false + description: Do you believe this is intentional abuse by the domain holder? + type: boolean + proxy: + description: 'The Proxy information required to view the abuse being reported. ie: Specific IP used, or country of IP viewing from' + type: string + source: + description: 'The URL or IP where live abuse content is located at. ie: https://www.example.com/bad_stuff/bad.php' + type: string + target: + description: 'The brand/company the abuse is targeting. ie: brand name/bank name' + type: string + type: + description: The type of abuse being reported. + enum: + - A_RECORD + - CHILD_ABUSE + - CONTENT + - FRAUD_WIRE + - IP_BLOCK + - MALWARE + - NETWORK_ABUSE + - PHISHING + - SPAM + type: string + type: object + AbuseTicketId: + description: The primary key of a newly created abuse ticket + properties: + ticketId: + description: Abuse ticket ID + type: string + required: + - ticketId + type: object + AbuseTicketList: + properties: + pagination: + $ref: '#/components/schemas/Pagination' + ticketIds: + description: A list of abuse ticket ids originated by this reporter. + items: + type: string + type: array + required: + - ticketIds + type: object + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + stack: + 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.' + items: + type: string + minItems: 1 + type: array + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + description: 1) JSONPath referring to the field within the data containing an erroror2) JSONPath referring to an object containing an error + format: json-path + type: string + pathRelated: + description: JSONPath referring to the field on the object referenced by `path` containing an error + format: json-path + type: string + required: + - path + - code + type: object + Pagination: + properties: + first: + description: Optional link to first list of results + type: string + last: + description: Optional link to last list of results + type: string + next: + description: Optional link to next list of results + type: string + previous: + description: Optional link to previous list of results + type: string + total: + description: Number of records available + type: integer + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + tickets: + id: godaddy.abuse.tickets + name: tickets + title: Tickets + methods: + get_tickets: + operation: + $ref: '#/paths/~1v1~1abuse~1tickets/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_ticket: + operation: + $ref: '#/paths/~1v1~1abuse~1tickets/post' + response: + mediaType: application/json + openAPIDocKey: '200' + get_ticket_info: + operation: + $ref: '#/paths/~1v1~1abuse~1tickets~1{ticket_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tickets/methods/get_ticket_info' + - $ref: '#/components/x-stackQL-resources/tickets/methods/get_tickets' + insert: + - $ref: '#/components/x-stackQL-resources/tickets/methods/create_ticket' + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/aftermarket.yaml b/providers/src/godaddy/v00.00.00000/services/aftermarket.yaml new file mode 100644 index 00000000..1253515e --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/aftermarket.yaml @@ -0,0 +1,444 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 0.0.0 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/aftermarket/listings: + delete: + parameters: + - description: A comma separated list of domain names + in: query + name: domains + required: true + schema: + items: + type: string + type: array + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + application/json: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + application/xml: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + text/javascript: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + text/xml: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: "\tRequired parameters must be specified in correct format" + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: deleteListings + description: Remove listings from GoDaddy Auction + /v1/aftermarket/listings/expiry: + post: + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + application/json: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + application/xml: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + text/javascript: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + text/xml: + schema: + $ref: '#/components/schemas/AftermarketListingAction' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: "\tToo many Listings provided" + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: addExpiryListings + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/AftermarketListingExpiryCreate' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/AftermarketListingExpiryCreate' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/AftermarketListingExpiryCreate' + type: array + description: An array of expiry listings to be loaded + required: true + description: Add expiry listings into GoDaddy Auction +components: + schemas: + AftermarketListingAction: + properties: + listingActionId: + description: Action Id + type: integer + required: + - listingActionId + type: object + AftermarketListingExpiryCreate: + properties: + domain: + description: Domain name + type: string + expiresAt: + description: Date when the domain expires + format: iso-datetime + type: string + losingRegistrarId: + default: 1 + description: Losing registrar id for the domain + minimum: 1 + type: integer + pageViewsMonthly: + description: Monthly traffic page view for the domain + type: integer + revenueMonthly: + description: Monthly parking revenue (in USD micro unit) for the domain + type: integer + required: + - domain + - expiresAt + - losingRegistrarId + type: object + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + 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` + format: json-path + type: string + pathRelated: + description: 'JSONPath referring to a field containing an error, which is referenced by `path`' + format: json-path + type: string + required: + - path + - code + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + required: + - retryAfterSec + - code + type: object + expiry: + properties: + id: + format: double + type: number + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + listings: + id: godaddy.aftermarket.listings + name: listings + title: Listings + methods: + delete_listings: + operation: + $ref: '#/paths/~1v1~1aftermarket~1listings/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/listings/methods/delete_listings' + listings_expiry: + id: godaddy.aftermarket.listings_expiry + name: listings_expiry + title: Listings Expiry + methods: + add_expiry_listings: + operation: + $ref: '#/paths/~1v1~1aftermarket~1listings~1expiry/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/agreements.yaml b/providers/src/godaddy/v00.00.00000/services/agreements.yaml new file mode 100644 index 00000000..b1c80e81 --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/agreements.yaml @@ -0,0 +1,263 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 1.0.0 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/agreements: + get: + parameters: + - description: 'PrivateLabelId to operate as, if different from JWT' + in: header + name: X-Private-Label-Id + required: false + schema: + type: integer + - description: Unique identifier of the Market used to retrieve/translate Legal Agreements + in: header + name: X-Market-Id + required: false + schema: + default: en-US + format: bcp-47 + type: string + - description: Keys for Agreements whose details are to be retrieved + in: query + name: keys + required: true + schema: + items: + type: string + type: array + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: get + description: Retrieve Legal Agreements for provided agreements keys +components: + schemas: + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + 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` + format: json-path + type: string + pathRelated: + description: 'JSONPath referring to a field containing an error, which is referenced by `path`' + format: json-path + type: string + required: + - path + - code + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + required: + - retryAfterSec + - code + type: object + LegalAgreement: + properties: + agreementKey: + description: Unique identifier for the legal agreement + type: string + content: + description: 'Contents of the legal agreement, suitable for embedding' + type: string + title: + description: Title of the legal agreement + type: string + url: + description: URL to a page containing the legal agreement + format: url + type: string + required: + - agreementKey + - title + - content + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + agreements: + id: godaddy.agreements.agreements + name: agreements + title: Agreements + methods: + get: + operation: + $ref: '#/paths/~1v1~1agreements/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/agreements/methods/get' + insert: [] + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/certificates.yaml b/providers/src/godaddy/v00.00.00000/services/certificates.yaml new file mode 100644 index 00000000..437242ff --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/certificates.yaml @@ -0,0 +1,1788 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: '1' +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/certificates: + post: + parameters: + - description: Setting locale for communications such as emails and error messages + in: header + name: X-Market-Id + required: false + schema: + default: Default locale for shopper account + type: string + responses: + '200': + description: No response was specified + '202': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateIdentifier' + description: Request was successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow renew + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: '`csr` is invalid' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateCreate' + description: The certificate order information + required: true + summary: Create a pending order for certificate + /v1/certificates/validate: + post: + parameters: + - description: Setting locale for communications such as emails and error messages + in: header + name: X-Market-Id + required: false + schema: + default: Default locale for shopper account + type: string + responses: + '200': + description: No response was specified + '204': + description: Request validated successfully + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow renew + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: '`csr` is invalid' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: certificate_validate + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateCreate' + description: The certificate order info + required: true + summary: Validate a pending order for certificate + description: Validate a pending order for certificate + '/v1/certificates/{certificate_id}': + get: + parameters: + - description: Certificate id to lookup + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Certificate' + description: Certificate details retrieved + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + summary: Retrieve certificate details + '/v1/certificates/{certificate_id}/actions': + get: + parameters: + - description: Certificate id to register for callback + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateAction' + description: Action retrieval successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + description: This method is used to retrieve all stateful actions relating to a certificate lifecycle. + operationId: certificate_action_retrieve + summary: Retrieve all certificate actions + '/v1/certificates/{certificate_id}/callback': + delete: + parameters: + - description: Certificate id to unregister callback + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Callback removed + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + description: Unregister the callback for a particular certificate. + operationId: certificate_callback_delete + summary: Unregister system callback + get: + parameters: + - description: Certificate id to register for stateful action callback + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateCallback' + description: Callback registered + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + description: This method is used to retrieve the registered callback url for a certificate. + operationId: certificate_callback_get + summary: Retrieve system stateful action callback url + put: + parameters: + - description: Certificate id to register/replace for callback + in: path + name: certificate_id + required: true + schema: + type: string + - description: Callback url registered/replaced to receive stateful actions + in: query + name: callbackUrl + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Callback replaced/registered + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Callback url is malformed + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + summary: Register of certificate action callback + '/v1/certificates/{certificate_id}/cancel': + post: + parameters: + - description: Certificate id to cancel + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Certificate order has been canceled + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow cancel + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + description: Use the cancel call to cancel a pending certificate order. + operationId: certificate_cancel + summary: Cancel a pending certificate + '/v1/certificates/{certificate_id}/download': + get: + parameters: + - description: Certificate id to download + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateBundle' + description: Certificate retrieved + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow download + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: certificate_download + summary: Download certificate + description: Download certificate + '/v1/certificates/{certificate_id}/reissue': + post: + parameters: + - description: Certificate id to reissue + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '202': + description: Reissue request created + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow reissue + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Delay revocation exceeds maximum + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateReissue' + description: The reissue request info + required: true + summary: Reissue active certificate + '/v1/certificates/{certificate_id}/renew': + post: + parameters: + - description: Certificate id to renew + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '202': + description: Renew request created + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow renew + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: '`csr` is invalid' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateRenew' + description: The renew request info + required: true + summary: Renew active certificate + '/v1/certificates/{certificate_id}/revoke': + post: + parameters: + - description: Certificate id to revoke + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Certificate Revoked + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow revoke + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateRevoke' + description: The certificate revocation request + required: true + summary: Revoke active certificate + '/v1/certificates/{certificate_id}/siteSeal': + get: + parameters: + - description: Certificate id + in: path + name: certificate_id + required: true + schema: + type: string + - 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.' + in: query + name: theme + required: false + schema: + default: LIGHT + enum: + - DARK + - LIGHT + type: string + - 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.' + in: query + name: locale + required: false + schema: + default: en + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CertificateSiteSeal' + description: Site seal retrieved + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow seal + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: '''locale'' is invalid' + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + summary: Get Site seal + '/v1/certificates/{certificate_id}/verifyDomainControl': + post: + parameters: + - description: Certificate id to lookup + in: path + name: certificate_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Domain control was successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate id not found + '409': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Certificate state does not allow domain control + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + summary: Check Domain Control +components: + schemas: + Certificate: + properties: + certificateId: + description: The unique identifier of the certificate request. Only present if no errors returned + type: string + commonName: + description: Common name of certificate + type: string + contact: + $ref: '#/components/schemas/CertificateContact' + description: Requestor contact information + createdAt: + description: The date the certificate was ordered. + format: iso-datetime + type: string + deniedReason: + description: Only present if certificate order has been denied + type: string + organization: + $ref: '#/components/schemas/CertificateOrganization' + description: Organization Name in certificate + period: + description: Validity period of order. Specified in years + type: integer + productType: + description: Certificate product type + 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 + progress: + description: Percentage of completion for certificate vetting + type: integer + revokedAt: + description: The revocation date of certificate (if revoked). + format: iso-datetime + type: string + rootType: + description: Root Type + enum: + - GODADDY_SHA_1 + - GODADDY_SHA_2 + - STARFIELD_SHA_1 + - STARFIELD_SHA_2 + type: string + serialNumber: + description: Serial number of certificate (if issued or revoked) + type: string + serialNumberHex: + description: Hexadecmial format for Serial number of certificate(if issued or revoked) + type: string + slotSize: + description: 'Number of subject alternative names(SAN) to be included in certificate ' + enum: + - FIVE + - TEN + - FIFTEEN + - TWENTY + - THIRTY + - FOURTY + - FIFTY + - ONE_HUNDRED + type: string + status: + description: Status of certificate + enum: + - PENDING_ISSUANCE + - ISSUED + - REVOKED + - CANCELED + - DENIED + - PENDING_REVOCATION + - PENDING_REKEY + - UNUSED + - EXPIRED + type: string + subjectAlternativeNames: + description: Contains subject alternative names set + items: + $ref: '#/components/schemas/SubjectAlternativeNameDetails' + type: array + validEnd: + description: The end date of the certificate's validity (if issued or revoked). + format: iso-datetime + type: string + validStart: + description: The start date of the certificate's validity (if issued or revoked). + format: iso-datetime + type: string + required: + - certificateId + - status + - contact + - period + - createdAt + - productType + type: object + CertificateAction: + properties: + createdAt: + description: Date action created + format: iso-datetime + type: string + type: + 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 + required: + - type + - createdAt + type: object + CertificateAddress: + properties: + address1: + description: Address line 1 of organization address + type: string + address2: + description: Address line 2 of organization address + type: string + city: + description: City/Locality of organization address + type: string + country: + description: Two character country code of organization + 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 + format: iso-country-code + type: string + postalCode: + description: Postal code of organization address + type: string + state: + description: Full name of State/Province/Territory of organization address + type: string + required: + - address1 + - country + type: object + CertificateBundle: + properties: + pems: + $ref: '#/components/schemas/PEMCertificates' + description: Certificates in PEM format + serialNumber: + description: Serial number of certificate requested + type: string + required: + - serialNumber + - pems + type: object + CertificateCallback: + properties: + callbackUrl: + description: Callback url registered to receive stateful actions + type: string + required: + - callbackUrl + type: object + CertificateContact: + properties: + email: + description: Email address of requestor contact + type: string + jobTitle: + description: Only used for EVSSL. Job title of requestor contact + type: string + nameFirst: + description: First name of requestor contact + type: string + nameLast: + description: Last name of requestor contact + type: string + nameMiddle: + description: Middle initial of requestor contact + type: string + phone: + description: Phone number for requestor contact + type: string + suffix: + description: Suffix of requestor contact + type: string + required: + - nameFirst + - nameLast + - email + - phone + type: object + CertificateCreate: + properties: + callbackUrl: + description: Required if client would like to receive stateful actions via callback during certificate lifecyle + type: string + commonName: + description: 'Name to be secured in certificate. If provided, CN field in CSR will be ignored.' + type: string + contact: + $ref: '#/components/schemas/CertificateContact' + description: Requestor contact information + csr: + description: Certificate Signing Request + type: string + intelVPro: + default: false + description: Only used for OV + type: boolean + organization: + $ref: '#/components/schemas/CertificateOrganizationCreate' + description: 'Required for EVSSL, OVSSL, CS, and DS' + period: + description: Number of years for certificate validity period + type: integer + productType: + description: Type of product requesting a certificate. Only required non-renewal + 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 + rootType: + default: STARFIELD_SHA_2 + 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' + enum: + - GODADDY_SHA_1 + - GODADDY_SHA_2 + - STARFIELD_SHA_1 + - STARFIELD_SHA_2 + type: string + slotSize: + description: 'Number of subject alternative names(SAN) to be included in certificate ' + enum: + - FIVE + - TEN + - FIFTEEN + - TWENTY + - THIRTY + - FOURTY + - FIFTY + - ONE_HUNDRED + type: string + subjectAlternativeNames: + description: Subject Alternative names. Collection of subjectAlternativeNames to be included in certificate. + items: + type: string + type: array + uniqueItems: true + required: + - csr + - productType + - period + - contact + type: object + CertificateIdentifier: + properties: + certificateId: + description: The unique identifier of the certificate request. Only present if verified. + type: string + required: + - certificateId + type: object + CertificateOrganization: + properties: + address: + $ref: '#/components/schemas/CertificateAddress' + description: Organization presence address + assumedName: + description: Only for EVSSL. The DBA(does business as) name for the organization. + type: string + jurisdictionOfIncorporation: + $ref: '#/components/schemas/JurisdictionOfIncorporation' + description: Jurisdiction of Incorporation + name: + description: Name of organization that owns common name + type: string + phone: + description: Phone number for organization + type: string + registrationAgent: + description: Only for EVSSL. + type: string + registrationNumber: + description: Only for EVSSL. + type: string + required: + - name + - phone + - address + type: object + CertificateOrganizationCreate: + properties: + address: + $ref: '#/components/schemas/CertificateAddress' + description: Organization presence address + assumedName: + description: Only for EVSSL. The DBA(does business as) name for the organization. + type: string + name: + description: Name of organization that owns common name + type: string + phone: + description: Phone number for organization + type: string + registrationAgent: + description: Only for EVSSL. + type: string + registrationNumber: + description: Only for EVSSL. + type: string + required: + - name + - phone + type: object + CertificateReissue: + properties: + callbackUrl: + description: Required if client would like to receive stateful action via callback during certificate lifecyle + type: string + commonName: + default: Existing common name + description: The common name of certificate to be secured + type: string + csr: + default: Existing CSR + description: Certificate Signing Request. + type: string + delayExistingRevoke: + default: 72 + description: 'In hours, time to delay revoking existing certificate after issuance of new certificate. If revokeExistingCertOnIssuance is enabled, this value will be ignored' + maximum: 168 + type: integer + rootType: + default: GODADDY_SHA_1 + 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' + enum: + - GODADDY_SHA_1 + - GODADDY_SHA_2 + - STARFIELD_SHA_1 + - STARFIELD_SHA_2 + type: string + subjectAlternativeNames: + description: Only used for UCC products. An array of subject alternative names to include in certificate. + items: + type: string + type: array + uniqueItems: true + type: object + CertificateRenew: + properties: + callbackUrl: + description: Required if client would like to receive stateful actions via callback during certificate lifecyle + type: string + commonName: + default: Existing common name + description: The common name of certificate to be secured + type: string + csr: + default: Existing CSR + description: Certificate Signing Request. + type: string + period: + default: 0 + description: 'Number of years for certificate validity period, if different from previous certificate' + type: integer + rootType: + default: GODADDY_SHA_1 + 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' + enum: + - GODADDY_SHA_1 + - GODADDY_SHA_2 + - STARFIELD_SHA_1 + - STARFIELD_SHA_2 + type: string + subjectAlternativeNames: + 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. + items: + type: string + type: array + uniqueItems: true + type: object + CertificateRevoke: + properties: + reason: + description: Reason for revocation + enum: + - AFFILIATION_CHANGED + - CESSATION_OF_OPERATION + - KEY_COMPROMISE + - PRIVILEGE_WITHDRAWN + - SUPERSEDED + type: string + required: + - reason + type: object + CertificateSiteSeal: + properties: + html: + description: Certificate Seal HTML + type: string + required: + - html + type: object + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: Description of the error + type: string + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: Description of the problem with the contents of the field + type: string + path: + description: JSONPath referring to the field within the submitted data containing an error + format: json-path + type: string + required: + - path + - code + type: object + JurisdictionOfIncorporation: + properties: + city: + type: string + country: + format: iso-country-code + type: string + county: + type: string + state: + type: string + required: + - country + type: object + PEMCertificates: + properties: + certificate: + description: End entity certificate in PEM format + type: string + cross: + description: CA Cross Intermediate certificate in PEM format + type: string + intermediate: + description: CA Signing Intermediate certificate in PEM format + type: string + root: + description: CA Root certificate in PEM format + type: string + required: + - certificate + type: object + SubjectAlternativeNameDetails: + properties: + status: + description: Total number of page results + enum: + - PENDING + - INVALID + - COMPLETED + - FRAUD + type: string + subjectAlternativeName: + description: Subject alternative name to be included in certificate + type: string + required: + - subjectAlternativeName + - status + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + certificates: + id: godaddy.certificates.certificates + name: certificates + title: Certificates + methods: + certificate_create: + operation: + $ref: '#/paths/~1v1~1certificates/post' + response: + mediaType: application/json + openAPIDocKey: '200' + certificate_get: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/certificates/methods/certificate_get' + insert: + - $ref: '#/components/x-stackQL-resources/certificates/methods/certificate_create' + update: [] + delete: [] + validate: + id: godaddy.certificates.validate + name: validate + title: Validate + methods: + certificate_validate: + operation: + $ref: '#/paths/~1v1~1certificates~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + actions: + id: godaddy.certificates.actions + name: actions + title: Actions + methods: + certificate_action_retrieve: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1actions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/actions/methods/certificate_action_retrieve' + insert: [] + update: [] + delete: [] + callback: + id: godaddy.certificates.callback + name: callback + title: Callback + methods: + certificate_callback_delete: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1callback/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + certificate_callback_get: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1callback/get' + response: + mediaType: application/json + openAPIDocKey: '200' + certificate_callback_replace: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1callback/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/callback/methods/certificate_callback_get' + insert: [] + update: [] + delete: + - $ref: '#/components/x-stackQL-resources/callback/methods/certificate_callback_delete' + cancel: + id: godaddy.certificates.cancel + name: cancel + title: Cancel + methods: + certificate_cancel: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1cancel/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + download: + id: godaddy.certificates.download + name: download + title: Download + methods: + certificate_download: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1download/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + reissue: + id: godaddy.certificates.reissue + name: reissue + title: Reissue + methods: + certificate_reissue: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1reissue/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + renew: + id: godaddy.certificates.renew + name: renew + title: Renew + methods: + certificate_renew: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1renew/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + revoke: + id: godaddy.certificates.revoke + name: revoke + title: Revoke + methods: + certificate_revoke: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1revoke/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + site_seal: + id: godaddy.certificates.site_seal + name: site_seal + title: Site Seal + methods: + certificate_siteseal_get: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1siteSeal/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/site_seal/methods/certificate_siteseal_get' + insert: [] + update: [] + delete: [] + verify_domain_control: + id: godaddy.certificates.verify_domain_control + name: verify_domain_control + title: Verify Domain Control + methods: + certificate_verifydomaincontrol: + operation: + $ref: '#/paths/~1v1~1certificates~1{certificate_id}~1verifyDomainControl/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/countries.yaml b/providers/src/godaddy/v00.00.00000/services/countries.yaml new file mode 100644 index 00000000..396f5cfe --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/countries.yaml @@ -0,0 +1,296 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: '1.0' +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/countries: + get: + parameters: + - description: 'MarketId in which the request is being made, and for which responses should be localized' + in: query + name: marketId + required: true + schema: + format: bcp-47 + type: string + - description: Restrict countries to this region type; required if regionName is supplied + in: query + name: regionTypeId + required: false + schema: + type: integer + - description: Restrict countries to this region name; required if regionTypeId is supplied + in: query + name: regionName + required: false + schema: + type: string + - description: The term to sort the result countries by. + in: query + name: sort + required: false + schema: + default: key + enum: + - key + - label + type: string + - description: The direction to sort the result countries by. + in: query + name: order + required: false + schema: + default: ascending + enum: + - ascending + - descending + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/CountrySummary' + description: Request was successful + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: regionTypeId is required when regionName is provided + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + description: Retrieves summary country information for the provided marketId and filters. Authorization is not required. + operationId: getCountries + '/v1/countries/{country_key}': + get: + parameters: + - description: The country key + in: path + name: country_key + required: true + schema: + format: iso-country-code + type: string + - description: 'MarketId in which the request is being made, and for which responses should be localized' + in: query + name: marketId + required: true + schema: + format: bcp-47 + type: string + - description: The term to sort the result country states by. + in: query + name: sort + required: false + schema: + default: key + enum: + - key + - label + type: string + - description: The direction to sort the result country states by. + in: query + name: order + required: false + schema: + default: ascending + enum: + - ascending + - descending + type: string + responses: + '200': + content: + application/json: + schema: + $ref: '#/components/schemas/Country' + description: Request was successful + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Country not found + '422': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: marketId is required + '429': + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: getCountry + description: Retrieves country and summary state information for provided countryKey. Authorization is not required. +components: + schemas: + Country: + properties: + callingCode: + description: The calling code prefix used for phone numbers in this country + type: string + countryKey: + description: The ISO country-code + format: iso-country-code + type: string + label: + description: The localized name of the country + type: string + states: + description: List of states/provinces in this country + items: + $ref: '#/components/schemas/State' + type: array + type: object + CountrySummary: + properties: + callingCode: + description: The calling code prefix used for phone numbers in this country + type: string + countryKey: + description: The ISO country-code + format: iso-country-code + type: string + label: + description: The localized name of the country + type: string + type: object + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + stack: + 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 + items: + type: string + minItems: 1 + type: array + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + description: JSONPath referring to the field within the submitted data containing an error + format: json-path + type: string + required: + - path + - code + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + stack: + 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 + items: + type: string + minItems: 1 + type: array + required: + - retryAfterSec + - code + type: object + State: + properties: + label: + description: 'The localized name of the state, province, or territory' + type: string + stateKey: + description: The state code + type: string + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + countries: + id: godaddy.countries.countries + name: countries + title: Countries + methods: + get_countries: + operation: + $ref: '#/paths/~1v1~1countries/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get_country: + operation: + $ref: '#/paths/~1v1~1countries~1{country_key}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/countries/methods/get_country' + - $ref: '#/components/x-stackQL-resources/countries/methods/get_countries' + insert: [] + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/domains.yaml b/providers/src/godaddy/v00.00.00000/services/domains.yaml new file mode 100644 index 00000000..1962a60c --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/domains.yaml @@ -0,0 +1,7600 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 2.4.9 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/domains: + get: + parameters: + - description: Shopper ID whose domains are to be retrieved + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Only include results with `status` value in the specified set + in: query + name: statuses + required: false + schema: + items: + 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_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 + type: array + - description: Only include results with `status` value in any of the specified groups + in: query + name: statusGroups + required: false + schema: + items: + enum: + - INACTIVE + - PRE_REGISTRATION + - REDEMPTION + - RENEWABLE + - VERIFICATION_ICANN + - VISIBLE + type: string + type: array + - description: Maximum number of domains to return + in: query + name: limit + required: false + schema: + maximum: 1000 + minimum: 1 + type: integer + - description: Marker Domain to use as the offset in results + in: query + name: marker + required: false + schema: + type: string + - description: Optional details to be included in the response + in: query + name: includes + required: false + schema: + items: + enum: + - authCode + - contacts + - nameServers + type: string + type: array + - description: Only include results that have been modified since the specified date + in: query + name: modifiedDate + required: false + schema: + format: iso-datetime + type: string + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/DomainSummary' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/DomainSummary' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/DomainSummary' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/DomainSummary' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/DomainSummary' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Limit must have a value no greater than 1000 + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: list + summary: Retrieve a list of Domains for the specified Shopper + description: Retrieve a list of Domains for the specified Shopper + x-stackQL-verb: select + /v1/domains/agreements: + get: + parameters: + - description: Unique identifier of the Market used to retrieve/translate Legal Agreements + in: header + name: X-Market-Id + required: false + schema: + default: en-US + format: bcp-47 + type: string + - description: list of TLDs whose legal agreements are to be retrieved + in: query + name: tlds + required: true + schema: + items: + type: string + type: array + - description: Whether or not privacy has been requested + in: query + name: privacy + required: true + schema: + type: boolean + - description: Whether or not domain tranfer has been requested + in: query + name: forTransfer + required: false + schema: + type: boolean + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/LegalAgreement' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: getAgreement + summary: Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons + description: Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons + x-stackQL-verb: select + /v1/domains/available: + get: + parameters: + - description: Domain name whose availability is to be checked + in: query + name: domain + required: true + schema: + type: string + - description: Optimize for time ('FAST') or accuracy ('FULL') + in: query + name: checkType + required: false + schema: + default: FAST + enum: + - FAST + - FULL + - fast + - full + type: string + - description: 'Whether or not to include domains available for transfer. If set to True, checkType is ignored' + in: query + name: forTransfer + required: false + schema: + default: false + type: boolean + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainAvailableResponse' + application/json: + schema: + $ref: '#/components/schemas/DomainAvailableResponse' + application/xml: + schema: + $ref: '#/components/schemas/DomainAvailableResponse' + text/javascript: + schema: + $ref: '#/components/schemas/DomainAvailableResponse' + text/xml: + schema: + $ref: '#/components/schemas/DomainAvailableResponse' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: domain must be specified + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: available + summary: Determine whether or not the specified domain is available for purchase + description: Determine whether or not the specified domain is available for purchase + x-stackQL-verb: select + post: + parameters: + - description: Optimize for time ('FAST') or accuracy ('FULL') + in: query + name: checkType + required: false + schema: + default: FAST + enum: + - FAST + - FULL + - fast + - full + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainAvailableBulk' + application/json: + schema: + $ref: '#/components/schemas/DomainAvailableBulk' + application/xml: + schema: + $ref: '#/components/schemas/DomainAvailableBulk' + text/javascript: + schema: + $ref: '#/components/schemas/DomainAvailableBulk' + text/xml: + schema: + $ref: '#/components/schemas/DomainAvailableBulk' + description: Request was successful + '203': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainAvailableBulkMixed' + application/json: + schema: + $ref: '#/components/schemas/DomainAvailableBulkMixed' + application/xml: + schema: + $ref: '#/components/schemas/DomainAvailableBulkMixed' + text/javascript: + schema: + $ref: '#/components/schemas/DomainAvailableBulkMixed' + text/xml: + schema: + $ref: '#/components/schemas/DomainAvailableBulkMixed' + description: Request was partially successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: domain must be specified + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: availableBulk + requestBody: + content: + application/json: + schema: + items: + type: string + maximum: 500 + type: array + application/xml: + schema: + items: + type: string + maximum: 500 + type: array + text/xml: + schema: + items: + type: string + maximum: 500 + type: array + description: Domain names for which to check availability + required: true + summary: Determine whether or not the specified domains are available for purchase + description: Determine whether or not the specified domains are available for purchase + /v1/domains/contacts/validate: + post: + parameters: + - description: 'PrivateLabelId to operate as, if different from JWT' + in: header + name: X-Private-Label-Id + required: false + schema: + default: 1 + type: integer + - description: 'MarketId in which the request is being made, and for which responses should be localized' + in: query + name: marketId + required: false + schema: + default: en-US + format: bcp-47 + type: string + responses: + '200': + description: No response was specified + '204': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorDomainContactsValidate' + application/json: + schema: + $ref: '#/components/schemas/ErrorDomainContactsValidate' + application/xml: + schema: + $ref: '#/components/schemas/ErrorDomainContactsValidate' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorDomainContactsValidate' + text/xml: + schema: + $ref: '#/components/schemas/ErrorDomainContactsValidate' + description: 'Request body doesn''t fulfill schema, see details in `fields`' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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 + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainsContactsBulk' + application/xml: + schema: + $ref: '#/components/schemas/DomainsContactsBulk' + text/xml: + schema: + $ref: '#/components/schemas/DomainsContactsBulk' + description: An instance document expected for domains contacts validation + required: true + summary: Validate the request body using the Domain Contact Validation Schema for specified domains. + /v1/domains/identityDocuments: + get: + parameters: + - description: Shopper ID of the owner of the identity document. This is only required if you are a Reseller managing identity documents for your customers. Use this header to pass in their subaccount ID + in: header + name: X-Shopper-Id + required: false + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentSummary' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentSummary' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentSummary' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentSummary' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentSummary' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: listIdentityDocuments + summary: Get a collection of identity documents the current shopper owns + description: Get a collection of identity documents the current shopper owns + x-stackQL-verb: select + post: + parameters: + - description: Shopper ID of the owner of the identity document. This is only required if you are a Reseller managing identity documents for your customers. Use this header to pass in their subaccount ID + in: header + name: X-Shopper-Id + required: false + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/IdentityDocumentId' + application/json: + schema: + $ref: '#/components/schemas/IdentityDocumentId' + application/xml: + schema: + $ref: '#/components/schemas/IdentityDocumentId' + text/javascript: + schema: + $ref: '#/components/schemas/IdentityDocumentId' + text/xml: + schema: + $ref: '#/components/schemas/IdentityDocumentId' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: 'Invalid document type for contact. For individuals, choose from DRIVERS_LICENSE, RESIDENT_ID, RESIDENT_ID_TEMPORARY and PASSPORT. For corporations, choose from BUSINESS_LICENSE and ORGANIZATION_CODE_CERTIFICATE' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: createIdentityDocument + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/IdentityDocumentCreate' + application/xml: + schema: + $ref: '#/components/schemas/IdentityDocumentCreate' + text/xml: + schema: + $ref: '#/components/schemas/IdentityDocumentCreate' + description: Identity document data + required: true + summary: Create an Identity Document from uploaded image + description: Create an Identity Document from uploaded image + /v1/domains/purchase: + post: + parameters: + - description: The Shopper for whom the domain should be purchased + in: header + name: X-Shopper-Id + required: false + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/json: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: domain must be specified + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: purchase + requestBody: + $ref: '#/components/requestBodies/DomainPurchase' + summary: Purchase and register the specified Domain + description: Purchase and register the specified Domain + '/v1/domains/purchase/schema/{tld}': + get: + parameters: + - description: The Top-Level Domain whose schema should be retrieved + in: path + name: tld + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/JsonSchema' + application/json: + schema: + $ref: '#/components/schemas/JsonSchema' + application/xml: + schema: + $ref: '#/components/schemas/JsonSchema' + text/javascript: + schema: + $ref: '#/components/schemas/JsonSchema' + text/xml: + schema: + $ref: '#/components/schemas/JsonSchema' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`tld` must be specified' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: schema + summary: Retrieve the schema to be submitted when registering a Domain for the specified TLD + description: Retrieve the schema to be submitted when registering a Domain for the specified TLD + x-stackQL-verb: select + /v1/domains/purchase/validate: + post: + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: 'Based on restrictions declared in JSON schema returned by `./schema/{tld}`' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: validate + requestBody: + $ref: '#/components/requestBodies/DomainPurchase' + summary: Validate the request body using the Domain Purchase Schema for the specified TLD + description: Validate the request body using the Domain Purchase Schema for the specified TLD + /v1/domains/suggest: + get: + parameters: + - description: Shopper ID for which the suggestions are being generated + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain name or set of keywords for which alternative domain names will be suggested + in: query + name: query + required: false + schema: + 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 + in: query + name: country + required: false + schema: + 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 + format: iso-country-code + type: string + - description: Name of city to be used as a hint for target region + in: query + name: city + required: false + schema: + format: city-name + type: string + - description: |- + Sources to be queried + CC_TLD - Varies the TLD using Country Codes + EXTENSION - Varies the TLD + KEYWORD_SPIN - Identifies keywords and then rotates each one + PREMIUM - Includes variations with premium prices + in: query + name: sources + required: false + schema: + items: + enum: + - CC_TLD + - EXTENSION + - KEYWORD_SPIN + - PREMIUM + - cctld + - extension + - keywordspin + - premium + type: string + type: array + - description: |- + Top-level domains to be included in suggestions + NOTE: These are sample values, there are many + more + in: query + name: tlds + required: false + schema: + items: + type: string + type: array + - description: Maximum length of second-level domain + in: query + name: lengthMax + required: false + schema: + type: integer + - description: Minimum length of second-level domain + in: query + name: lengthMin + required: false + schema: + type: integer + - description: Maximum number of suggestions to return + in: query + name: limit + required: false + schema: + type: integer + - description: |- + Maximum amount of time, in milliseconds, to wait for responses + If elapses, return the results compiled up to that point + in: query + name: waitMs + required: false + schema: + default: 1000 + format: integer-positive + type: integer + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/DomainSuggestion' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/DomainSuggestion' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/DomainSuggestion' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/DomainSuggestion' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/DomainSuggestion' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`query` must be specified' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: suggest + summary: 'Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper''s purchase history' + description: 'Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper''s purchase history' + x-stackQL-verb: select + /v1/domains/tlds: + get: + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/TldSummary' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/TldSummary' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/TldSummary' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/TldSummary' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/TldSummary' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: tlds + summary: Retrieves a list of TLDs supported and enabled for sale + description: Retrieves a list of TLDs supported and enabled for sale + x-stackQL-verb: select + '/v1/domains/{domain}': + delete: + parameters: + - description: Domain to cancel + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: The domain does not exist + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Unknown domain error + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: cancel + summary: Cancel a purchased domain + description: Cancel a purchased domain + get: + parameters: + - description: Shopper ID expected to own the specified domain + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain name whose details are to be retrieved + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainDetail' + application/json: + schema: + $ref: '#/components/schemas/DomainDetail' + application/xml: + schema: + $ref: '#/components/schemas/DomainDetail' + text/javascript: + schema: + $ref: '#/components/schemas/DomainDetail' + text/xml: + schema: + $ref: '#/components/schemas/DomainDetail' + description: Request was successful + '203': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainDetail' + application/json: + schema: + $ref: '#/components/schemas/DomainDetail' + application/xml: + schema: + $ref: '#/components/schemas/DomainDetail' + text/javascript: + schema: + $ref: '#/components/schemas/DomainDetail' + text/xml: + schema: + $ref: '#/components/schemas/DomainDetail' + description: 'Request was partially successful, see verifications.status for further detail' + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` must be specified' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: get + summary: Retrieve details for the specified Domain + description: Retrieve details for the specified Domain + x-stackQL-verb: select + patch: + parameters: + - description: Domain whose details are to be updated + in: path + name: domain + required: true + schema: + type: string + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Specified Subaccount not owned by authenticated Shopper + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '409': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: The given domain is not eligible to have its nameservers changed + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Failed to update nameservers + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainUpdate' + application/xml: + schema: + $ref: '#/components/schemas/DomainUpdate' + text/xml: + schema: + $ref: '#/components/schemas/DomainUpdate' + description: Changes to apply to existing Domain + required: true + summary: Update details for the specified Domain + description: Update details for the specified Domain + '/v1/domains/{domain}/contacts': + patch: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose Contacts are to be updated. + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Identity document not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` is not a valid Domain name' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: updateContacts + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainContacts' + application/xml: + schema: + $ref: '#/components/schemas/DomainContacts' + text/xml: + schema: + $ref: '#/components/schemas/DomainContacts' + description: Changes to apply to existing Contacts + required: true + summary: Update domain + description: Update domain + '/v1/domains/{domain}/privacy': + delete: + parameters: + - description: Shopper ID of the owner of the domain + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose privacy is to be cancelled + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: The domain does not exist + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Unknown domain error + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: cancelPrivacy + summary: Submit a privacy cancellation request for the given domain + description: Submit a privacy cancellation request for the given domain + '/v1/domains/{domain}/privacy/purchase': + post: + parameters: + - description: Shopper ID of the owner of the domain + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain for which to purchase privacy + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/json: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '409': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: The domain status does not allow performing the operation + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` must match `sld.tld`' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: purchasePrivacy + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PrivacyPurchase' + application/xml: + schema: + $ref: '#/components/schemas/PrivacyPurchase' + text/xml: + schema: + $ref: '#/components/schemas/PrivacyPurchase' + description: Options for purchasing privacy + required: true + summary: Purchase privacy for a specified domain + description: Purchase privacy for a specified domain + '/v1/domains/{domain}/records': + patch: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose DNS Records are to be augmented + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` is not a valid Domain name' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: recordAdd + requestBody: + content: + application/json: + schema: + items: {} + type: array + application/xml: + schema: + items: {} + type: array + text/xml: + schema: + items: {} + type: array + description: DNS Records to add to whatever currently exists + required: true + summary: Add the specified DNS Records to the specified Domain + description: Add the specified DNS Records to the specified Domain + put: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose DNS Records are to be replaced + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`record` does not fulfill the schema' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: recordReplace + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + description: DNS Records to replace whatever currently exists + required: true + summary: Replace all DNS Records for the specified Domain + description: Replace all DNS Records for the specified Domain + '/v1/domains/{domain}/records/{type}': + put: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose DNS Records are to be replaced + in: path + name: domain + required: true + schema: + type: string + - description: DNS Record Type for which DNS Records are to be replaced + in: path + name: type + required: true + schema: + enum: + - A + - AAAA + - CNAME + - MX + - NS + - SOA + - SRV + - TXT + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`record` does not fulfill the schema' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: recordReplaceType + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DNSRecordCreateType' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecordCreateType' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecordCreateType' + type: array + description: DNS Records to replace whatever currently exists + required: true + summary: Replace all DNS Records for the specified Domain with the specified Type + description: Replace all DNS Records for the specified Domain with the specified Type + get: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose DNS Records are to be retrieved + in: path + name: domain + required: true + schema: + type: string + - description: DNS Record Type for which DNS Records are to be retrieved + in: path + name: type + required: true + schema: + enum: + - A + - AAAA + - CNAME + - MX + - NS + - SOA + - SRV + - TXT + type: string + - description: Number of results to skip for pagination + in: query + name: offset + required: false + schema: + type: integer + - description: Maximum number of items to return + in: query + name: limit + required: false + schema: + type: integer + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecord' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` is not a valid Domain name' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: recordGet + summary: 'Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name' + description: 'Retrieve DNS Records for the specified Domain, optionally with the specified Type and/or Name' + x-stackQL-verb: select + '/v1/domains/{domain}/records/{type}/{name}': + put: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose DNS Records are to be replaced + in: path + name: domain + required: true + schema: + type: string + - description: DNS Record Type for which DNS Records are to be replaced + in: path + name: type + required: true + schema: + enum: + - A + - AAAA + - CNAME + - MX + - NS + - SOA + - SRV + - TXT + type: string + - description: DNS Record Name for which DNS Records are to be replaced + in: path + name: name + required: true + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`record` does not fulfill the schema' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: recordReplaceTypeName + requestBody: + content: + application/json: + schema: + items: + $ref: '#/components/schemas/DNSRecordCreateTypeName' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecordCreateTypeName' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/DNSRecordCreateTypeName' + type: array + description: DNS Records to replace whatever currently exists + required: true + summary: Replace all DNS Records for the specified Domain with the specified Type and Name + description: Replace all DNS Records for the specified Domain with the specified Type and Name + '/v1/domains/{domain}/renew': + post: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain to renew + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/json: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '409': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: The domain status does not allow performing the operation + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` must match `sld.tld`' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: renew + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainRenew' + application/xml: + schema: + $ref: '#/components/schemas/DomainRenew' + text/xml: + schema: + $ref: '#/components/schemas/DomainRenew' + description: Options for renewing existing Domain + summary: Renew the specified Domain + description: Renew the specified Domain + '/v1/domains/{domain}/transfer': + post: + parameters: + - description: The Shopper to whom the domain should be transfered + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain to transfer in + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/json: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + application/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/javascript: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + text/xml: + schema: + $ref: '#/components/schemas/DomainPurchaseResponse' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '409': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` (domain) isn''t available for transfer' + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: domain must be specified + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: transferIn + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainTransferIn' + application/xml: + schema: + $ref: '#/components/schemas/DomainTransferIn' + text/xml: + schema: + $ref: '#/components/schemas/DomainTransferIn' + description: Details for domain transfer purchase + required: true + summary: Purchase and start or restart transfer process + description: Purchase and start or restart transfer process + '/v1/domains/{domain}/verifyRegistrantEmail': + post: + parameters: + - 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' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Domain whose Contact E-mail should be verified. + in: path + name: domain + required: true + schema: + type: string + responses: + '200': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`domain` is not a valid Domain name' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: verifyEmail + summary: Re-send Contact E-mail Verification for specified Domain + description: Re-send Contact E-mail Verification for specified Domain + '/v1/domains/identityDocuments/{identity_document_id}/verifications': + get: + parameters: + - description: Shopper ID of the owner of the identity document. This is only required if you are a Reseller managing identity documents for your customers. Use this header to pass in their subaccount ID + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Unique identifier of the current identity document + in: path + name: identity_document_id + required: true + schema: + type: string + - description: An array of TLDs for which to retrieve identity document verification jobs. Alternately you can specify the whole domain from which the TLD will be extracted + in: query + name: tlds + required: false + schema: + items: + type: string + type: array + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Identity document not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: One or more supplied domain/tld are invalid + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: getIdentityDocumentVerification + summary: Retrieve a list of Verifications for the specified Identity Document + description: Retrieve a list of Verifications for the specified Identity Document + x-stackQL-verb: select + post: + parameters: + - description: Shopper ID of the owner of the identity document. This is only required if you are a Reseller managing identity documents for your customers. Use this header to pass in their subaccount ID + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Unique id of an identity document + in: path + name: identity_document_id + required: true + schema: + type: string + - description: An array of TLDs for which the verification was started. Alternately you can specify the whole domain from which the TLD will be extracted + in: query + name: tlds + required: true + schema: + items: + type: string + type: array + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/IdentityDocumentVerification' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Identity document not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`identityDocumentVerification` does not fulfill the schema' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + description: 'Only one verification job is needed for one TLD, Top Level Domain, per identity document. Sending in request(s) with multiple domains for the same TLD, will not create multiple verification jobs. We accept domain names for the convenience of our customers so that they don''t need to worry about parsing TLDs out of domain names' + operationId: createVerification + summary: Initiate verifications for the specified Domains +components: + requestBodies: + DomainPurchase: + content: + application/json: + schema: + $ref: '#/components/schemas/DomainPurchase' + application/xml: + schema: + $ref: '#/components/schemas/DomainPurchase' + text/xml: + schema: + $ref: '#/components/schemas/DomainPurchase' + description: 'An instance document expected to match the JSON schema returned by `./schema/{tld}`' + required: true + schemas: + Address: + properties: + address1: + format: street-address + type: string + address2: + format: street-address2 + type: string + city: + format: city-name + type: string + country: + default: US + description: |- + Two-letter ISO country code to be used as a hint for target region + NOTE: These are sample values, there are many + more + 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 + format: iso-country-code + type: string + postalCode: + description: Postal or zip code + format: postal-code + type: string + state: + description: State or province or territory + format: state-province-territory + type: string + required: + - address1 + - city + - state + - postalCode + - country + type: object + Consent: + properties: + agreedAt: + description: Timestamp indicating when the end-user consented to these legal agreements + format: iso-datetime + type: string + agreedBy: + description: Originating client IP address of the end-user's computer when they consented to these legal agreements + type: string + agreementKeys: + description: 'Unique identifiers of the legal agreements to which the end-user has agreed, as returned from the/domains/agreements endpoint' + items: + type: string + type: array + required: + - agreementKeys + - agreedBy + - agreedAt + type: object + Contact: + properties: + addressMailing: + $ref: '#/components/schemas/Address' + email: + format: email + type: string + fax: + format: phone + type: string + jobTitle: + type: string + nameFirst: + format: person-name + type: string + nameLast: + format: person-name + type: string + nameMiddle: + type: string + organization: + format: organization-name + type: string + phone: + format: phone + type: string + required: + - nameFirst + - nameLast + - email + - phone + - addressMailing + type: object + DNSRecord: + properties: + data: + type: string + name: + format: domain + type: string + port: + description: Service port (SRV only) + maximum: 65535 + minimum: 1 + type: integer + priority: + description: Record priority (MX and SRV only) + format: integer-positive + type: integer + protocol: + description: Service protocol (SRV only) + type: string + service: + description: Service type (SRV only) + type: string + ttl: + format: integer-positive + type: integer + type: + enum: + - A + - AAAA + - CNAME + - MX + - NS + - SOA + - SRV + - TXT + type: string + weight: + description: Record weight (SRV only) + format: integer-positive + type: integer + required: + - type + - name + - data + type: object + DNSRecordCreateType: + properties: + data: + type: string + name: + format: domain + type: string + port: + description: Service port (SRV only) + maximum: 65535 + minimum: 1 + type: integer + priority: + description: Record priority (MX and SRV only) + format: integer-positive + type: integer + protocol: + description: Service protocol (SRV only) + type: string + service: + description: Service type (SRV only) + type: string + ttl: + format: integer-positive + type: integer + weight: + description: Record weight (SRV only) + format: integer-positive + type: integer + required: + - name + - data + type: object + DNSRecordCreateTypeName: + properties: + data: + type: string + port: + description: Service port (SRV only) + maximum: 65535 + minimum: 1 + type: integer + priority: + description: Record priority (MX and SRV only) + format: integer-positive + type: integer + protocol: + description: Service protocol (SRV only) + type: string + service: + description: Service type (SRV only) + type: string + ttl: + format: integer-positive + type: integer + weight: + description: Record weight (SRV only) + format: integer-positive + type: integer + required: + - data + type: object + DomainAvailableBulk: + properties: + domains: + description: Domain available response array + items: + $ref: '#/components/schemas/DomainAvailableResponse' + type: array + required: + - domains + type: object + DomainAvailableBulkMixed: + properties: + domains: + description: Domain available response array + items: + $ref: '#/components/schemas/DomainAvailableResponse' + type: array + errors: + description: Errors encountered while performing a domain available check + items: + $ref: '#/components/schemas/DomainAvailableError' + type: array + required: + - domains + type: object + DomainAvailableError: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + domain: + description: Domain name + type: string + message: + description: 'Human-readable, English description of the error' + type: string + path: + 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` + format: json-path + type: string + status: + description: HTTP status code that would return for a single check + type: integer + required: + - code + - domain + - path + - status + type: object + DomainAvailableResponse: + properties: + available: + description: Whether or not the domain name is available + type: boolean + currency: + default: USD + description: Currency in which the `price` is listed. Only returned if tld is offered + format: iso-currency-code + type: string + definitive: + description: Whether or not the `available` answer has been definitively verified with the registry + type: boolean + domain: + description: Domain name + type: string + period: + description: Number of years included in the price. Only returned if tld is offered + format: integer-positive + type: integer + price: + description: Price of the domain excluding taxes or fees. Only returned if tld is offered + format: currency-micro-unit + type: integer + required: + - domain + - available + - definitive + type: object + DomainContacts: + properties: + contactAdmin: + $ref: '#/components/schemas/Contact' + contactBilling: + $ref: '#/components/schemas/Contact' + contactRegistrant: + $ref: '#/components/schemas/Contact' + contactTech: + $ref: '#/components/schemas/Contact' + required: + - contactRegistrant + type: object + DomainDetail: + properties: + authCode: + description: Authorization code for transferring the Domain + type: string + contactAdmin: + $ref: '#/components/schemas/Contact' + description: Administrative contact for the domain registration + contactBilling: + $ref: '#/components/schemas/Contact' + description: Billing contact for the domain registration + contactRegistrant: + $ref: '#/components/schemas/Contact' + description: Registration contact for the domain + contactTech: + $ref: '#/components/schemas/Contact' + description: Technical contact for the domain registration + createdAt: + description: Date and time when this domain was created + format: date-time + type: string + deletedAt: + description: Date and time when this domain was deleted + format: date-time + type: string + domain: + description: Name of the domain + type: string + domainId: + description: Unique identifier for this Domain + format: double + type: number + expirationProtected: + description: Whether or not the domain is protected from expiration + type: boolean + expires: + description: Date and time when this domain will expire + format: date-time + type: string + holdRegistrar: + description: Whether or not the domain is on-hold by the registrar + type: boolean + locked: + description: Whether or not the domain is locked to prevent transfers + type: boolean + nameServers: + description: Fully-qualified domain names for DNS servers + items: + format: host-name + type: string + type: array + privacy: + description: Whether or not the domain has privacy protection + type: boolean + renewAuto: + description: Whether or not the domain is configured to automatically renew + type: boolean + renewDeadline: + description: Date the domain must renew on + format: date-time + type: string + status: + 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 + type: string + subaccountId: + description: Reseller subaccount shopperid who can manage the domain + type: string + transferProtected: + description: Whether or not the domain is protected from transfer + type: boolean + verifications: + $ref: '#/components/schemas/VerificationsDomain' + description: Progress and status for each of the verification processes requested for this domain + required: + - domainId + - domain + - status + - expirationProtected + - holdRegistrar + - locked + - privacy + - renewAuto + - renewDeadline + - transferProtected + - createdAt + - authCode + - nameServers + - contactRegistrant + - contactBilling + - contactAdmin + - contactTech + type: object + DomainPurchase: + 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: + description: 'For internationalized domain names with non-ascii characters, the domain name is converted to punycode before format and pattern validation rules are checked' + format: domain + type: string + nameServers: + items: + format: host-name + type: string + maxItems: 2 + minItems: 0 + type: array + period: + default: 1 + format: integer-positive + maximum: 10 + minimum: 1 + type: integer + privacy: + default: false + type: boolean + renewAuto: + default: true + type: boolean + required: + - domain + - consent + type: object + DomainPurchaseResponse: + properties: + currency: + default: USD + description: Currency in which the `total` is listed + format: iso-currency-code + type: string + itemCount: + description: Number items included in the order + format: integer-positive + type: integer + orderId: + description: Unique identifier of the order processed to purchase the domain + format: integer-positive + type: integer + total: + description: Total cost of the domain and any selected add-ons + format: currency-micro-unit + type: integer + required: + - orderId + - itemCount + - total + type: object + DomainRenew: + properties: + period: + description: 'Number of years to extend the Domain. Must not exceed maximum for TLD. When omitted, defaults to `period` specified during original purchase' + format: integer-positive + maximum: 10 + minimum: 1 + type: integer + type: object + DomainSuggestion: + properties: + domain: + description: Suggested domain name + type: string + required: + - domain + type: object + DomainSummary: + properties: + authCode: + description: Authorization code for transferring the Domain + type: string + contactAdmin: + $ref: '#/components/schemas/Contact' + description: Administrative contact for the domain registration + contactBilling: + $ref: '#/components/schemas/Contact' + description: Billing contact for the domain registration + contactRegistrant: + $ref: '#/components/schemas/Contact' + description: Registration contact for the domain + contactTech: + $ref: '#/components/schemas/Contact' + description: Technical contact for the domain registration + createdAt: + description: Date and time when this domain was created + format: date-time + type: string + deletedAt: + description: Date and time when this domain was deleted + format: date-time + type: string + domain: + description: Name of the domain + type: string + domainId: + description: Unique identifier for this Domain + format: double + type: number + expirationProtected: + description: Whether or not the domain is protected from expiration + type: boolean + expires: + description: Date and time when this domain will expire + format: date-time + type: string + holdRegistrar: + description: Whether or not the domain is on-hold by the registrar + type: boolean + locked: + description: Whether or not the domain is locked to prevent transfers + type: boolean + nameServers: + description: Fully-qualified domain names for DNS servers + items: + format: host-name + type: string + type: array + privacy: + description: Whether or not the domain has privacy protection + type: boolean + renewAuto: + description: Whether or not the domain is configured to automatically renew + type: boolean + renewDeadline: + description: Date the domain must renew on + format: date-time + type: string + renewable: + description: Whether or not the domain is eligble for renewal based on status + type: boolean + status: + 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 + type: string + transferProtected: + description: Whether or not the domain is protected from transfer + type: boolean + required: + - domainId + - domain + - status + - expirationProtected + - holdRegistrar + - locked + - privacy + - renewAuto + - renewDeadline + - transferProtected + - createdAt + - contactRegistrant + type: object + DomainTransferIn: + properties: + authCode: + description: Authorization code from registrar for transferring a domain + type: string + consent: + $ref: '#/components/schemas/Consent' + description: Required agreements can be retrieved via the GET ./domains/agreements endpoint + period: + default: 1 + description: Can be more than 1 but no more than 10 years total including current registration length + format: integer-positive + maximum: 10 + minimum: 1 + type: integer + privacy: + default: false + description: Whether or not privacy has been requested + type: boolean + renewAuto: + default: true + description: Whether or not the domain should be configured to automatically renew + type: boolean + required: + - authCode + - consent + type: object + DomainUpdate: + properties: + locked: + description: Whether or not the domain should be locked to prevent transfers + type: boolean + nameServers: + description: Fully-qualified domain names for Name Servers to associate with the domain + items: + format: host-name + type: array + renewAuto: + description: Whether or not the domain should be configured to automatically renew + type: boolean + subaccountId: + description: Reseller subaccount shopperid who can manage the domain + type: string + type: object + DomainsContactsBulk: + 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: + 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`''' + items: + format: domain + type: string + minItems: 1 + type: array + entityType: + description: Canadian Presence Requirement (CA) + 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 + required: + - domains + type: object + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + required: + - code + type: object + ErrorDomainContactsValidate: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorFieldDomainContactsValidate' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + stack: + 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' + items: + type: string + minItems: 1 + type: array + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + 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` + format: json-path + type: string + pathRelated: + description: 'JSONPath referring to a field containing an error, which is referenced by `path`' + format: json-path + type: string + required: + - path + - code + type: object + ErrorFieldDomainContactsValidate: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + domains: + 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`' + items: + type: string + type: array + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + description: 1) JSONPath referring to the field within the data containing an erroror2) JSONPath referring to an object containing an error + format: json-path + type: string + pathRelated: + description: JSONPath referring to the field on the object referenced by `path` containing an error + format: json-path + type: string + required: + - code + - domains + - path + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + required: + - retryAfterSec + - code + type: object + IdentityDocumentCreate: + properties: + contact: + $ref: '#/components/schemas/Contact' + identificationCountry: + description: 'Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more' + enum: + - 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 + - BL + - BM + - BN + - BO + - BQ + - BR + - BS + - BT + - BV + - BW + - BY + - BZ + - CA + - CC + - CD + - CF + - CG + - CH + - CI + - CK + - CL + - CM + - CN + - CO + - CR + - CU + - 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 + - IR + - IS + - IT + - JE + - JM + - JO + - JP + - KE + - KG + - KH + - KI + - KM + - KN + - KP + - KR + - KW + - KY + - KZ + - LA + - LB + - LC + - LI + - LK + - LR + - LS + - LT + - LU + - LV + - LY + - MA + - MC + - MD + - ME + - MF + - 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 + - SD + - SE + - SG + - SH + - SI + - SJ + - SK + - SL + - SM + - SN + - SO + - SR + - SS + - ST + - SV + - SX + - SY + - SZ + - TC + - TD + - TF + - TG + - TH + - TJ + - TK + - TL + - TM + - TN + - TO + - 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 + format: iso-country-code + type: string + identificationNumber: + description: Individual or business identification number written on the document. Must match image exactly + type: string + identificationType: + description: Type of the identity document + enum: + - BUSINESS_LICENSE + - DRIVERS_LICENSE + - ORGANIZATION_CODE_CERTIFICATE + - PASSPORT + - RESIDENT_ID + - RESIDENT_ID_TEMPORARY + type: string + image: + description: 'The base64 encoded string of the document image. The document image size must be between 4KB and 10MB. Supported formats are bmp, jpg/jpeg, jfif, png, gif, and tiff' + type: string + legalEntityName: + description: Individual or business name written on the document. Must match image exactly + type: string + required: + - contact + - identificationCountry + - identificationNumber + - identificationType + - image + - legalEntityName + type: object + IdentityDocumentId: + properties: + identityDocumentId: + description: The unique identifier of an identity document + type: string + required: + - identityDocumentId + type: object + IdentityDocumentSummary: + properties: + contact: + $ref: '#/components/schemas/Contact' + identificationCountry: + description: 'Two-letter ISO country code to be used as a hint for target region NOTE: These are sample values, there are many more ' + enum: + - 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 + - BL + - BM + - BN + - BO + - BQ + - BR + - BS + - BT + - BV + - BW + - BY + - BZ + - CA + - CC + - CD + - CF + - CG + - CH + - CI + - CK + - CL + - CM + - CN + - CO + - CR + - CU + - 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 + - IR + - IS + - IT + - JE + - JM + - JO + - JP + - KE + - KG + - KH + - KI + - KM + - KN + - KP + - KR + - KW + - KY + - KZ + - LA + - LB + - LC + - LI + - LK + - LR + - LS + - LT + - LU + - LV + - LY + - MA + - MC + - MD + - ME + - MF + - 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 + - SD + - SE + - SG + - SH + - SI + - SJ + - SK + - SL + - SM + - SN + - SO + - SR + - SS + - ST + - SV + - SX + - SY + - SZ + - TC + - TD + - TF + - TG + - TH + - TJ + - TK + - TL + - TM + - TN + - TO + - 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 + format: iso-country-code + type: string + identificationNumber: + description: Individual or business identification number written on the document. Must match image exactly + type: string + identificationType: + description: Type of the identity document + enum: + - BUSINESS_LICENSE + - DRIVERS_LICENSE + - ORGANIZATION_CODE_CERTIFICATE + - PASSPORT + - RESIDENT_ID + - RESIDENT_ID_TEMPORARY + type: string + identityDocumentId: + description: The unique identifier of an identity document + type: string + legalEntityName: + description: Individual or business name written on the document. Must match image exactly + type: string + required: + - contact + - identificationCountry + - identificationNumber + - identificationType + - identityDocumentId + - legalEntityName + type: object + IdentityDocumentVerification: + properties: + createdAt: + description: Timestamp indicating when the user created the identity document verification job + format: iso-datetime + type: string + status: + enum: + - APPROVED + - REJECTED + - PENDING + type: string + tld: + description: Top level domain the current identity document verification is for + type: string + required: + - createdAt + - status + - tld + type: object + JsonDataType: + properties: + $ref: + type: string + format: + type: string + pattern: + type: string + type: + type: string + required: + - type + - $ref + type: object + JsonProperty: + properties: + $ref: + type: string + defaultValue: + type: string + format: + type: string + items: + items: + $ref: '#/components/schemas/JsonDataType' + type: object + maxItems: + type: integer + maximum: + type: integer + minItems: + type: integer + minimum: + type: integer + pattern: + type: string + required: + type: boolean + type: + type: string + required: + - type + - $ref + - required + type: object + JsonSchema: + properties: + id: + type: string + models: + items: + $ref: '#/components/schemas/JsonSchema' + type: object + properties: + items: + $ref: '#/components/schemas/JsonProperty' + type: object + required: + items: + type: string + type: array + required: + - id + - properties + - required + - models + type: object + LegalAgreement: + properties: + agreementKey: + description: Unique identifier for the legal agreement + type: string + content: + description: 'Contents of the legal agreement, suitable for embedding' + type: string + title: + description: Title of the legal agreement + type: string + url: + description: URL to a page containing the legal agreement + format: url + type: string + required: + - agreementKey + - title + - content + type: object + PrivacyPurchase: + properties: + consent: + $ref: '#/components/schemas/Consent' + description: Specify agreement `DNPA`. Required agreements can be retrieved via the GET ./domains/agreements endpoint + required: + - consent + type: object + RealNameValidation: + properties: + status: + 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 + type: object + TldSummary: + properties: + name: + description: Name of the top-level domain + format: tld + type: string + type: + default: GENERIC + description: Type of the top-level domain + enum: + - COUNTRY_CODE + - GENERIC + type: string + required: + - name + - type + type: object + VerificationDomainName: + properties: + status: + description: Status of the domain name verification + enum: + - APPROVED + - PENDING + - REJECTED + - UNABLE_TO_RETRIEVE_STATUS + type: string + required: + - status + type: object + VerificationRealName: + properties: + status: + 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 ' + 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 + required: + - status + type: object + VerificationsDomain: + properties: + domainName: + $ref: '#/components/schemas/VerificationDomainName' + description: Verification of domain name against a prohibited list maintained by the government + realName: + $ref: '#/components/schemas/VerificationRealName' + description: Verification of identity by comparing registration data against government issued documents + type: object + domain: + properties: + id: + format: double + type: number + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + domains: + id: godaddy.domains.domains + name: domains + title: Domains + methods: + list: + operation: + $ref: '#/paths/~1v1~1domains/get' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/domains/methods/get' + - $ref: '#/components/x-stackQL-resources/domains/methods/list' + insert: [] + update: [] + delete: [] + agreements: + id: godaddy.domains.agreements + name: agreements + title: Agreements + methods: + get_agreement: + operation: + $ref: '#/paths/~1v1~1domains~1agreements/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/agreements/methods/get_agreement' + insert: [] + update: [] + delete: [] + available: + id: godaddy.domains.available + name: available + title: Available + methods: + available: + operation: + $ref: '#/paths/~1v1~1domains~1available/get' + response: + mediaType: application/json + openAPIDocKey: '200' + available_bulk: + operation: + $ref: '#/paths/~1v1~1domains~1available/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/available/methods/available' + insert: [] + update: [] + delete: [] + contacts_validate: + id: godaddy.domains.contacts_validate + name: contacts_validate + title: Contacts Validate + methods: + contacts_validate: + operation: + $ref: '#/paths/~1v1~1domains~1contacts~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + identity_documents: + id: godaddy.domains.identity_documents + name: identity_documents + title: Identity Documents + methods: + list_identity_documents: + operation: + $ref: '#/paths/~1v1~1domains~1identityDocuments/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_identity_document: + operation: + $ref: '#/paths/~1v1~1domains~1identityDocuments/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/identity_documents/methods/list_identity_documents' + insert: + - $ref: '#/components/x-stackQL-resources/identity_documents/methods/create_identity_document' + update: [] + delete: [] + purchase: + id: godaddy.domains.purchase + name: purchase + title: Purchase + methods: + purchase: + operation: + $ref: '#/paths/~1v1~1domains~1purchase/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + purchase_schema: + id: godaddy.domains.purchase_schema + name: purchase_schema + title: Purchase Schema + methods: + schema: + operation: + $ref: '#/paths/~1v1~1domains~1purchase~1schema~1{tld}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/purchase_schema/methods/schema' + insert: [] + update: [] + delete: [] + purchase_validate: + id: godaddy.domains.purchase_validate + name: purchase_validate + title: Purchase Validate + methods: + validate: + operation: + $ref: '#/paths/~1v1~1domains~1purchase~1validate/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + suggest: + id: godaddy.domains.suggest + name: suggest + title: Suggest + methods: + suggest: + operation: + $ref: '#/paths/~1v1~1domains~1suggest/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/suggest/methods/suggest' + insert: [] + update: [] + delete: [] + tlds: + id: godaddy.domains.tlds + name: tlds + title: Tlds + methods: + tlds: + operation: + $ref: '#/paths/~1v1~1domains~1tlds/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/tlds/methods/tlds' + insert: [] + update: [] + delete: [] + contacts: + id: godaddy.domains.contacts + name: contacts + title: Contacts + methods: + update_contacts: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1contacts/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + privacy: + id: godaddy.domains.privacy + name: privacy + title: Privacy + methods: + cancel_privacy: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1privacy/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + privacy_purchase: + id: godaddy.domains.privacy_purchase + name: privacy_purchase + title: Privacy Purchase + methods: + purchase_privacy: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1privacy~1purchase/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + records: + id: godaddy.domains.records + name: records + title: Records + methods: + record_add: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1records/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + record_replace: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1records/put' + response: + mediaType: application/json + openAPIDocKey: '200' + record_replace_type: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1records~1{type}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + record_get: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1records~1{type}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + record_replace_type_name: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1records~1{type}~1{name}/put' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/records/methods/record_get' + insert: [] + update: [] + delete: [] + renew: + id: godaddy.domains.renew + name: renew + title: Renew + methods: + renew: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1renew/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + transfer: + id: godaddy.domains.transfer + name: transfer + title: Transfer + methods: + transfer_in: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1transfer/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + verify_registrant_email: + id: godaddy.domains.verify_registrant_email + name: verify_registrant_email + title: Verify Registrant Email + methods: + verify_email: + operation: + $ref: '#/paths/~1v1~1domains~1{domain}~1verifyRegistrantEmail/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: [] + identity_documents_verifications: + id: godaddy.domains.identity_documents_verifications + name: identity_documents_verifications + title: Identity Documents Verifications + methods: + get_identity_document_verification: + operation: + $ref: '#/paths/~1v1~1domains~1identityDocuments~1{identity_document_id}~1verifications/get' + response: + mediaType: application/json + openAPIDocKey: '200' + create_verification: + operation: + $ref: '#/paths/~1v1~1domains~1identityDocuments~1{identity_document_id}~1verifications/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/identity_documents_verifications/methods/get_identity_document_verification' + insert: + - $ref: '#/components/x-stackQL-resources/identity_documents_verifications/methods/create_verification' + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/orders.yaml b/providers/src/godaddy/v00.00.00000/services/orders.yaml new file mode 100644 index 00000000..2cd4c1ed --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/orders.yaml @@ -0,0 +1,1149 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 0.0.4 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/orders: + get: + parameters: + - description: Start of range indicating what time-frame should be returned. Inclusive + in: query + name: periodStart + required: false + schema: + type: string + - description: End of range indicating what time-frame should be returned. Inclusive + in: query + name: periodEnd + required: false + schema: + type: string + - description: Domain name to use as the filter of results + in: query + name: domain + required: false + schema: + type: string + - description: Product group id to use as the filter of results + in: query + name: productGroupId + required: false + schema: + type: integer + - description: Payment profile id to use as the filter of results + in: query + name: paymentProfileId + required: false + schema: + type: integer + - description: Parent order id to use as the filter of results + in: query + name: parentOrderId + required: false + schema: + type: string + - description: Number of results to skip for pagination + in: query + name: offset + required: false + schema: + default: 0 + type: integer + - description: Maximum number of items to return + in: query + name: limit + required: false + schema: + default: 25 + maximum: 10000 + minimum: 1 + type: integer + - description: Property name that will be used to sort results. '-' indicates descending + in: query + name: sort + required: false + schema: + default: '-createdAt' + enum: + - createdAt + - '-createdAt' + - orderId + - '-orderId' + - pricing.total + - '-pricing.total' + type: string + - description: 'Shopper ID to be operated on, if different from JWTReseller subaccounts are not supported' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Unique identifier of the Market in which the request is happening + in: header + name: X-Market-Id + required: false + schema: + default: en-US + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/OrderList' + application/json: + schema: + $ref: '#/components/schemas/OrderList' + application/xml: + schema: + $ref: '#/components/schemas/OrderList' + text/javascript: + schema: + $ref: '#/components/schemas/OrderList' + text/xml: + schema: + $ref: '#/components/schemas/OrderList' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + description: API ResellersThis endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header + operationId: list + summary: Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time + '/v1/orders/{order_id}': + get: + parameters: + - description: Order id whose details are to be retrieved + in: path + name: order_id + required: true + schema: + type: string + - description: 'Shopper ID to be operated on, if different from JWTReseller subaccounts are not supported' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Unique identifier of the Market in which the request is happening + in: header + name: X-Market-Id + required: false + schema: + default: en-US + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Order' + application/json: + schema: + $ref: '#/components/schemas/Order' + application/xml: + schema: + $ref: '#/components/schemas/Order' + text/javascript: + schema: + $ref: '#/components/schemas/Order' + text/xml: + schema: + $ref: '#/components/schemas/Order' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + description: API ResellersThis endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header + operationId: get + summary: Retrieve details for specified order +components: + schemas: + Address: + properties: + address1: + format: street-address + type: string + address2: + format: street-address2 + type: string + city: + format: city-name + type: string + country: + default: US + description: |- + Two-letter ISO country code to be used as a hint for target region + NOTE: These are sample values, there are many + more + 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 + format: iso-country-code + type: string + postalCode: + description: Postal or zip code + format: postal-code + type: string + state: + description: State or province or territory + format: state-province-territory + type: string + required: + - address1 + - city + - state + - postalCode + - country + type: object + BillTo: + properties: + contact: + $ref: '#/components/schemas/Contact' + description: Billing contact + taxId: + description: Tax id used for calculating the tax the customer is required to pay + type: string + required: + - contact + type: object + Contact: + properties: + addressMailing: + $ref: '#/components/schemas/Address' + email: + format: email + type: string + fax: + format: phone + type: string + jobTitle: + type: string + nameFirst: + format: person-name + type: string + nameLast: + format: person-name + type: string + nameMiddle: + type: string + organization: + format: organization-name + type: string + phone: + format: phone + type: string + required: + - nameFirst + - nameLast + - email + - phone + - addressMailing + type: object + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + 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` + format: json-path + type: string + pathRelated: + description: 'JSONPath referring to a field containing an error, which is referenced by `path`' + format: json-path + type: string + required: + - path + - code + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + required: + - retryAfterSec + - code + type: object + LineItem: + properties: + domains: + description: A collection of domain names purchased if the current product is domain + items: + type: string + type: array + label: + description: Human readable description of the current product + type: string + period: + default: 1 + format: double + type: number + periodUnit: + default: MONTH + description: The unit of time that periodCount is measured in + enum: + - MONTH + - QUARTER + - SEMI_ANNUAL + - YEAR + - ONE_TIME + type: string + pfid: + description: Unique identifier of the current product + type: integer + pricing: + $ref: '#/components/schemas/LineItemPricing' + description: Pricing information of the current line item + quantity: + description: Number of the current product included in the specified order + format: integer-positive + type: integer + taxCollector: + $ref: '#/components/schemas/LineItemTaxCollector' + description: Company that collects taxes on the sale of the product + required: + - label + - quantity + - pricing + type: object + LineItemPricing: + properties: + discount: + description: Discount off of sale price for given `quantity` and `period` `discount` = `sale` - `subtotal` + format: currency-micro-unit + type: integer + fees: + $ref: '#/components/schemas/OrderFee' + description: Fees for given `quantity` and `period` + list: + description: List price for given `quantity` and `period` + format: currency-micro-unit + type: integer + sale: + description: Actual price for the current product + format: currency-micro-unit + type: integer + savings: + description: Savings off of list price for given `quantity` and `period` `savings` = `list` - `subtotal` + format: currency-micro-unit + type: integer + subtotal: + description: Price with any discounts and without taxes or fees for given `quantity` and `period` + format: currency-micro-unit + type: integer + taxes: + description: Taxes for given `quantity` and `period` + format: currency-micro-unit + type: integer + unit: + description: Pricing for a single unit of the given item + type: object + required: + - subtotal + - list + - savings + - sale + - discount + - taxes + - fees + - unit + type: object + LineItemSummary: + properties: + label: + description: Product label of the current line item + type: string + required: + - label + type: object + LineItemTaxCollector: + properties: + taxCollectorId: + description: Unique identifier for the company + format: integer-positive + type: integer + required: + - taxCollectorId + type: object + LineItemUnitPricing: + properties: + discount: + description: Discount without consideration of `quantity` and `period` + format: currency-micro-unit + type: integer + fees: + $ref: '#/components/schemas/OrderFee' + description: Fees without consideration of `quantity` and `period` + list: + description: List price without consideration of `quantity` and `period` + format: currency-micro-unit + type: integer + sale: + description: Sale price without consideration of `quantity` and `period` + format: currency-micro-unit + type: integer + savings: + description: Savings without consideration of `quantity` and `period` + format: currency-micro-unit + type: integer + taxes: + description: Taxes without consideration of `quantity` and `period` + format: currency-micro-unit + type: integer + required: + - discount + - fees + - list + - sale + - savings + - taxes + type: object + Order: + properties: + billTo: + $ref: '#/components/schemas/BillTo' + description: The billing contact information that was used at the time of purchase + createdAt: + description: Date and time when the current order is created on + format: iso-datetime + type: string + currency: + description: Currency in which the order has been placed + format: iso-currency-code + type: string + items: + items: + $ref: '#/components/schemas/LineItem' + type: array + orderId: + description: Unique identifier of current order + type: string + parentOrderId: + 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 + type: string + payments: + items: + $ref: '#/components/schemas/Payment' + type: array + pricing: + $ref: '#/components/schemas/OrderPricing' + description: Pricing information for current order + required: + - orderId + - currency + - createdAt + - pricing + - billTo + - payments + - items + type: object + OrderFee: + properties: + icann: + description: Domain registration transaction fee charged by ICANN + format: currency-micro-unit + type: integer + total: + description: Sum of all fees + format: currency-micro-unit + type: integer + required: + - total + type: object + OrderList: + properties: + orders: + description: A collection of orders + items: + $ref: '#/components/schemas/OrderSummary' + type: array + pagination: + $ref: '#/components/schemas/Pagination' + description: Pagination information + required: + - orders + - pagination + type: object + OrderPricing: + properties: + discount: + description: Discount from promotional pricing + format: currency-micro-unit + type: integer + fees: + $ref: '#/components/schemas/OrderFee' + description: Fees for the entire cart + id: + format: double + type: number + list: + description: Sum of list prices for the entire cart + format: currency-micro-unit + type: integer + savings: + description: Savings off of list price `savings` = `list` - `subtotal` + format: currency-micro-unit + type: integer + subtotal: + description: Price with `discount` and without taxes or fees + format: currency-micro-unit + type: integer + taxes: + description: Taxes for the entire cart + format: currency-micro-unit + type: integer + total: + description: Price the customer pays `total` = `subtotal` + `taxes` + `fees.total` + format: currency-micro-unit + type: integer + required: + - total + - subtotal + - list + - savings + - discount + - taxes + - fees + type: object + OrderSummary: + properties: + createdAt: + description: Date and time when the current order was created + format: iso-datetime + type: string + currency: + description: Currency in which the order was placed + format: iso-currency-code + type: string + items: + description: Sets of two or more line items in current order + items: + $ref: '#/components/schemas/LineItemSummary' + type: array + orderId: + description: Unique identifier of the current order + type: integer + parentOrderId: + 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 + type: string + pricing: + $ref: '#/components/schemas/OrderSummaryPricing' + description: Pricing information of the current order + required: + - orderId + - currency + - createdAt + - pricing + - items + type: object + OrderSummaryPricing: + properties: + total: + description: Total amount charged for the current order. Negative for Refund and Chargeback + format: currency-micro-unit + type: string + required: + - total + type: object + Pagination: + properties: + first: + description: URI to access the first page + type: string + last: + description: URI to access the last page + type: string + next: + description: URI to access the next page + type: string + previous: + description: URI to access the previous page + type: string + total: + description: Number of records available + type: integer + type: object + Payment: + properties: + amount: + description: Amount paid by the current payment + format: currency-micro-unit + type: integer + category: + description: The category of payment method used at the time of purchase. Most common values are listed in the enum. + enum: + - CREDIT_CARD + - PAYPAL + - ACH + - GIFT_CARD + - IN_STORE_CREDIT + - PREPAID + type: string + paymentProfileId: + description: Unique identifier of the payment profile used by current payment + type: string + 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.' + enum: + - CHECKING_PERSONAL + - CHECKING_BUSINESS + - VISA + - MASTER_CARD + - AMEX + - JCB + - UNIONPAY + type: string + required: + - paymentProfileId + - amount + - category + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + orders: + id: godaddy.orders.orders + name: orders + title: Orders + methods: + list: + operation: + $ref: '#/paths/~1v1~1orders/get' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1orders~1{order_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/orders/methods/get' + - $ref: '#/components/x-stackQL-resources/orders/methods/list' + insert: [] + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/shoppers.yaml b/providers/src/godaddy/v00.00.00000/services/shoppers.yaml new file mode 100644 index 00000000..6788183b --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/shoppers.yaml @@ -0,0 +1,647 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 1.0.0 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/shoppers/subaccount: + post: + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ShopperId' + application/json: + schema: + $ref: '#/components/schemas/ShopperId' + application/xml: + schema: + $ref: '#/components/schemas/ShopperId' + text/javascript: + schema: + $ref: '#/components/schemas/ShopperId' + text/xml: + schema: + $ref: '#/components/schemas/ShopperId' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`subaccount` does not fulfill the schema' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: createSubaccount + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubaccountCreate' + application/xml: + schema: + $ref: '#/components/schemas/SubaccountCreate' + text/xml: + schema: + $ref: '#/components/schemas/SubaccountCreate' + description: The subaccount to create + required: true + description: Create a Subaccount owned by the authenticated Reseller + '/v1/shoppers/{shopper_id}': + get: + parameters: + - description: Shopper whose details are to be retrieved + in: path + name: shopper_id + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Shopper' + application/json: + schema: + $ref: '#/components/schemas/Shopper' + application/xml: + schema: + $ref: '#/components/schemas/Shopper' + text/javascript: + schema: + $ref: '#/components/schemas/Shopper' + text/xml: + schema: + $ref: '#/components/schemas/Shopper' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: get + description: Get details for the specified Shopper + post: + parameters: + - description: The ID of the Shopper to update + in: path + name: shopper_id + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ShopperId' + application/json: + schema: + $ref: '#/components/schemas/ShopperId' + application/xml: + schema: + $ref: '#/components/schemas/ShopperId' + text/javascript: + schema: + $ref: '#/components/schemas/ShopperId' + text/xml: + schema: + $ref: '#/components/schemas/ShopperId' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: '`Shopper` does not fulfill the schema' + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ShopperUpdate' + application/xml: + schema: + $ref: '#/components/schemas/ShopperUpdate' + text/xml: + schema: + $ref: '#/components/schemas/ShopperUpdate' + description: The Shopper details to update + required: true + description: Update details for the specified Shopper +components: + schemas: + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + 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` + format: json-path + type: string + pathRelated: + description: 'JSONPath referring to a field containing an error, which is referenced by `path`' + format: json-path + type: string + required: + - path + - code + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + required: + - retryAfterSec + - code + type: object + Shopper: + properties: + email: + format: email + type: string + externalId: + type: integer + marketId: + default: en-US + format: bcp-47 + type: string + nameFirst: + type: string + nameLast: + type: string + shopperId: + type: string + required: + - shopperId + - nameFirst + - nameLast + - email + - marketId + type: object + ShopperId: + properties: + customerId: + 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 + type: string + shopperId: + type: string + required: + - shopperId + type: object + ShopperUpdate: + properties: + email: + format: email + type: string + externalId: + type: integer + marketId: + format: bcp-47 + type: string + nameFirst: + type: string + nameLast: + type: string + type: object + SubaccountCreate: + properties: + email: + format: email + type: string + externalId: + type: integer + marketId: + default: en-US + format: bcp-47 + type: string + nameFirst: + type: string + nameLast: + type: string + password: + format: shopper-password + type: string + required: + - email + - password + - nameFirst + - nameLast + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + subaccount: + id: godaddy.shoppers.subaccount + name: subaccount + title: Subaccount + methods: + create_subaccount: + operation: + $ref: '#/paths/~1v1~1shoppers~1subaccount/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: + - $ref: '#/components/x-stackQL-resources/subaccount/methods/create_subaccount' + update: [] + delete: [] + shoppers: + id: godaddy.shoppers.shoppers + name: shoppers + title: Shoppers + methods: + get: + operation: + $ref: '#/paths/~1v1~1shoppers~1{shopper_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1v1~1shoppers~1{shopper_id}/post' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/shoppers/methods/get' + insert: [] + update: [] + delete: [] diff --git a/providers/src/godaddy/v00.00.00000/services/subscriptions.yaml b/providers/src/godaddy/v00.00.00000/services/subscriptions.yaml new file mode 100644 index 00000000..cb3f5b48 --- /dev/null +++ b/providers/src/godaddy/v00.00.00000/services/subscriptions.yaml @@ -0,0 +1,1121 @@ +openapi: 3.0.0 +info: + title: api.godaddy.com + version: 0.0.1 +servers: + - url: 'https://api.godaddy.com/' +paths: + /v1/subscriptions: + get: + parameters: + - description: Shopper ID to return subscriptions for when not using JWT + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: The market that the response should be formatted for + in: header + name: X-Market-Id + required: false + schema: + default: en-US + type: string + - description: Only return Subscriptions with the specified product groups + in: query + name: productGroupKeys + required: false + schema: + items: + type: string + type: array + - description: Optional details to be included in the response + in: query + name: includes + required: false + schema: + enum: + - addons + - relations + items: + type: string + type: array + - description: Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit) + in: query + name: offset + required: false + schema: + default: 0 + type: integer + - description: 'Number of Subscriptions to retrieve in this page, starting after offset' + in: query + name: limit + required: false + schema: + default: 25 + maximum: 2000 + minimum: 1 + type: integer + - description: Property name that will be used to sort results. "-" indicates descending + in: query + name: sort + required: false + schema: + default: '-expiresAt' + enum: + - expiresAt + - '-expiresAt' + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/SubscriptionList' + application/json: + schema: + $ref: '#/components/schemas/SubscriptionList' + application/xml: + schema: + $ref: '#/components/schemas/SubscriptionList' + text/javascript: + schema: + $ref: '#/components/schemas/SubscriptionList' + text/xml: + schema: + $ref: '#/components/schemas/SubscriptionList' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Invalid query parameter (custom message returned for each parameter) + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: list + description: Retrieve a list of Subscriptions for the specified Shopper + /v1/subscriptions/productGroups: + get: + parameters: + - description: Shopper ID to return data for when not using JWT + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: The market that the response should be formatted for + in: header + name: X-Market-Id + required: false + schema: + default: en-US + type: string + responses: + '200': + content: + application/javascript: + schema: + items: + $ref: '#/components/schemas/ProductGroup' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/ProductGroup' + type: array + application/xml: + schema: + items: + $ref: '#/components/schemas/ProductGroup' + type: array + text/javascript: + schema: + items: + $ref: '#/components/schemas/ProductGroup' + type: array + text/xml: + schema: + items: + $ref: '#/components/schemas/ProductGroup' + type: array + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + operationId: productGroups + description: Retrieve a list of ProductGroups for the specified Shopper + '/v1/subscriptions/{subscription_id}': + delete: + parameters: + - description: Shopper ID to cancel subscriptions for when not using JWT + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Unique identifier of the Subscription to cancel + in: path + name: subscription_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: The domain alert Subscription cannot be cancelled + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: cancel + description: Cancel the specified Subscription + get: + parameters: + - description: 'Shopper ID to be operated on, if different from JWT' + in: header + name: X-Shopper-Id + required: false + schema: + type: string + - description: Unique identifier of the Market in which the request is happening + in: header + name: X-Market-Id + required: false + schema: + default: en-US + type: string + - description: Unique identifier of the Subscription to retrieve + in: path + name: subscription_id + required: true + schema: + type: string + responses: + '200': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Subscription' + application/json: + schema: + $ref: '#/components/schemas/Subscription' + application/xml: + schema: + $ref: '#/components/schemas/Subscription' + text/javascript: + schema: + $ref: '#/components/schemas/Subscription' + text/xml: + schema: + $ref: '#/components/schemas/Subscription' + description: Request was successful + '400': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authenticated user is not allowed access + '404': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Resource not found + '422': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Invalid Subscription Id + '429': + content: + application/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/json: + schema: + $ref: '#/components/schemas/ErrorLimit' + application/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/javascript: + schema: + $ref: '#/components/schemas/ErrorLimit' + text/xml: + schema: + $ref: '#/components/schemas/ErrorLimit' + description: Too many requests received within interval + '500': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + '504': + content: + application/javascript: + schema: + $ref: '#/components/schemas/Error' + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + text/javascript: + schema: + $ref: '#/components/schemas/Error' + text/xml: + schema: + $ref: '#/components/schemas/Error' + description: Gateway timeout + security: + - sso_key: [] + operationId: get + description: Retrieve details for the specified Subscription + patch: + parameters: + - description: Unique identifier of the Subscription to update + in: path + name: subscription_id + required: true + schema: + type: string + responses: + '200': + description: No response was specified + '204': + description: Request was successful + '400': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + description: Request was malformed + '401': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + description: Authentication info not sent or invalid + '403': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + description: This method only supports JWT authentication + '404': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + description: Payment profile not found + '500': + content: + application/json: + schema: + $ref: '#/components/schemas/Error' + application/xml: + schema: + $ref: '#/components/schemas/Error' + description: Internal server error + security: + - sso_key: [] + 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: update + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SubscriptionUpdate' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/SubscriptionUpdate' + application/xml: + schema: + $ref: '#/components/schemas/SubscriptionUpdate' + text/xml: + schema: + $ref: '#/components/schemas/SubscriptionUpdate' + description: Details of the Subscription to change + required: true + summary: Update details for the specified Subscription +components: + schemas: + Error: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + required: + - code + type: object + ErrorField: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + message: + description: 'Human-readable, English description of the problem with the contents of the field' + type: string + path: + 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` + format: json-path + type: string + pathRelated: + description: 'JSONPath referring to a field containing an error, which is referenced by `path`' + format: json-path + type: string + required: + - path + - code + type: object + ErrorLimit: + properties: + code: + description: 'Short identifier for the error, suitable for indicating the specific error within client code' + format: constant + type: string + fields: + description: 'List of the specific fields, and the errors found with their contents' + items: + $ref: '#/components/schemas/ErrorField' + minItems: 1 + type: array + message: + description: 'Human-readable, English description of the error' + type: string + retryAfterSec: + description: Number of seconds to wait before attempting a similar request + format: integer-positive + type: integer + required: + - retryAfterSec + - code + type: object + Pagination: + properties: + first: + description: URI to access the first page + type: string + last: + description: URI to access the last page + type: string + next: + description: URI to access the next page + type: string + previous: + description: URI to access the previous page + type: string + total: + description: Number of records available + type: integer + type: object + ProductGroup: + properties: + productGroupKey: + description: Primary key of a grouping of related Subscriptions + type: string + subscriptionCount: + description: The number of Subscriptions that the shopper owns in this group + type: integer + required: + - productGroupKey + - subscriptionCount + type: object + Subscription: + properties: + addons: + description: An array of additional products that have been purchased to augment this Subscription + items: + $ref: '#/components/schemas/SubscriptionAddon' + minItems: 0 + type: array + billing: + $ref: '#/components/schemas/SubscriptionBilling' + cancelable: + description: Whether or not the Subscription is allowed to be canceled + type: boolean + createdAt: + description: When the Subscription was created + format: iso-datetime + type: string + expiresAt: + description: When the Subscription will expire + format: iso-datetime + type: string + label: + description: A human readable description of this Subscription + type: string + launchUrl: + description: The url to use or manage this Subscription's active product + format: url + type: string + paymentProfileId: + description: Unique identifier of the payment profile that will be used to automatically renew this Subscription + type: integer + priceLocked: + description: Whether the renewal price will be based from the list price or a locked-in price for this shopper + type: boolean + product: + $ref: '#/components/schemas/SubscriptionProduct' + relations: + $ref: '#/components/schemas/SubscriptionRelations' + renewAuto: + description: Whether or not the Subscription is set to be automatically renewed via the billing agent + type: boolean + renewable: + description: Whether or not the Subscription is allowed to be renewed + type: boolean + status: + description: Whether the Subscription is active or the specific non-active state + enum: + - ACTIVE + - PENDING + - CANCELED + type: string + subscriptionId: + description: Unique identifier of the Subscription + type: string + upgradeable: + description: Whether or not the Subscription is allowed to be upgraded + type: boolean + required: + - subscriptionId + - status + - product + - createdAt + - billing + - renewable + - upgradeable + - priceLocked + - renewAuto + type: object + SubscriptionAddon: + properties: + commitment: + description: The financial commitment the customer has in the product + enum: + - PAID + - FREE + - TRIAL + type: string + pfid: + description: Unique identifier of the add-in product + type: integer + quantity: + type: integer + required: + - pfid + - commitment + - quantity + type: object + SubscriptionBilling: + properties: + commitment: + description: The financial commitment the customer has in the product + enum: + - PAID + - FREE + - TRIAL + type: string + pastDueTypes: + description: The types of charges that are past due when `status` is PAST_DUE + items: + enum: + - ADDON + - BURST + - SUBSCRIPTION + type: string + type: array + renewAt: + description: The point in time after which the Subscription will bill for automatic renewal + format: iso-datetime + type: string + status: + description: Whether payments are past due + enum: + - CURRENT + - PAST_DUE + type: string + required: + - renewAt + - status + - commitment + type: object + SubscriptionList: + properties: + pagination: + $ref: '#/components/schemas/Pagination' + description: Pagination information + subscriptions: + description: A collection of subscriptions + items: + $ref: '#/components/schemas/Subscription' + type: array + required: + - subscriptions + - pagination + type: object + SubscriptionProduct: + properties: + label: + description: A human readable description of the Product that is subscribed + type: string + namespace: + description: Grouping of related Subscriptions + type: string + pfid: + description: Unique identifier of the Product that is subscribed + type: integer + productGroupKey: + description: Primary key of a grouping of related Subscriptions + type: string + renewalPeriod: + description: The number of `renewalPeriodUnits` that will be added by the `renewalPfid` + type: integer + renewalPeriodUnit: + description: The unit of time that `renewalPeriod` is measured in + enum: + - MONTH + - QUARTER + - SEMI_ANNUAL + - YEAR + type: string + renewalPfid: + description: Unique identifier of the renewal Product + type: integer + supportBillOn: + description: Whether the product supports the `billOn` option on the renewal endpoint + type: boolean + required: + - pfid + - label + - renewalPfid + - renewalPeriod + - renewalPeriodUnit + - productGroupKey + - supportBillOn + - namespace + type: object + SubscriptionRelations: + properties: + children: + description: A set of related Subscriptions that will be canceled automatically if this Subscription is canceled + items: + type: string + type: array + parent: + description: Unique identifier of this Subscription's parent + type: string + type: object + SubscriptionUpdate: + properties: + paymentProfileId: + description: Unique identifier of the payment profile you want to be used for automatic renewal + type: integer + renewAuto: + description: Whether or not you want the Subscription renew automatically + type: boolean + type: object + securitySchemes: + sso_key: + type: apiKey + x-stackQL-resources: + subscriptions: + id: godaddy.subscriptions.subscriptions + name: subscriptions + title: Subscriptions + methods: + list: + operation: + $ref: '#/paths/~1v1~1subscriptions/get' + response: + mediaType: application/json + openAPIDocKey: '200' + cancel: + operation: + $ref: '#/paths/~1v1~1subscriptions~1{subscription_id}/delete' + response: + mediaType: application/json + openAPIDocKey: '200' + get: + operation: + $ref: '#/paths/~1v1~1subscriptions~1{subscription_id}/get' + response: + mediaType: application/json + openAPIDocKey: '200' + update: + operation: + $ref: '#/paths/~1v1~1subscriptions~1{subscription_id}/patch' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/get' + - $ref: '#/components/x-stackQL-resources/subscriptions/methods/list' + insert: [] + update: [] + delete: [] + product_groups: + id: godaddy.subscriptions.product_groups + name: product_groups + title: Product Groups + methods: + product_groups: + operation: + $ref: '#/paths/~1v1~1subscriptions~1productGroups/get' + response: + mediaType: application/json + openAPIDocKey: '200' + sqlVerbs: + select: [] + insert: [] + update: [] + delete: []