@itentialopensource/adapter-godaddy
Version:
This adapter integrates with system described as: GoDaddy REST API v1 and v2.
1,491 lines (1,490 loc) • 722 kB
YAML
openapi: 3.1.0
info:
title: GoDaddy
description: <strong>GoDaddy Abuse API Terms of Use:</strong><p>GoDaddy’s Abuse API is provided to simplify and standardize the abuse reporting experience. To help us streamline the review of abuse reports, you acknowledge and agree that your use of GoDaddy’s Abuse API is subject to the following quality metrics and terms of use.</p><p>GoDaddy may, in its sole and absolute discretion, change or modify these terms, and such changes or modifications shall be effective immediately upon notice to you. Your use of GoDaddy’s Abuse API after such changes or modifications shall constitute your acceptance of these terms as last revised. If you do not agree to be bound by these terms as last revised, do not use (or continue to use) our Abuse API.</p><p>As an Abuse API user, you must only submit abuse reports via the API portal and cease all email submissions, including but not limited, to phishing@godaddy.com, netabuse@godaddy.com, malware@godaddy.com, or spam@godaddy.com, etc. Any additional or duplicate submission outside of the API portal will be deprioritized for review. Submissions related to trademark, copyright or content issues may still be sent to trademarkclaims@godaddy.com, coyprightclaims@godaddy.com, and contentcomplaints@godaddy.com, respectively. Our [Front of Site](https://supportcenter.godaddy.com/AbuseReport) also describes other scenarios not covered by the API.</p><p>When you submit abuse reports via GoDaddy’s Abuse API, you must ensure that you accurately categorize the abuse type of each report to match our definitions in the API documentations provided to you. Any submission that fails to match our definitions or is miscategorized will be marked as a false positive. Examples include, but are not limited to, submissions of trademark complaints marked as phishing or malware, or submissions of copyright complaints marked as phishing or malware, etc.</p><p>If, at any time, the false positive rate of submissions exceeds 40% of your total submissions, as determined by GoDaddy, GoDaddy may in its sole discretion deprioritize any subsequent reports submitted by you and/or your organization.</p><p>You acknowledge and agree that submitting every URL for a single domain is not necessary and will not expedite the review process. If your submissions exceed five (5) URLs for a single domain, your report will be marked as a duplicate submission taking into account that the final outcome of such submissions would yield the same result as the original report. GoDaddy may in its sole discretion deprioritize reports submitted by you and/or your organization in the event more than 20% of your submissions are classified as duplicate submissions.</p><p>You further acknowledge and agree that our Customer Support lines are not intended to address abuse reporting matters or your use of GoDaddy’s Abuse API. Contacting Customer Support will not expedite the review process and may result in abuse reports being deprioritized, to be determined in our sole discretion.</p><p>Should you have any questions about GoDaddy’s Abuse API or any of the terms and conditions set forth above, please contact abuseapisupport@godaddy.com.</p>
contact: {}
version: '2'
jsonSchemaDialect: https://json-schema.org/draft/2020-12/schema
servers:
- url: http://api.ote-godaddy.com
variables: {}
paths:
/v1/abuse/tickets:
get:
tags:
- Abuse
summary: getTickets
description: List all abuse tickets ids that match user provided filters
operationId: getTickets
parameters:
- name: type
in: query
description: The type of abuse.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/type15'
- description: The type of abuse.
- name: closed
in: query
description: Is this abuse ticket closed?
style: form
explode: true
schema:
type: boolean
default: false
- name: sourceDomainOrIp
in: query
description: The domain name or ip address the abuse originated from
style: form
explode: true
schema:
type: string
- name: target
in: query
description: 'The brand/company the abuse is targeting. ie: brand name/bank name'
style: form
explode: true
schema:
type: string
- name: createdStart
in: query
description: The earliest abuse ticket creation date to pull abuse tickets for
style: form
explode: true
schema:
type: string
- name: createdEnd
in: query
description: The latest abuse ticket creation date to pull abuse tickets for
style: form
explode: true
schema:
type: string
- name: limit
in: query
description: Number of abuse ticket numbers to return.
style: form
explode: true
schema:
maximum: 100
type: integer
contentEncoding: int32
default: 100
- name: offset
in: query
description: The earliest result set record number to pull abuse tickets for
style: form
explode: true
schema:
type: integer
contentEncoding: int32
default: 0
responses:
'200':
description: Success
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/AbuseTicketList'
'401':
description: Authentication info not sent or invalid
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Authenticated user is not allowed access
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Error
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
post:
tags:
- Abuse
summary: createTicket
description: Create a new abuse ticket
operationId: createTicket
parameters: []
requestBody:
description: The endpoint which allows the Reporter to create a new abuse ticket
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AbuseTicketCreate'
- description: The endpoint which allows the Reporter to create a new abuse ticket
contentMediaType: application/json
required: true
responses:
'200':
description: No response was specified
headers: {}
content: {}
'201':
description: Success
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/AbuseTicketId'
'401':
description: Authentication info not sent or invalid
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Authenticated user is not allowed access
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
'422':
description: Error
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
parameters: []
/v1/abuse/tickets/{ticketId}:
get:
tags:
- Abuse
summary: getTicketInfo
description: Return the abuse ticket data for a given ticket id
operationId: getTicketInfo
parameters:
- name: ticketId
in: path
description: A unique abuse ticket identifier
required: true
style: simple
schema:
type: string
responses:
'200':
description: Success
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/AbuseTicket'
'401':
description: Authentication info not sent or invalid
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
'403':
description: Authenticated user is not allowed access
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
'404':
description: Invalid ticket id provided
headers: {}
content:
text/plain:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
parameters: []
/v1/aftermarket/listings:
delete:
tags:
- Aftermarket
summary: deleteListings
description: Remove listings from GoDaddy Auction
operationId: deleteListings
parameters:
- name: domains
in: query
description: A comma separated list of domain names
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
const: application/json
type: string
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AftermarketListingAction'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AftermarketListingAction'
- xml:
name: AftermarketListingAction
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/AftermarketListingAction'
- xml:
name: AftermarketListingAction
attribute: false
wrapped: false
contentMediaType: text/xml
'400':
description: Request was malformed
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'401':
description: Authentication info not sent or invalid
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'403':
description: Authenticated user is not allowed access
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'422':
description: Required parameters must be specified in correct format
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'429':
description: Too many requests received within interval
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorLimit'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: text/xml
'500':
description: Internal server error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
deprecated: false
parameters: []
/v1/aftermarket/listings/expiry:
post:
tags:
- Aftermarket
summary: addExpiryListings
description: Add expiry listings into GoDaddy Auction
operationId: addExpiryListings
parameters: []
requestBody:
description: An array of expiry listings to be loaded
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/AftermarketListingExpiryCreate'
description: An array of expiry listings to be loaded
contentMediaType: application/json
required: true
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/AftermarketListingAction'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/AftermarketListingAction'
- xml:
name: AftermarketListingAction
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/AftermarketListingAction'
- xml:
name: AftermarketListingAction
attribute: false
wrapped: false
contentMediaType: text/xml
'400':
description: Request was malformed
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'401':
description: Authentication info not sent or invalid
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'403':
description: Authenticated user is not allowed access
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'422':
description: Required parameters must be specified in correct format<br>Too many Listings provided<br>Invalid Losing Registrar Id
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'429':
description: Too many requests received within interval
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorLimit'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: text/xml
'500':
description: Internal server error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
deprecated: false
parameters: []
/v1/agreements:
get:
tags:
- Agreements
summary: getAgreements
description: Retrieve Legal Agreements for provided agreements keys
operationId: getAgreements
parameters:
- name: X-Private-Label-Id
in: header
description: PrivateLabelId to operate as, if different from JWT
style: simple
schema:
type: integer
contentEncoding: int32
- name: X-Market-Id
in: header
description: Unique identifier of the Market used to retrieve/translate Legal Agreements
style: simple
schema:
type: string
default: en-US
- name: keys
in: query
description: Keys for Agreements whose details are to be retrieved
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
const: application/json
type: string
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LegalAgreement'
description: ''
contentMediaType: application/json
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/LegalAgreement'
description: ''
xml:
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/LegalAgreement'
description: ''
xml:
attribute: false
wrapped: false
contentMediaType: text/xml
'400':
description: Request was malformed
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'401':
description: Authentication info not sent or invalid
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'403':
description: Authenticated user is not allowed access
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'429':
description: Too many requests received within interval
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorLimit'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: text/xml
'500':
description: Internal server error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
deprecated: false
parameters: []
/v1/countries:
get:
tags:
- Countries
summary: getCountries
description: Authorization is not required
operationId: getCountries
parameters:
- name: marketId
in: query
description: MarketId in which the request is being made, and for which responses should be localized
required: true
style: form
explode: true
schema:
type: string
- name: regionTypeId
in: query
description: Restrict countries to this region type; required if regionName is supplied
style: form
explode: true
schema:
type: integer
contentEncoding: int32
- name: regionName
in: query
description: Restrict countries to this region name; required if regionTypeId is supplied
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: The term to sort the result countries by.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/sort'
- description: The term to sort the result countries by.
- name: order
in: query
description: The direction to sort the result countries by.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/order1'
- description: The direction to sort the result countries by.
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
const: application/json
type: string
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/CountrySummary'
description: ''
contentMediaType: application/json
'422':
description: marketId is required<br>regionTypeId is not a valid integer<br>regionName is required when regionTypeId is provided<br>regionTypeId is required when regionName is provided
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too many requests received within interval
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorLimit'
'500':
description: Internal server error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
parameters: []
/v1/countries/{countryKey}:
get:
tags:
- Countries
summary: getCountry
description: Authorization is not required
operationId: getCountry
parameters:
- name: countryKey
in: path
description: The country key
required: true
style: simple
schema:
type: string
- name: marketId
in: query
description: MarketId in which the request is being made, and for which responses should be localized
required: true
style: form
explode: true
schema:
type: string
- name: sort
in: query
description: The term to sort the result country states by.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/sort'
- description: The term to sort the result country states by.
- name: order
in: query
description: The direction to sort the result country states by.
style: form
explode: true
schema:
allOf:
- $ref: '#/components/schemas/order1'
- description: The direction to sort the result country states by.
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
const: application/json
type: string
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Country'
description: ''
contentMediaType: application/json
'404':
description: Country not found
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: marketId is required
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'429':
description: Too many requests received within interval
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorLimit'
'500':
description: Internal server error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
deprecated: false
parameters: []
/v1/domains:
get:
tags:
- Domains
summary: list Domains
description: Retrieve a list of Domains for the specified Shopper
operationId: listDomains
parameters:
- name: X-Shopper-Id
in: header
description: Shopper ID whose domains are to be retrieved
style: simple
schema:
type: string
- name: statuses
in: query
description: Only include results with `status` value in the specified set
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/status16'
- name: statusGroups
in: query
description: Only include results with `status` value in any of the specified groups
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/statusGroup'
- name: limit
in: query
description: Maximum number of domains to return
style: form
explode: true
schema:
maximum: 1000
minimum: 1
type: integer
contentEncoding: int32
- name: marker
in: query
description: Marker Domain to use as the offset in results
style: form
explode: true
schema:
type: string
- name: includes
in: query
description: Optional details to be included in the response
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/include'
- name: modifiedDate
in: query
description: Only include results that have been modified since the specified date
style: form
explode: true
schema:
type: string
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
const: application/json
type: string
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/DomainSummary'
description: ''
contentMediaType: application/json
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/DomainSummary'
description: ''
xml:
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
type: array
items:
$ref: '#/components/schemas/DomainSummary'
description: ''
xml:
attribute: false
wrapped: false
contentMediaType: text/xml
'400':
description: Request was malformed
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'401':
description: Authentication info not sent or invalid
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'403':
description: Authenticated user is not allowed access
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'422':
description: Limit must have a value no greater than 1000
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
'429':
description: Too many requests received within interval
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorLimit'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/ErrorLimit'
- xml:
name: ErrorLimit
attribute: false
wrapped: false
contentMediaType: text/xml
'500':
description: Internal server error
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml:
schema:
allOf:
- $ref: '#/components/schemas/Error'
- xml:
name: Error
attribute: false
wrapped: false
contentMediaType: text/xml
deprecated: false
parameters: []
/v1/domains/agreements:
get:
tags:
- Domains
summary: getAgreement
description: Retrieve the legal agreement(s) required to purchase the specified TLD and add-ons
operationId: getAgreement
parameters:
- name: X-Market-Id
in: header
description: Unique identifier of the Market used to retrieve/translate Legal Agreements
style: simple
schema:
type: string
default: en-US
- name: tlds
in: query
description: list of TLDs whose legal agreements are to be retrieved
required: true
style: form
explode: true
schema:
type: array
items:
type: string
- name: privacy
in: query
description: Whether or not privacy has been requested
required: true
style: form
explode: true
schema:
type: boolean
- name: forTransfer
in: query
description: Whether or not domain tranfer has been requested
style: form
explode: true
schema:
type: boolean
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
const: application/json
type: string
responses:
'200':
description: Request was successful
headers: {}
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/LegalAgreement'
description: ''
contentMediaType: application/json
application/javascript:
schema:
contentMediaType: application/javascript
application/xml:
schema:
type: array
items:
$ref: '#/components/schemas/LegalAgreement'
description: ''
xml:
attribute: false
wrapped: false
contentMediaType: application/xml
text/javascript:
schema:
contentMediaType: text/javascript
text/xml: