openapi: 3.0.0
servers:
- url: //api.ote-godaddy.com
info:
title: ""
version: 1.0.0
x-apisguru-categories:
- hosting
x-origin:
- format: swagger
url: https://developer.godaddy.com/swagger/swagger_aftermarket.json
version: "2.0"
x-providerName: ote-godaddy.com
x-serviceName: aftermarket
tags:
- description: ""
name: v1
paths:
/v1/aftermarket/listings:
delete:
operationId: deleteListings
parameters:
- description: A comma separated list of domain names
explode: false
in: query
name: domains
required: true
schema:
items:
type: string
type: array
style: form
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
summary: Remove listings from GoDaddy Auction
tags:
- v1
/v1/aftermarket/listings/expiry:
post:
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
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: Required parameters must be specified in correct format
Too many Listings provided
Invalid Losing Registrar 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
summary: Add expiry listings into GoDaddy Auction
tags:
- v1
components:
schemas:
AftermarketListingAction:
properties:
listingActionId:
description: Action Id
type: integer
required:
- listingActionId
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
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"
type: array
message:
description: Human-readable, English description of the error
type: string
required:
- code
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: |-