{ "id": "@itentialopensource/adapter-godaddy", "type": "Adapter", "export": "Godaddy", "title": "Godaddy", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name": "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "deleteListings", "summary": "Remove listings from GoDaddy Auction", "description": "Remove listings from GoDaddy Auction", "input": [ { "name": "domains", "type": "array", "info": "A comma separated list of domain names: array", "required": true, "schema": { "title": "domains", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteListings" }, "task": true }, { "name": "addExpiryListings", "summary": "Add expiry listings into GoDaddy Auction", "description": "Add expiry listings into GoDaddy Auction", "input": [ { "name": "expiryListings", "type": "array", "info": "An array of expiry listings to be loaded: array", "required": true, "schema": { "items": { "type": "object" }, "type": "array", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/addExpiryListings" }, "task": true }, { "name": "getTickets", "summary": "List all abuse tickets ids that match user provided filters", "description": "List all abuse tickets ids that match user provided filters", "input": [ { "name": "type", "type": "string", "info": "The type of abuse.: Must be one of [A_RECORD, CHILD_ABUSE, CONTENT, FRAUD_WIRE, IP_BLOCK, MALWARE, NETWORK_ABUSE, PHISHING, SPAM]", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "closed", "type": "boolean", "info": "Is this abuse ticket closed?: boolean", "required": false, "schema": { "title": "closed", "type": "boolean" } }, { "name": "sourceDomainOrIp", "type": "string", "info": "The domain name or ip address the abuse originated from: string", "required": false, "schema": { "title": "sourceDomainOrIp", "type": "string" } }, { "name": "target", "type": "string", "info": "The brand/company the abuse is targeting. ie: brand name/bank name: string", "required": false, "schema": { "title": "target", "type": "string" } }, { "name": "createdStart", "type": "string", "info": "The earliest abuse ticket creation date to pull abuse tickets for: string", "required": false, "schema": { "title": "createdStart", "type": "string" } }, { "name": "createdEnd", "type": "string", "info": "The latest abuse ticket creation date to pull abuse tickets for: string", "required": false, "schema": { "title": "createdEnd", "type": "string" } }, { "name": "limit", "type": "number", "info": "Number of abuse ticket numbers to return.: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "The earliest result set record number to pull abuse tickets for: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTickets" }, "task": true }, { "name": "createTicket", "summary": "Create a new abuse ticket", "description": "Create a new abuse ticket", "input": [ { "name": "body", "type": "object", "info": "The endpoint which allows the Reporter to create a new abuse ticket: {\"info\": \"string\", \"infoUrl\": \"string\", \"intentional\": \"boolean\", \"proxy\": \"string\", \"source\": \"string\", \"target\": \"string\", \"type\": \"Must be one of [A_RECORD, CHILD_ABUSE, CONTENT, FRAUD_WIRE, IP_BLOCK, MALWARE, NETWORK_ABUSE, PHISHING, SPAM]\"}", "required": true, "schema": { "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", "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" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createTicket" }, "task": true }, { "name": "getTicketInfo", "summary": "Return the abuse ticket data for a given ticket id", "description": "Return the abuse ticket data for a given ticket id", "input": [ { "name": "ticketId", "type": "string", "info": "A unique abuse ticket identifier: string", "required": true, "schema": { "title": "ticketId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getTicketInfo" }, "task": true }, { "name": "getAgreements", "summary": "Retrieve Legal Agreements for provided agreements keys", "description": "Retrieve Legal Agreements for provided agreements keys", "input": [ { "name": "keys", "type": "array", "info": "Keys for Agreements whose details are to be retrieved: array", "required": true, "schema": { "title": "keys", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "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", "type": "string" } }, "required": [ "agreementKey", "title", "content" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAgreements" }, "task": true }, { "name": "certificateCreate", "summary": "Create a pending order for certificate", "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'.", "input": [ { "name": "certificateCreate", "type": "object", "info": "The certificate order information: {\"callbackUrl\": \"string\", \"commonName\": \"string\", \"contact\": \"undefined\", \"csr\": \"string\", \"intelVPro\": \"boolean\", \"organization\": \"undefined\", \"period\": 123, \"productType\": \"Must be one of [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]\", \"rootType\": \"Must be one of [GODADDY_SHA_1, GODADDY_SHA_2, STARFIELD_SHA_1, STARFIELD_SHA_2]\", \"slotSize\": \"Must be one of [FIVE, TEN, FIFTEEN, TWENTY, THIRTY, FOURTY, FIFTY, ONE_HUNDRED]\", \"subjectAlternativeNames\": \"array\"}", "required": true, "schema": { "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": { "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" ] }, "csr": { "description": "Certificate Signing Request", "type": "string" }, "intelVPro": { "default": false, "description": "Only used for OV", "type": "boolean" }, "organization": { "properties": { "address": { "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" ], "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" ] }, "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" ] }, "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" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateCreate" }, "task": true }, { "name": "certificateValidate", "summary": "Validate a pending order for certificate", "description": "Validate a pending order for certificate", "input": [ { "name": "certificateCreate", "type": "object", "info": "The certificate order info: {\"callbackUrl\": \"string\", \"commonName\": \"string\", \"contact\": \"undefined\", \"csr\": \"string\", \"intelVPro\": \"boolean\", \"organization\": \"undefined\", \"period\": 123, \"productType\": \"Must be one of [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]\", \"rootType\": \"Must be one of [GODADDY_SHA_1, GODADDY_SHA_2, STARFIELD_SHA_1, STARFIELD_SHA_2]\", \"slotSize\": \"Must be one of [FIVE, TEN, FIFTEEN, TWENTY, THIRTY, FOURTY, FIFTY, ONE_HUNDRED]\", \"subjectAlternativeNames\": \"array\"}", "required": true, "schema": { "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": { "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" ] }, "csr": { "description": "Certificate Signing Request", "type": "string" }, "intelVPro": { "default": false, "description": "Only used for OV", "type": "boolean" }, "organization": { "properties": { "address": { "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" ], "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" ] }, "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" ] }, "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" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateValidate" }, "task": true }, { "name": "certificateGet", "summary": "Retrieve certificate details", "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.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to lookup: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateGet" }, "task": true }, { "name": "certificateActionRetrieve", "summary": "Retrieve all certificate actions", "description": "This method is used to retrieve all stateful actions relating to a certificate lifecycle.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to register for callback: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateActionRetrieve" }, "task": true }, { "name": "certificateResendEmail", "summary": "Resend an email", "description": "This method can be used to resend emails by providing the certificate id and the email id", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to resend email: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "emailId", "type": "string", "info": "Email id for email to resend: string", "required": true, "schema": { "title": "emailId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateResendEmail" }, "task": true }, { "name": "certificateAlternateEmailAddress", "summary": "Add alternate email address", "description": "This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to resend emails: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "emailAddress", "type": "string", "info": "Specific email address to resend email: string", "required": true, "schema": { "title": "emailAddress", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateAlternateEmailAddress" }, "task": true }, { "name": "certificateResendEmailAddress", "summary": "Resend email to email address", "description": "This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to resend emails: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "emailId", "type": "string", "info": "Email id for email to resend: string", "required": true, "schema": { "title": "emailId", "type": "string" } }, { "name": "emailAddress", "type": "string", "info": "Specific email address to resend email: string", "required": true, "schema": { "title": "emailAddress", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateResendEmailAddress" }, "task": true }, { "name": "certificateEmailHistory", "summary": "Retrieve email history", "description": "This method can be used to retrieve all emails sent for a certificate.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to retrieve email history: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateEmailHistory" }, "task": true }, { "name": "certificateCallbackDelete", "summary": "Unregister system callback", "description": "Unregister the callback for a particular certificate.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to unregister callback: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateCallbackDelete" }, "task": true }, { "name": "certificateCallbackGet", "summary": "Retrieve system stateful action callback url", "description": "This method is used to retrieve the registered callback url for a certificate.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to register for stateful action callback: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateCallbackGet" }, "task": true }, { "name": "certificateCallbackReplace", "summary": "Register of certificate action callback", "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.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to register/replace for callback: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "callbackUrl", "type": "string", "info": "Callback url registered/replaced to receive stateful actions: string", "required": true, "schema": { "title": "callbackUrl", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateCallbackReplace" }, "task": true }, { "name": "certificateCancel", "summary": "Cancel a pending certificate", "description": "Use the cancel call to cancel a pending certificate order.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to cancel: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateCancel" }, "task": true }, { "name": "certificateDownload", "summary": "Download certificate", "description": "Download certificate", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to download: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateDownload" }, "task": true }, { "name": "certificateReissue", "summary": "Reissue active certificate", "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 th...(description truncated)", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to reissue: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "reissueCreate", "type": "object", "info": "The reissue request info: {\"callbackUrl\": \"string\", \"commonName\": \"string\", \"csr\": \"string\", \"delayExistingRevoke\": 123, \"rootType\": \"Must be one of [GODADDY_SHA_1, GODADDY_SHA_2, STARFIELD_SHA_1, STARFIELD_SHA_2]\", \"subjectAlternativeNames\": \"array\", \"forceDomainRevetting\": \"array\"}", "required": true, "schema": { "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 }, "forceDomainRevetting": { "description": "Optional field. Domain verification will be required for each domain listed here. Specify a value of * to indicate that all domains associated with the request should have their domain information reverified.", "items": { "type": "string" }, "type": "array", "uniqueItems": true } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateReissue" }, "task": true }, { "name": "certificateRenew", "summary": "Renew active certificate", "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 sub...(description truncated)", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to renew: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "renewCreate", "type": "object", "info": "The renew request info: {\"callbackUrl\": \"string\", \"commonName\": \"string\", \"csr\": \"string\", \"period\": 123, \"rootType\": \"Must be one of [GODADDY_SHA_1, GODADDY_SHA_2, STARFIELD_SHA_1, STARFIELD_SHA_2]\", \"subjectAlternativeNames\": \"array\"}", "required": true, "schema": { "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 } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateRenew" }, "task": true }, { "name": "certificateRevoke", "summary": "Revoke active certificate", "description": "Use revoke call to revoke an active certificate, if the certificate has not been issued a 404 response will be returned.", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to revoke: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "certificateRevoke", "type": "object", "info": "The certificate revocation request: {\"reason\": \"Must be one of [AFFILIATION_CHANGED, CESSATION_OF_OPERATION, KEY_COMPROMISE, PRIVILEGE_WITHDRAWN, SUPERSEDED]\"}", "required": true, "schema": { "properties": { "reason": { "description": "Reason for revocation", "enum": [ "AFFILIATION_CHANGED", "CESSATION_OF_OPERATION", "KEY_COMPROMISE", "PRIVILEGE_WITHDRAWN", "SUPERSEDED" ], "type": "string" } }, "required": [ "reason" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateRevoke" }, "task": true }, { "name": "certificateSitesealGet", "summary": "Get Site seal", "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 whe...(description truncated)", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "theme", "type": "string", "info": "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 u...(description truncated): Must be one of [DARK, LIGHT]", "required": false, "schema": { "title": "theme", "type": "string" } }, { "name": "locale", "type": "string", "info": "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...(description truncated): string", "required": false, "schema": { "title": "locale", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateSitesealGet" }, "task": true }, { "name": "certificateVerifydomaincontrol", "summary": "Check Domain Control", "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", "input": [ { "name": "certificateId", "type": "string", "info": "Certificate id to lookup: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateVerifydomaincontrol" }, "task": true }, { "name": "certificateGetEntitlement", "summary": "Search for certificate details by entitlement", "description": "Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificates associated to an entitlement.", "input": [ { "name": "entitlementId", "type": "string", "info": "Entitlement id to lookup: string", "required": true, "schema": { "title": "entitlementId", "type": "string" } }, { "name": "latest", "type": "boolean", "info": "Fetch only the most recent certificate: boolean", "required": false, "schema": { "title": "latest", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "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": { "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" ] }, "createdAt": { "description": "The date the certificate was ordered.", "type": "string" }, "deniedReason": { "description": "Only present if certificate order has been denied", "type": "string" }, "organization": { "properties": { "address": { "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" ], "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" ] }, "assumedName": { "description": "Only for EVSSL. The DBA(does business as) name for the organization.", "type": "string" }, "jurisdictionOfIncorporation": { "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" } }, "required": [ "country" ] }, "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" ] }, "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).", "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": { "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": "array" }, "validEnd": { "description": "The end date of the certificate's validity (if issued or revoked).", "type": "string" }, "validStart": { "description": "The start date of the certificate's validity (if issued or revoked).", "type": "string" } }, "required": [ "certificateId", "status", "contact", "period", "createdAt", "productType" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateGetEntitlement" }, "task": true }, { "name": "certificateDownloadEntitlement", "summary": "Download certificate by entitlement", "description": "Download certificate by entitlement", "input": [ { "name": "entitlementId", "type": "string", "info": "Entitlement id to download: string", "required": true, "schema": { "title": "entitlementId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/certificateDownloadEntitlement" }, "task": true }, { "name": "getCustomerCertificatesByCustomerId", "summary": "Retrieve customer's certificates", "description": "This method can be used to retrieve a list of certificates for a specified customer. **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer: string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "offset", "type": "number", "info": "Number of results to skip for pagination: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "limit", "type": "number", "info": "Maximum number of items to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCustomerCertificatesByCustomerId" }, "task": true }, { "name": "getCertificateDetailByCertIdentifier", "summary": "Retrieve individual certificate details", "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. **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer: string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "certificateId", "type": "string", "info": "Certificate id to lookup: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCertificateDetailByCertIdentifier" }, "task": true }, { "name": "getDomainInformationByCertificateId", "summary": "Retrieve domain verification status", "description": "This method can be used to retrieve the domain verification status for a certificate request. **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13) \"", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer: string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "certificateId", "type": "string", "info": "Certificate id to lookup: string", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "properties": { "domain": { "description": "Domain name", "type": "string" }, "domainEntityId": { "description": "A unique identifier that can be leveraged for retrieving domain verification related information. Primarily used when troubleshooting a request", "type": "integer" }, "dceToken": { "description": "DCE verification type token (if DCE verification type).", "type": "string" }, "status": { "description": "Domain verification status: \n * `AWAITING` - Verification pending customer input\n * `INVALID` - SAN connected to a cancelled request\n * `COMPLETED` - Verification completed\n * `FAILED_VERIFICATION` - Verification failed\n * `PENDING_POSSIBLE_FRAUD` - Flagged for a system level fraud review\n * `VERIFIED_POSSIBLE_FRAUD` - Fraud detection reviewed but verified\n * `DROPPED` - SAN dropped from request\n * `REVOKED_CERT` - Certificate revoked\n * `DROPPED_GOOGLE_SAFE_BROWSING` - SAN dropped from request due to Google Safe Browsing check\n * `DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION` - SAN dropped from request due to Certificate Authorization Authority DNS record check\n", "enum": [ "COMPLETED", "FAILED_VERIFICATION", "VERIFIED_POSSIBLE_FRAUD", "DROPPED", "DROPPED_CERTIFICATE_AUTHORITY_AUTHORIZATION", "DROPPED_GOOGLE_SAFE_BROWSING", "INVALID", "AWAITING", "PENDING_POSSIBLE_FRAUD", "REVOKED_CERTIFICATE" ], "type": "string" }, "createdAt": { "description": "Timestamp indicating when the domain verification process was started", "type": "string" }, "modifiedAt": { "description": "Timestamp indicating when the domain verification process was last updated", "type": "string" }, "type": { "description": "Domain verification type: \n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN` - Domain verified using domain control verification email sent to admin@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR` - Domain verified using domain control verification email sent to administrator@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER` - Domain verified using domain control verification email sent to hostmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER` - Domain verified using domain control verification email sent to postmaster@\n * `AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER` - Domain verified using domain control verification email sent to webmaster@\n * `DOMAIN_ACCESS_EMAIL` - Domain verified using a domain access email\n * `DOMAIN_ACCESS_LETTER` - Customer completed a domain access letter which was used for domain verification\n * `DOMAIN_CONTROL_EMAIL` - Domain verified using HTML file or DNS zone file text value\n * `DOMAIN_ZONE_CONTROL` - DNS zone file containing a pre-generated text value used for domain verification\n * `MANUAL_DOMAIN_ACCESS_EMAIL` - DAE sent to an email address manually entered by a rep\n * `PREVIOUS_DOMAIN_ACCESS_EMAIL` - Customers domain access email for a prior certificate request was used for domain verification\n * `REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER` - Representative reviewed a customer provided domain access letter and verified domain\n * `REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL` - Representative verified domain using a manual domain zone control check\n * `REGISTRATION_AUTHORITY_OVERRIDE` - Representative verified domain using alternative methods\n * `REGISTRATION_AUTHORITY_WEBSITE_CONTROL` - Representative verified domain using a manual website control check\n * `CUSTOMER_OWNED` - Validated customer account information used for domain control verification\n * `WEBSITE_CONTROL` - HTML file in root website directory containing pre-generated value used for domain control verification\n", "enum": [ "DOMAIN_CONTROL_EMAIL", "AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMIN", "AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_ADMINSTRATOR", "AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_HOST_MASTER", "AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_POST_MASTER", "AUTO_GENERATED_DOMAIN_ACCESS_EMAIL_WEB_MASTER", "DOMAIN_ACCESS_EMAIL", "DOMAIN_ACCESS_LETTER", "DOMAIN_ZONE_CONTROL", "MANUAL_DOMAIN_ACCESS_EMAIL", "PREVIOUS_DOMAIN_ACCESS_EMAIL", "REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER", "REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL", "REGISTRATION_AUTHORITY_OVERRIDE", "REGISTRATION_AUTHORITY_WEBSITE_CONTROL", "CUSTOMER_OWNED", "WEBSITE_CONTROL" ], "type": "string" }, "usage": { "description": "Type of domain name used for domain verification", "enum": [ "COMMON_NAME", "SUBJECT_ALTERNATIVE_NAME" ], "type": "string" } }, "required": [ "domain", "domainEntityId", "status", "createdAt", "modifiedAt", "type", "usage" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDomainInformationByCertificateId" }, "task": true }, { "name": "getDomainDetailsByDomain", "summary": "Retrieve detailed information for supplied domain", "description": "Retrieve detailed information for supplied domain, including domain verification details and Certificate Authority Authorization (CAA) verification details. **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer: string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "certificateId", "type": "string", "info": "Certificate id to lookup: string", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "domain", "type": "string", "info": "A valid domain name in the certificate request: string", "required": true, "schema": { "title": "domain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDomainDetailsByDomain" }, "task": true }, { "name": "getAcmeExternalAccountBinding", "summary": "Retrieves the external account binding for the specified customer", "description": "Use this endpoint to retrieve a key identifier and Hash-based Message Authentication Code (HMAC) key for Automated Certificate Management Environment (ACME) External Account Binding (EAB). These credentials can be used with an ACME client that supports EAB (ex. CertBot) to automate the issuance request and deployment of DV SSL certificates", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer: string", "required": true, "schema": { "title": "customerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAcmeExternalAccountBinding" }, "task": true }, { "name": "getCountries", "summary": "Retrieves summary country information for the provided marketId and filters", "description": "Authorization is not required", "input": [ { "name": "marketId", "type": "string", "info": "MarketId in which the request is being made, and for which responses should be localized: string", "required": true, "schema": { "title": "marketId", "type": "string" } }, { "name": "regionTypeId", "type": "number", "info": "Restrict countries to this region type; required if regionName is supplied: 123", "required": false, "schema": { "title": "regionTypeId", "type": "number" } }, { "name": "regionName", "type": "string", "info": "Restrict countries to this region name; required if regionTypeId is supplied: string", "required": false, "schema": { "title": "regionName", "type": "string" } }, { "name": "sort", "type": "string", "info": "The term to sort the result countries by.: Must be one of [key, label]", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "order", "type": "string", "info": "The direction to sort the result countries by.: Must be one of [ascending, descending]", "required": false, "schema": { "title": "order", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCountries" }, "task": true }, { "name": "getCountry", "summary": "Retrieves country and summary state information for provided countryKey", "description": "Authorization is not required", "input": [ { "name": "countryKey", "type": "string", "info": "The country key: string", "required": true, "schema": { "title": "countryKey", "type": "string" } }, { "name": "marketId", "type": "string", "info": "MarketId in which the request is being made, and for which responses should be localized: string", "required": true, "schema": { "title": "marketId", "type": "string" } }, { "name": "sort", "type": "string", "info": "The term to sort the result country states by.: Must be one of [key, label]", "required": false, "schema": { "title": "sort", "type": "string" } }, { "name": "order", "type": "string", "info": "The direction to sort the result country states by.: Must be one of [ascending, descending]", "required": false, "schema": { "title": "order", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getCountry" }, "task": true }, { "name": "listDomains", "summary": "Retrieve a list of Domains for the specified Shopper", "description": "Retrieve a list of Domains for the specified Shopper", "input": [ { "name": "statuses", "type": "array", "info": "Only include results with `status` value in the specified set: array", "required": false, "schema": { "title": "statuses", "type": "array" } }, { "name": "statusGroups", "type": "array", "info": "Only include results with `status` value in any of the specified groups: array", "required": false, "schema": { "title": "statusGroups", "type": "array" } }, { "name": "limit", "type": "number", "info": "Maximum number of domains to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "marker", "type": "string", "info": "Marker Domain to use as the offset in results: string", "required": false, "schema": { "title": "marker", "type": "string" } }, { "name": "includes", "type": "array", "info": "Optional details to be included in the response: array", "required": false, "schema": { "title": "includes", "type": "array" } }, { "name": "modifiedDate", "type": "string", "info": "Only include results that have been modified since the specified date: string", "required": false, "schema": { "title": "modifiedDate", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "properties": { "authCode": { "description": "Authorization code for transferring the Domain", "type": "string" }, "contactAdmin": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactBilling": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactRegistrant": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactTech": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "createdAt": { "description": "Date and time when this domain was created", "type": "string" }, "deletedAt": { "description": "Date and time when this domain was deleted", "type": "string" }, "transferAwayEligibleAt": { "description": "Date and time when this domain is eligible to transfer", "type": "string" }, "domain": { "description": "Name of the domain", "type": "string" }, "domainId": { "description": "Unique identifier for this Domain", "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", "type": "string" }, "exposeWhois": { "description": "Whether or not the domain contact details should be shown in the WHOIS", "type": "boolean" }, "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": { "type": "string" }, "type": "array" }, "privacy": { "description": "Whether or not the domain has privacy protection", "type": "boolean" }, "registrarCreatedAt": { "type": "string", "description": "Date and time when this domain was created by the registrar" }, "renewAuto": { "description": "Whether or not the domain is configured to automatically renew", "type": "boolean" }, "renewDeadline": { "description": "Date the domain must renew on", "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
    \n
  • ACTIVE - All is well
    • \n
  • AWAITING* - System is waiting for the end-user to complete an action
    • \n
  • CANCELLED* - Domain has been cancelled, and may or may not be reclaimable
    • \n
  • CONFISCATED - Domain has been confiscated, usually for abuse, chargeback, or fraud
    • \n
  • DISABLED* - Domain has been disabled
    • \n
  • EXCLUDED* - Domain has been excluded from Firehose registration
    • \n
  • EXPIRED* - Domain has expired
    • \n
  • FAILED* - Domain has failed a required action, and the system is no longer retrying
    • \n
  • HELD* - Domain has been placed on hold, and likely requires intervention from Support
    • \n
  • LOCKED* - Domain has been locked, and likely requires intervention from Support
    • \n
  • PARKED* - Domain has been parked, and likely requires intervention from Support
    • \n
  • PENDING* - Domain is working its way through an automated workflow
    • \n
  • RESERVED* - Domain is reserved, and likely requires intervention from Support
    • \n
  • REVERTED - Domain has been reverted, and likely requires intervention from Support
    • \n
  • SUSPENDED* - Domain has been suspended, and likely requires intervention from Support
    • \n
  • TRANSFERRED* - Domain has been transferred out
    • \n
  • UNKNOWN - Domain is in an unknown state
    • \n
  • UNLOCKED* - Domain has been unlocked, and likely requires intervention from Support
    • \n
  • UNPARKED* - Domain has been unparked, and likely requires intervention from Support
    • \n
  • UPDATED* - Domain ownership has been transferred to another account
    • \n
", "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": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listDomains" }, "task": true }, { "name": "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", "input": [ { "name": "tlds", "type": "array", "info": "list of TLDs whose legal agreements are to be retrieved: array", "required": true, "schema": { "title": "tlds", "type": "array" } }, { "name": "privacy", "type": "boolean", "info": "Whether or not privacy has been requested: boolean", "required": true, "schema": { "title": "privacy", "type": "boolean" } }, { "name": "forTransfer", "type": "boolean", "info": "Whether or not domain tranfer has been requested: boolean", "required": false, "schema": { "title": "forTransfer", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "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", "type": "string" } }, "required": [ "agreementKey", "title", "content" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getAgreement" }, "task": true }, { "name": "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", "input": [ { "name": "domain", "type": "string", "info": "Domain name whose availability is to be checked: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "checkType", "type": "string", "info": "Optimize for time ('FAST') or accuracy ('FULL'): Must be one of [FAST, FULL, fast, full]", "required": false, "schema": { "title": "checkType", "type": "string" } }, { "name": "forTransfer", "type": "boolean", "info": "Whether or not to include domains available for transfer. If set to True, checkType is ignored: boolean", "required": false, "schema": { "title": "forTransfer", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/available" }, "task": true }, { "name": "availableBulk", "summary": "Determine whether or not the specified domains are available for purchase", "description": "Determine whether or not the specified domains are available for purchase", "input": [ { "name": "domains", "type": "array", "info": "Domain names for which to check availability: array", "required": true, "schema": { "items": { "type": "string" }, "maximum": 500, "type": "array", "definitions": {} } }, { "name": "checkType", "type": "string", "info": "Optimize for time ('FAST') or accuracy ('FULL'): Must be one of [FAST, FULL, fast, full]", "required": false, "schema": { "title": "checkType", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/availableBulk" }, "task": true }, { "name": "contactsValidate", "summary": "Validate the request body using the Domain Contact Validation Schema for specified domains.", "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", "input": [ { "name": "marketId", "type": "string", "info": "MarketId in which the request is being made, and for which responses should be localized: string", "required": false, "schema": { "title": "marketId", "type": "string" } }, { "name": "body", "type": "object", "info": "An instance document expected for domains contacts validation: {\"contactAdmin\": \"undefined\", \"contactBilling\": \"undefined\", \"contactPresence\": \"undefined\", \"contactRegistrant\": \"undefined\", \"contactTech\": \"undefined\", \"domains\": \"array\", \"entityType\": \"Must be one of [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]\"}", "required": true, "schema": { "properties": { "contactAdmin": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactBilling": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactPresence": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactRegistrant": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactTech": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "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": { "type": "string" }, "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" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/contactsValidate" }, "task": true }, { "name": "purchase", "summary": "Purchase and register the specified Domain", "description": "Purchase and register the specified Domain", "input": [ { "name": "body", "type": "object", "info": "An instance document expected to match the JSON schema returned by `./schema/{tld}`: {\"consent\": \"undefined\", \"contactAdmin\": \"undefined\", \"contactBilling\": \"undefined\", \"contactRegistrant\": \"undefined\", \"contactTech\": \"undefined\", \"domain\": \"string\", \"nameServers\": \"array\", \"period\": 123, \"privacy\": \"boolean\", \"renewAuto\": \"boolean\"}", "required": true, "schema": { "properties": { "consent": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these legal agreements", "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" ] }, "contactAdmin": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactBilling": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactRegistrant": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactTech": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "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", "type": "string" }, "nameServers": { "items": { "type": "string" }, "type": "array" }, "period": { "default": 1, "maximum": 10, "minimum": 1, "type": "integer" }, "privacy": { "default": false, "type": "boolean" }, "renewAuto": { "default": true, "type": "boolean" } }, "required": [ "domain", "consent" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchase" }, "task": true }, { "name": "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", "input": [ { "name": "tld", "type": "string", "info": "The Top-Level Domain whose schema should be retrieved: string", "required": true, "schema": { "title": "tld", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/schema" }, "task": true }, { "name": "validate", "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", "input": [ { "name": "body", "type": "object", "info": "An instance document expected to match the JSON schema returned by `./schema/{tld}`: {\"consent\": \"undefined\", \"contactAdmin\": \"undefined\", \"contactBilling\": \"undefined\", \"contactRegistrant\": \"undefined\", \"contactTech\": \"undefined\", \"domain\": \"string\", \"nameServers\": \"array\", \"period\": 123, \"privacy\": \"boolean\", \"renewAuto\": \"boolean\"}", "required": true, "schema": { "properties": { "consent": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these legal agreements", "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" ] }, "contactAdmin": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactBilling": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactRegistrant": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactTech": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "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", "type": "string" }, "nameServers": { "items": { "type": "string" }, "type": "array" }, "period": { "default": 1, "maximum": 10, "minimum": 1, "type": "integer" }, "privacy": { "default": false, "type": "boolean" }, "renewAuto": { "default": true, "type": "boolean" } }, "required": [ "domain", "consent" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/validate" }, "task": true }, { "name": "suggest", "summary": "Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase", "description": "Suggest alternate Domain names based on a seed Domain, a set of keywords, or the shopper's purchase history", "input": [ { "name": "query", "type": "string", "info": "Domain name or set of keywords for which alternative domain names will be suggested: string", "required": false, "schema": { "title": "query", "type": "string" } }, { "name": "country", "type": "string", "info": "Two-letter ISO country code to be used as a hint for target region\nNOTE: These are sample values, there are many\n more: Must be one of [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]", "required": false, "schema": { "title": "country", "type": "string" } }, { "name": "city", "type": "string", "info": "Name of city to be used as a hint for target region: string", "required": false, "schema": { "title": "city", "type": "string" } }, { "name": "sources", "type": "array", "info": "Sources to be queried\n CC_TLD - Varies the TLD using Country Codes\n EXTENSION - Varies the TLD\n KEYWORD_SPIN - Identifies keywords and then rotates each one\n ...(description truncated): array", "required": false, "schema": { "title": "sources", "type": "array" } }, { "name": "tlds", "type": "array", "info": "Top-level domains to be included in suggestions\nNOTE: These are sample values, there are many\n more: array", "required": false, "schema": { "title": "tlds", "type": "array" } }, { "name": "lengthMax", "type": "number", "info": "Maximum length of second-level domain: 123", "required": false, "schema": { "title": "lengthMax", "type": "number" } }, { "name": "lengthMin", "type": "number", "info": "Minimum length of second-level domain: 123", "required": false, "schema": { "title": "lengthMin", "type": "number" } }, { "name": "limit", "type": "number", "info": "Maximum number of suggestions to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "waitMs", "type": "number", "info": "Maximum amount of time, in milliseconds, to wait for responses\nIf elapses, return the results compiled up to that point: 123", "required": false, "schema": { "title": "waitMs", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "properties": { "domain": { "description": "Suggested domain name", "type": "string" } }, "required": [ "domain" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/suggest" }, "task": true }, { "name": "tlds", "summary": "Retrieves a list of TLDs supported and enabled for sale", "description": "Retrieves a list of TLDs supported and enabled for sale", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "properties": { "name": { "description": "Name of the top-level domain", "type": "string" }, "type": { "default": "GENERIC", "description": "Type of the top-level domain", "enum": [ "COUNTRY_CODE", "GENERIC" ], "type": "string" } }, "required": [ "name", "type" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/tlds" }, "task": true }, { "name": "cancel", "summary": "Cancel a purchased domain", "description": "Cancel a purchased domain", "input": [ { "name": "domain", "type": "string", "info": "Domain to cancel: string", "required": true, "schema": { "title": "domain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancel" }, "task": true }, { "name": "getDomain", "summary": "Retrieve details for the specified Domain", "description": "Retrieve details for the specified Domain", "input": [ { "name": "domain", "type": "string", "info": "Domain name whose details are to be retrieved: string", "required": true, "schema": { "title": "domain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDomain" }, "task": true }, { "name": "update", "summary": "Update details for the specified Domain", "description": "Update details for the specified Domain", "input": [ { "name": "domain", "type": "string", "info": "Domain whose details are to be updated: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "body", "type": "object", "info": "Changes to apply to existing Domain: {\"locked\": \"boolean\", \"nameServers\": \"array\", \"renewAuto\": \"boolean\", \"subaccountId\": \"string\", \"exposeWhois\": \"boolean\", \"consent\": \"undefined\"}", "required": true, "schema": { "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": {}, "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" }, "exposeWhois": { "description": "Whether or not the domain contact details should be shown in the WHOIS", "type": "boolean" }, "consent": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these agreements", "type": "string" }, "agreedBy": { "description": "Originating client IP address of the end-user's computer when they consented to the agreements", "type": "string" }, "agreementKeys": { "description": "Unique identifiers of the agreements to which the end-user has agreed, as required by the elements being updated
  • EXPOSE_WHOIS - Required when the exposeWhois field is updated to true
", "items": { "enum": [ "EXPOSE_WHOIS" ], "type": "string" }, "type": "array" } }, "required": [ "agreementKeys", "agreedBy", "agreedAt" ] } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/update" }, "task": true }, { "name": "updateContacts", "summary": "Update domain", "description": "Update domain", "input": [ { "name": "domain", "type": "string", "info": "Domain whose Contacts are to be updated.: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "contacts", "type": "object", "info": "Changes to apply to existing Contacts: {\"contactAdmin\": \"undefined\", \"contactBilling\": \"undefined\", \"contactRegistrant\": \"undefined\", \"contactTech\": \"undefined\"}", "required": true, "schema": { "properties": { "contactAdmin": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactBilling": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactRegistrant": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactTech": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] } }, "required": [ "contactRegistrant" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateContacts" }, "task": true }, { "name": "cancelPrivacy", "summary": "Submit a privacy cancellation request for the given domain", "description": "Submit a privacy cancellation request for the given domain", "input": [ { "name": "domain", "type": "string", "info": "Domain whose privacy is to be cancelled: string", "required": true, "schema": { "title": "domain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelPrivacy" }, "task": true }, { "name": "purchasePrivacy", "summary": "Purchase privacy for a specified domain", "description": "Purchase privacy for a specified domain", "input": [ { "name": "domain", "type": "string", "info": "Domain for which to purchase privacy: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "body", "type": "object", "info": "Options for purchasing privacy: {\"consent\": \"undefined\"}", "required": true, "schema": { "properties": { "consent": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these legal agreements", "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" ] } }, "required": [ "consent" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/purchasePrivacy" }, "task": true }, { "name": "recordAdd", "summary": "Add the specified DNS Records to the specified Domain", "description": "Add the specified DNS Records to the specified Domain", "input": [ { "name": "domain", "type": "string", "info": "Domain whose DNS Records are to be augmented: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "records", "type": "array", "info": "DNS Records to add to whatever currently exists: array", "required": true, "schema": { "type": "array", "items": { "properties": { "data": { "type": "string" }, "name": { "type": "string" }, "port": { "description": "Service port (SRV only)", "maximum": 65535, "minimum": 1, "type": "integer" }, "priority": { "description": "Record priority (MX and SRV only)", "type": "integer" }, "protocol": { "description": "Service protocol (SRV only)", "type": "string" }, "service": { "description": "Service type (SRV only)", "type": "string" }, "ttl": { "type": "integer" }, "type": { "enum": [ "A", "AAAA", "CNAME", "MX", "NS", "SOA", "SRV", "TXT" ], "type": "string" }, "weight": { "description": "Record weight (SRV only)", "type": "integer" } }, "required": [ "type", "name", "data" ] }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recordAdd" }, "task": true }, { "name": "recordReplace", "summary": "Replace all DNS Records for the specified Domain", "description": "Replace all DNS Records for the specified Domain", "input": [ { "name": "domain", "type": "string", "info": "Domain whose DNS Records are to be replaced: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "records", "type": "array", "info": "DNS Records to replace whatever currently exists: array", "required": true, "schema": { "items": { "type": "object" }, "type": "array", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recordReplace" }, "task": true }, { "name": "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", "input": [ { "name": "domain", "type": "string", "info": "Domain whose DNS Records are to be retrieved: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "type": "string", "info": "DNS Record Type for which DNS Records are to be retrieved: Must be one of [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT]", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "name", "type": "string", "info": "DNS Record Name for which DNS Records are to be retrieved: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "offset", "type": "number", "info": "Number of results to skip for pagination: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "limit", "type": "number", "info": "Maximum number of items to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "properties": { "data": { "type": "string" }, "name": { "type": "string" }, "port": { "description": "Service port (SRV only)", "maximum": 65535, "minimum": 1, "type": "integer" }, "priority": { "description": "Record priority (MX and SRV only)", "type": "integer" }, "protocol": { "description": "Service protocol (SRV only)", "type": "string" }, "service": { "description": "Service type (SRV only)", "type": "string" }, "ttl": { "type": "integer" }, "type": { "enum": [ "A", "AAAA", "CNAME", "MX", "NS", "SOA", "SRV", "TXT" ], "type": "string" }, "weight": { "description": "Record weight (SRV only)", "type": "integer" } }, "required": [ "type", "name", "data" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recordGet" }, "task": true }, { "name": "recordReplaceTypeName", "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", "input": [ { "name": "domain", "type": "string", "info": "Domain whose DNS Records are to be replaced: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "type": "string", "info": "DNS Record Type for which DNS Records are to be replaced: Must be one of [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT]", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "name", "type": "string", "info": "DNS Record Name for which DNS Records are to be replaced: string", "required": true, "schema": { "title": "name", "type": "string" } }, { "name": "records", "type": "array", "info": "DNS Records to replace whatever currently exists: array", "required": true, "schema": { "items": { "type": "object" }, "type": "array", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recordReplaceTypeName" }, "task": true }, { "name": "recordDeleteTypeName", "summary": "Delete all DNS Records for the specified Domain with the specified Type and Name", "description": "Delete all DNS Records for the specified Domain with the specified Type and Name", "input": [ { "name": "domain", "type": "string", "info": "Domain whose DNS Records are to be deleted: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "type": "string", "info": "DNS Record Type for which DNS Records are to be deleted: Must be one of [A, AAAA, CNAME, MX, SRV, TXT]", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "name", "type": "string", "info": "DNS Record Name for which DNS Records are to be deleted: string", "required": true, "schema": { "title": "name", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recordDeleteTypeName" }, "task": true }, { "name": "recordReplaceType", "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", "input": [ { "name": "domain", "type": "string", "info": "Domain whose DNS Records are to be replaced: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "type": "string", "info": "DNS Record Type for which DNS Records are to be replaced: Must be one of [A, AAAA, CNAME, MX, NS, SOA, SRV, TXT]", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "records", "type": "array", "info": "DNS Records to replace whatever currently exists: array", "required": true, "schema": { "items": { "type": "object" }, "type": "array", "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/recordReplaceType" }, "task": true }, { "name": "renew", "summary": "Renew the specified Domain", "description": "Renew the specified Domain", "input": [ { "name": "domain", "type": "string", "info": "Domain to renew: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "body", "type": "object", "info": "Options for renewing existing Domain: {\"period\": 123}", "required": false, "schema": { "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", "maximum": 10, "minimum": 1, "type": "integer" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/renew" }, "task": true }, { "name": "transferIn", "summary": "Purchase and start or restart transfer process", "description": "Purchase and start or restart transfer process", "input": [ { "name": "domain", "type": "string", "info": "Domain to transfer in: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "body", "type": "object", "info": "Details for domain transfer purchase: {\"authCode\": \"string\", \"consent\": \"undefined\", \"period\": 123, \"privacy\": \"boolean\", \"renewAuto\": \"boolean\", \"contactAdmin\": \"undefined\", \"contactBilling\": \"undefined\", \"contactRegistrant\": \"undefined\", \"contactTech\": \"undefined\"}", "required": true, "schema": { "properties": { "authCode": { "description": "Authorization code from registrar for transferring a domain", "type": "string" }, "consent": { "properties": { "agreedAt": { "description": "Timestamp indicating when the end-user consented to these legal agreements", "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" ] }, "period": { "default": 1, "description": "Can be more than 1 but no more than 10 years total including current registration length", "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" }, "contactAdmin": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactBilling": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactRegistrant": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] }, "contactTech": { "properties": { "addressMailing": { "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "default": "US", "description": "Two-letter ISO country code to be used as a hint for target region

\nNOTE: These are sample values, there are many\nmore", "enum": [ "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AQ", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BV", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CV", "CW", "CX", "CY", "CZ", "DE", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GS", "GT", "GU", "GW", "GY", "HK", "HM", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KR", "KV", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PN", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "ST", "SV", "SX", "SZ", "TC", "TD", "TF", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TP", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UM", "US", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "YE", "YT", "ZA", "ZM", "ZW" ], "type": "string" }, "postalCode": { "description": "Postal or zip code", "type": "string" }, "state": { "description": "State or province or territory", "type": "string" } }, "required": [ "address1", "city", "state", "postalCode", "country" ] }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } }, "required": [ "nameFirst", "nameLast", "email", "phone", "addressMailing" ] } }, "required": [ "authCode", "consent" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/transferIn" }, "task": true }, { "name": "verifyEmail", "summary": "Re-send Contact E-mail Verification for specified Domain", "description": "Re-send Contact E-mail Verification for specified Domain", "input": [ { "name": "domain", "type": "string", "info": "Domain whose Contact E-mail should be verified.: string", "required": true, "schema": { "title": "domain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/verifyEmail" }, "task": true }, { "name": "getV2CustomersCustomerIdDomainsDomain", "summary": "Retrieve details for the specified Domain", "description": "Retrieve details for the specified Domain", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain name whose details are to be retrieved: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "includes", "type": "array", "info": "Optional details to be included in the response: array", "required": false, "schema": { "title": "includes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2CustomersCustomerIdDomainsDomain" }, "task": true }, { "name": "postV2CustomersCustomerIdDomainsDomainRedeem", "summary": "Purchase a restore for the given domain to bring it out of redemption", "description": "Purchase a restore for the given domain to bring it out of redemption", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain to request redeem for: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "body", "type": "object", "info": "Options for redeeming existing Domain: {\"consent\": \"undefined\"}", "required": false, "schema": { "additionalProperties": false, "properties": { "consent": { "additionalProperties": false, "properties": { "price": { "type": "integer", "description": "Price for the domain renewal (if domain renewal required for redemption). Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the redemption price and currency for the domain" }, "fee": { "type": "integer", "description": "Fee charged for the domain redemption. Please use GET /v2/customers/{customerId}/domains/{domain} to retrieve the redemption fee and currency for the domain" }, "currency": { "type": "string", "default": "USD", "pattern": "^[A-Z][A-Z][A-Z]$", "description": "Currency in which the `price` and `fee` are listed" }, "agreedBy": { "type": "string", "description": "Originating client IP address of the end-user's computer when they consented to these legal agreements" }, "agreedAt": { "type": "string", "description": "Timestamp indicating when the end-user consented to these legal agreements" } }, "required": [ "price", "fee", "currency", "agreedBy", "agreedAt" ] } }, "required": [ "consent" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV2CustomersCustomerIdDomainsDomainRedeem" }, "task": true }, { "name": "postV2CustomersCustomerIdDomainsDomainTransferOut", "summary": "Initiate transfer out to another registrar for a .uk domain.", "description": "Initiate transfer out to another registrar for a .uk domain.", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain to initiate the transfer out for: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "registrar", "type": "string", "info": "Registrar tag to push transfer to: string", "required": true, "schema": { "title": "registrar", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV2CustomersCustomerIdDomainsDomainTransferOut" }, "task": true }, { "name": "domainsForwardsDelete", "summary": "Submit a forwarding cancellation request for the given fqdn", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "The fully qualified domain name whose forwarding details are to be deleted.: string", "required": true, "schema": { "title": "fqdn", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/domainsForwardsDelete" }, "task": true }, { "name": "domainsForwardsGet", "summary": "Retrieve the forwarding information for the given fqdn", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "The fully qualified domain name whose forwarding details are to be retrieved.: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "includeSubs", "type": "boolean", "info": "Optionally include all sub domains if the fqdn specified is a domain and not a sub domain.: boolean", "required": false, "schema": { "title": "includeSubs", "type": "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "properties": { "fqdn": { "type": "string", "description": "The fqdn (domain or sub domain) to forward (ex somedomain.com or sub.somedomain.com)" }, "type": { "type": "string", "default": "REDIRECT_PERMANENT", "enum": [ "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" ], "description": "The type of fowarding to implement
  • MASKED - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
  • REDIRECT_PERMANENT* - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.
  • REDIRECT_TEMPORARY - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.
" }, "url": { "type": "string", "description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)" }, "mask": { "properties": { "title": { "type": "string", "description": "Displays at the top of the browser window and in search results." }, "description": { "type": "string", "description": "A short description of your website to display in search engine results." }, "keywords": { "type": "string", "description": "A list of comma-separated keywords that describes the content and purpose of your website." } } } }, "required": [ "fqdn", "type", "url" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/domainsForwardsGet" }, "task": true }, { "name": "domainsForwardsPut", "summary": "Modify the forwarding information for the given fqdn", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "The fully qualified domain name whose forwarding details are to be modified.: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "body", "type": "object", "info": "Domain forwarding rule to create or replace on the fqdn: {\"type\": \"Must be one of [MASKED, REDIRECT_PERMANENT, REDIRECT_TEMPORARY]\", \"url\": \"string\", \"mask\": \"undefined\"}", "required": true, "schema": { "properties": { "type": { "type": "string", "default": "REDIRECT_PERMANENT", "enum": [ "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" ], "description": "The type of fowarding to implement
  • MASKED - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
  • REDIRECT_PERMANENT* - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.
  • REDIRECT_TEMPORARY - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.
" }, "url": { "type": "string", "description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)" }, "mask": { "properties": { "title": { "type": "string", "description": "Displays at the top of the browser window and in search results." }, "description": { "type": "string", "description": "A short description of your website to display in search engine results." }, "keywords": { "type": "string", "description": "A list of comma-separated keywords that describes the content and purpose of your website." } } } }, "required": [ "type", "url" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/domainsForwardsPut" }, "task": true }, { "name": "domainsForwardsPost", "summary": "Create a new forwarding configuration for the given FQDN", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "fqdn", "type": "string", "info": "The fully qualified domain name whose forwarding details are to be modified.: string", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "body", "type": "object", "info": "Domain forwarding rule to create for the specified fqdn: {\"type\": \"Must be one of [MASKED, REDIRECT_PERMANENT, REDIRECT_TEMPORARY]\", \"url\": \"string\", \"mask\": \"undefined\"}", "required": true, "schema": { "properties": { "type": { "type": "string", "default": "REDIRECT_PERMANENT", "enum": [ "MASKED", "REDIRECT_PERMANENT", "REDIRECT_TEMPORARY" ], "description": "The type of fowarding to implement
  • MASKED - Prevents the forwarded domain or subdomain URL from displaying in the browser's address bar.
  • REDIRECT_PERMANENT* - Redirects to the url you specified in the forwardTo field using a `301 Moved Permanently` HTTP response. The HTTP 301 response code tells user-agents (including search engines) that the location has permanently moved.
  • REDIRECT_TEMPORARY - Redirects to the url you specified in the forwardTo field using a `302 Found` HTTP response. The HTTP 302 response code tells user-agents (including search engines) that the location has temporarily moved.
" }, "url": { "type": "string", "description": "Forwards http(s) traffic to this destination url (ex. http://www.somedomain.com/)" }, "mask": { "properties": { "title": { "type": "string", "description": "Displays at the top of the browser window and in search results." }, "description": { "type": "string", "description": "A short description of your website to display in search engine results." }, "keywords": { "type": "string", "description": "A list of comma-separated keywords that describes the content and purpose of your website." } } } }, "required": [ "type", "url" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/domainsForwardsPost" }, "task": true }, { "name": "getV2DomainsMaintenances", "summary": "Retrieve a list of upcoming system Maintenances", "description": "Retrieve a list of upcoming system Maintenances", "input": [ { "name": "status", "type": "string", "info": "Only include results with the selected `status` value. Returns all results if omitted ACTIVE - The upcoming maintenance is active. CANCELLED - The upcoming mainte...(description truncated): Must be one of [ACTIVE, CANCELLED]", "required": false, "schema": { "title": "status", "type": "string" } }, { "name": "modifiedAtAfter", "type": "string", "info": "Only include results with `modifiedAt` after the supplied date: string", "required": false, "schema": { "title": "modifiedAtAfter", "type": "string" } }, { "name": "startsAtAfter", "type": "string", "info": "Only include results with `startsAt` after the supplied date: string", "required": false, "schema": { "title": "startsAtAfter", "type": "string" } }, { "name": "limit", "type": "number", "info": "Maximum number of results to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2DomainsMaintenances" }, "task": true }, { "name": "getV2DomainsMaintenancesMaintenanceId", "summary": "Retrieve the details for an upcoming system Maintenances", "description": "Retrieve the details for an upcoming system Maintenances", "input": [ { "name": "maintenanceId", "type": "string", "info": "The identifier for the system maintenance: string", "required": true, "schema": { "title": "maintenanceId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2DomainsMaintenancesMaintenanceId" }, "task": true }, { "name": "getV2CustomersCustomerIdDomainsDomainActions", "summary": "Retrieves a list of the most recent actions for the specified domain", "description": "Retrieves a list of the most recent actions for the specified domain", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain whose actions are to be retrieved: string", "required": true, "schema": { "title": "domain", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "properties": { "type": { "type": "string", "description": "The type of action being performed
  • AUTH_CODE_PURCHASE - Request for an auth code for a .de domain via POST /v2/customers/{customerId}/domains/{domain}/purchaseAuthCode.
  • AUTH_CODE_REGENERATE - Request to regenerate the authCode for a domain via POST /v2/customers/{customerId}/domains/{domain}/regenerateAuthCode
  • AUTO_RENEWAL - A Domain Auto Renew is in progress.
  • BACKORDER_PURCHASE - Request to purchase a domain backorder via POST /v2/customers/{customerId}/domains/backorders/purchase.
  • BACKORDER_DELETE - Request to cancel the current domain backorder via DELETE /v2/customers/{customerId}/domains/backorders/{domain}.
  • BACKORDER_UPDATE - Request update the current domain backorder via PATCH /v2/customers/{customerId}/domains/backorders/{domain}.
  • CONTACT_CREATE - Request to create a contact via POST /v2/customers/{customerId}/domains/contacts.
  • CONTACT_DELETE - Request to delete a contact via DELETE /v2/customers/{customerId}/domains/contacts/{contactId}
  • CONTACT_UPDATE - Request to update a contact via PATCH /v2/customers/{customerId}/domains/contacts/{contactId}
  • DNS_VERIFICATION - Domain requires zone file setup.
  • DNSSEC_CREATE - Request to create DNSSEC record for the domain via PATCH /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
  • DNSSEC_DELETE - Request to delete DNSSEC record for the domain via DELETE /v2/customers/{customerId}/domains/{domain}/dnssecRecords.
  • DOMAIN_DELETE - Request to delete the domain via DELETE /v2/customers/{customerId}/domains/{domain}
  • DOMAIN_UPDATE - Request to update the domain via PATCH /v2/customers/{customerId}/domains/{domain}
  • DOMAIN_UPDATE_CONTACTS -Request to update the domain contacts via PATCH /v2/customers/{customerId}/domains/{domain}/contacts
  • DOMAIN_UPDATE_NAME_SERVERS - Request to update the domain name servers via PUT /v2/customers/{customerId}/domains/{domain}/nameServers
  • EXPIRY - A Domain Expiration is in progress.
  • HOST_CREATE - Request to create a hostname via PUT /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
  • HOST_DELETE - Request to delete a hostname via DELETE /v2/customers/{customerId}/domains/{domain}/hosts/{hostname}
  • ICANN_VERIFICATION - Domain requires registrant verification for Icann.
  • PREMIUM - Premium Domain domain sale is in progress.
  • PRIVACY_PURCHASE - Request to purchase privacy for a domain via POST /v2/customers/{customerId}/domains/{domain}/privacy/purchase
  • PRIVACY_DELETE - Request to remove privacy from a domain via DELETE /v2/customers/{customerId}/domains/{domain}/privacy
  • REDEEM - Request to redeem a domain via POST /v2/customers/{customerId}/domains/{domain}/redeem
  • REGISTER - Request to register a domain via POST /v2/customers/{customerId}/domains/{domain}/register
  • RENEW - Request to renew a domain via POST /v2/customers/{customerId}/domains/{domain}/renew
  • RENEW_UNDO - Request to undo a renewal for a uk domain via POST /v2/customers/{customerId}/domains/{domain}/undoRenew
  • TRADE - A domain trade request is in progress
  • TRADE_CANCEL - Request to cancel a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeCancel
  • TRADE_PURCHASE - Request to purchase a trade for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchase
  • TRADE_PURCHASE_AUTH_TEXT_MESSAGE - Request for a trade purchase text message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradePurchaseAuthorizationTextMessage
  • TRADE_RESEND_AUTH_EMAIL - Request to resend the trade auth email message for a domain via POST /v2/customers/{customerId}/domains/{domain}/tradeResendAuthorizationEmail
  • TRANSFER - Request to transfer a domain via POST /v2/customers/{customerId}/domains/{domain}/transfer
  • TRANSFER_IN - A domain transfer in request is in progress.
  • TRANSFER_IN_CANCEL - Request to cancel a domain transfer via POST /v2/customers/{customerId}/domains/{domain}/transferInCancel
  • TRANSFER_OUT - A domain transfer out request is in progress.
  • TRANSFER_OUT_ACCEPT - Request to accept a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutAccept
  • TRANSFER_OUT_REJECT - Request to reject a transfer out request for a domain via POST /v2/customers/{customerId}/domains/{domain}/transferOutReject
  • TRANSFER_OUT_REQUESTED - Request to transfer out for a domain (.de) via POST /v2/customers/{customerId}/domains/{domain}/transferOut
  • TRANSIT - Request to transit a de or at domain at the registry via POST /v2/customers/{customerId}/domains/{domain}/transit
", "enum": [ "AUTH_CODE_PURCHASE", "AUTH_CODE_REGENERATE", "AUTO_RENEWAL", "BACKORDER_PURCHASE", "BACKORDER_DELETE", "BACKORDER_UPDATE", "CONTACT_CREATE", "CONTACT_DELETE", "CONTACT_UPDATE", "DNS_VERIFICATION", "DNSSEC_CREATE", "DNSSEC_DELETE", "DOMAIN_DELETE", "DOMAIN_UPDATE", "DOMAIN_UPDATE_CONTACTS", "DOMAIN_UPDATE_NAME_SERVERS", "EXPIRY", "HOST_CREATE", "HOST_DELETE", "ICANN_VERIFICATION", "MIGRATE", "MIGRATE_IN", "PREMIUM", "PRIVACY_PURCHASE", "PRIVACY_DELETE", "REDEEM", "REGISTER", "RENEW", "RENEW_UNDO", "TRADE", "TRADE_CANCEL", "TRADE_PURCHASE", "TRADE_PURCHASE_AUTH_TEXT_MESSAGE", "TRADE_RESEND_AUTH_EMAIL", "TRANSFER", "TRANSFER_IN", "TRANSFER_IN_CANCEL", "TRANSFER_OUT", "TRANSFER_OUT_ACCEPT", "TRANSFER_OUT_REJECT", "TRANSFER_OUT_REQUESTED", "TRANSIT" ] }, "origination": { "type": "string", "enum": [ "USER", "SYSTEM" ], "description": "The origination of the action
  • USER - These are user requests.
  • SYSTEM - These are system processing actions.
" }, "createdAt": { "type": "string", "description": "Timestamp indicating when the action was created" }, "startedAt": { "type": "string", "description": "Timestamp indicating when the action was started" }, "completedAt": { "type": "string", "description": "Timestamp indicating when the action was completed" }, "modifiedAt": { "type": "string", "description": "Timestamp indicating when the action was last modified" }, "status": { "type": "string", "default": "ACCEPTED", "enum": [ "ACCEPTED", "AWAITING", "CANCELLED", "FAILED", "PENDING", "SUCCESS" ], "description": "The current status of the action
  • ACCEPTED - The action has been queued, processing has not started.
  • AWAITING - The action is waiting on a user input.
  • CANCELLED - The action has been cancelled by the user.
  • FAILED - An error occurred while the action was processing, no more processing will be performed.
  • PENDING - The action is being processed.
  • SUCCESS - The action has completed, no additional processing is required.
" }, "reason": { "additionalProperties": false, "properties": { "code": { "type": "string", "pattern": "^[A-Z_][A-Z0-9_]*$", "description": "Short identifier, suitable for indicating the reason for the current status and how to handle within client code" }, "message": { "type": "string", "description": "Human-readable, English description of the code" }, "fields": { "type": "array", "items": { "properties": { "code": { "description": "Short identifier for the error, suitable for indicating the specific error within client code", "type": "string" }, "message": { "description": "Human-readable, English description of the problem with the contents of the field", "type": "string" }, "path": { "description": "
    \n
  • JSONPath referring to a field containing an error
    • \nOR\n
  • JSONPath referring to a field that refers to an object containing an error, with more detail in `pathRelated`
    • \n
", "type": "string" }, "pathRelated": { "description": "JSONPath referring to a field containing an error, which is referenced by `path`", "type": "string" } }, "required": [ "path", "code" ] }, "description": "List of the specific fields, and the errors found with their contents" } }, "required": [ "code" ] }, "requestId": { "type": "string", "description": "A client provided identifier (via X-Request-Id header) used for tracking individual requests" } }, "required": [ "type", "origination", "createdAt", "status" ] }, "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2CustomersCustomerIdDomainsDomainActions" }, "task": true }, { "name": "deleteV2CustomersCustomerIdDomainsDomainActionsType", "summary": "Cancel the most recent user action for the specified domain", "description": "Cancel the most recent user action for the specified domain", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain whose action is to be cancelled: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of action to cancel: Must be one of [AUTH_CODE_PURCHASE, AUTH_CODE_REGENERATE, BACKORDER_PURCHASE, BACKORDER_DELETE, BACKORDER_UPDATE, DNSSEC_CREATE, DNSSEC_DELETE, DOMAIN_DELETE, DOMAIN_UPDATE, DOMAIN_UPDATE_CONTACTS, DOMAIN_UPDATE_NAME_SERVERS, MIGRATE, PRIVACY_PURCHASE, PRIVACY_DELETE, REDEEM, REGISTER, RENEW, RENEW_UNDO, TRADE, TRADE_CANCEL, TRADE_PURCHASE, TRADE_PURCHASE_AUTH_TEXT_MESSAGE, TRADE_RESEND_AUTH_EMAIL, TRANSFER, TRANSFER_IN_CANCEL, TRANSFER_OUT_ACCEPT, TRANSFER_OUT_REJECT, TRANSFER_OUT_REQUESTED, TRANSIT]", "required": true, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/deleteV2CustomersCustomerIdDomainsDomainActionsType" }, "task": true }, { "name": "getV2CustomersCustomerIdDomainsDomainActionsType", "summary": "Retrieves the most recent action for the specified domain", "description": "Retrieves the most recent action for the specified domain", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain whose action is to be retrieved: string", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of action to retrieve: Must be one of [AUTH_CODE_PURCHASE, AUTH_CODE_REGENERATE, AUTO_RENEWAL, BACKORDER_PURCHASE, BACKORDER_DELETE, BACKORDER_UPDATE, DNS_VERIFICATION, DNSSEC_CREATE, DNSSEC_DELETE, DOMAIN_DELETE, DOMAIN_UPDATE, DOMAIN_UPDATE_CONTACTS, DOMAIN_UPDATE_NAME_SERVERS, EXPIRY, ICANN_VERIFICATION, MIGRATE, MIGRATE_IN, PREMIUM, PRIVACY_PURCHASE, PRIVACY_DELETE, REDEEM, REGISTER, RENEW, RENEW_UNDO, TRADE, TRADE_CANCEL, TRADE_PURCHASE, TRADE_PURCHASE_AUTH_TEXT_MESSAGE, TRADE_RESEND_AUTH_EMAIL, TRANSFER, TRANSFER_IN, TRANSFER_IN_CANCEL, TRANSFER_OUT, TRANSFER_OUT_ACCEPT, TRANSFER_OUT_REJECT, TRANSFER_OUT_REQUESTED, TRANSIT]", "required": true, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2CustomersCustomerIdDomainsDomainActionsType" }, "task": true }, { "name": "getV2CustomersCustomerIdDomainsNotifications", "summary": "Retrieve the next domain notification", "description": "Retrieve the next domain notification", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2CustomersCustomerIdDomainsNotifications" }, "task": true }, { "name": "getV2CustomersCustomerIdDomainsNotificationsOptIn", "summary": "Retrieve a list of notification types that are opted in", "description": "Retrieve a list of notification types that are opted in", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "properties": { "notificationId": { "description": "The notification ID to be used in POST /v2/customers/{customerId}/domains/notifications to acknowledge the notification", "default": "", "type": "string" }, "type": { "description": "The type of action the notification relates to", "enum": [ "AUTH_CODE_PURCHASE", "AUTH_CODE_REGENERATE", "AUTO_RENEWAL", "BACKORDER", "BACKORDER_PURCHASE", "BACKORDER_DELETE", "BACKORDER_UPDATE", "CONTACT_CREATE", "CONTACT_DELETE", "CONTACT_UPDATE", "DNS_VERIFICATION", "DNSSEC_CREATE", "DNSSEC_DELETE", "DOMAIN_DELETE", "DOMAIN_UPDATE", "DOMAIN_UPDATE_CONTACTS", "DOMAIN_UPDATE_NAME_SERVERS", "EXPIRY", "HOST_CREATE", "HOST_DELETE", "ICANN_VERIFICATION", "MIGRATE", "MIGRATE_IN", "PREMIUM", "PRIVACY_PURCHASE", "PRIVACY_DELETE", "REDEEM", "REGISTER", "RENEW", "RENEW_UNDO", "TRADE", "TRADE_CANCEL", "TRADE_PURCHASE", "TRADE_PURCHASE_AUTH_TEXT_MESSAGE", "TRADE_RESEND_AUTH_EMAIL", "TRANSFER", "TRANSFER_IN", "TRANSFER_IN_CANCEL", "TRANSFER_OUT", "TRANSFER_OUT_ACCEPT", "TRANSFER_OUT_REJECT", "TRANSFER_OUT_REQUESTED", "TRANSIT" ], "type": "string" }, "resource": { "description": "The resource the notification pertains to.", "default": "", "type": "string" }, "resourceType": { "description": "The type of resource the notification relates to", "enum": [ "CONTACT", "DOMAIN", "HOST" ], "type": "string" }, "status": { "type": "string", "enum": [ "AWAITING", "CANCELLED", "FAILED", "PENDING", "SUCCESS" ], "description": "The resulting status of the action." }, "addedAt": { "description": "The date the notification was added", "default": "", "type": "string" }, "requestId": { "type": "string", "description": "A client provided identifier (via X-Request-Id header) indicating the request this notification is for" }, "metadata": { "description": "The notification data for the given type as specifed by GET /v2/customers/{customerId}/domains/notifications/schema", "default": "", "type": "object" } }, "required": [ "notificationId", "type", "resource", "resourceType", "status", "addedAt" ] } } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2CustomersCustomerIdDomainsNotificationsOptIn" }, "task": true }, { "name": "putV2CustomersCustomerIdDomainsNotificationsOptIn", "summary": "Opt in to recieve notifications for the submitted notification types", "description": "Opt in to recieve notifications for the submitted notification types", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "types", "type": "array", "info": "The notification types that should be opted in: array", "required": true, "schema": { "title": "types", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/putV2CustomersCustomerIdDomainsNotificationsOptIn" }, "task": true }, { "name": "getV2CustomersCustomerIdDomainsNotificationsSchemasType", "summary": "Retrieve the schema for the notification data for the specified notification type", "description": "Retrieve the schema for the notification data for the specified notification type", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "type", "type": "string", "info": "The notification type whose schema should be retrieved: Must be one of [AUTO_RENEWAL, BACKORDER, BACKORDER_PURCHASE, EXPIRY, PREMIUM, PRIVACY_PURCHASE, REDEEM, REGISTER, RENEW, TRADE, TRANSFER]", "required": true, "schema": { "title": "type", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getV2CustomersCustomerIdDomainsNotificationsSchemasType" }, "task": true }, { "name": "postV2CustomersCustomerIdDomainsNotificationsNotificationIdAcknowledge", "summary": "Acknowledge a domain notification", "description": "Acknowledge a domain notification", "input": [ { "name": "customerId", "type": "string", "info": "The Customer identifier Note: For API Resellers, performing actions on behalf of your customers, you need to specify the Subaccount you're operating on behalf of; otherw...(description truncated): string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "notificationId", "type": "string", "info": "The notification ID to acknowledge: string", "required": true, "schema": { "title": "notificationId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/postV2CustomersCustomerIdDomainsNotificationsNotificationIdAcknowledge" }, "task": true }, { "name": "listOrders", "summary": "Retrieve a list of orders for the authenticated shopper. Only one filter may be used at a time", "description": "API Resellers This endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header", "input": [ { "name": "periodStart", "type": "string", "info": "Start of range indicating what time-frame should be returned. Inclusive: string", "required": false, "schema": { "title": "periodStart", "type": "string" } }, { "name": "periodEnd", "type": "string", "info": "End of range indicating what time-frame should be returned. Inclusive: string", "required": false, "schema": { "title": "periodEnd", "type": "string" } }, { "name": "domain", "type": "string", "info": "Domain name to use as the filter of results: string", "required": false, "schema": { "title": "domain", "type": "string" } }, { "name": "productGroupId", "type": "number", "info": "Product group id to use as the filter of results: 123", "required": false, "schema": { "title": "productGroupId", "type": "number" } }, { "name": "paymentProfileId", "type": "number", "info": "Payment profile id to use as the filter of results: 123", "required": false, "schema": { "title": "paymentProfileId", "type": "number" } }, { "name": "parentOrderId", "type": "string", "info": "Parent order id to use as the filter of results: string", "required": false, "schema": { "title": "parentOrderId", "type": "string" } }, { "name": "offset", "type": "number", "info": "Number of results to skip for pagination: 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "limit", "type": "number", "info": "Maximum number of items to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "sort", "type": "string", "info": "Property name that will be used to sort results. '-' indicates descending: Must be one of [createdAt, -createdAt, orderId, -orderId, pricing.total, -pricing.total]", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/listOrders" }, "task": true }, { "name": "get", "summary": "Retrieve details for specified order", "description": "API Resellers This endpoint does not support subaccounts and therefore API Resellers should not supply an X-Shopper-Id header", "input": [ { "name": "orderId", "type": "string", "info": "Order id whose details are to be retrieved: string", "required": true, "schema": { "title": "orderId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/get" }, "task": true }, { "name": "getMetrics", "summary": "Returns a list of parking metrics for the specified customer, using specified filters", "description": "Returns a list of parking metrics for the specified customer, using specified filters", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer. A special alias MY is supported when accessing the authenticated customer's own data: string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "periodStartPtz", "type": "string", "info": "Start of range indicating what time-frame should be returned, ***inclusive***. ISO 8601 date `YYYY-MM-DD` in PT. Default value is the day before current date: string", "required": false, "schema": { "title": "periodStartPtz", "type": "string" } }, { "name": "periodEndPtz", "type": "string", "info": "End of range indicating what time-frame should be returned, ***inclusive***. ISO 8601 date `YYYY-MM-DD` in PT. Default value is the day before current date: string", "required": false, "schema": { "title": "periodEndPtz", "type": "string" } }, { "name": "limit", "type": "number", "info": "Maximum number of items to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Number of results to skip for pagination: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getMetrics" }, "task": true }, { "name": "getMetricsByDomain", "summary": "Returns a list of domain metrics for the specified customer and portfolio, using specified filters", "description": "Returns a list of domain metrics for the specified customer and portfolio, using specified filters", "input": [ { "name": "customerId", "type": "string", "info": "An identifier for a customer. A special alias MY is supported when accessing the authenticated customer's own data: string", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "startDate", "type": "string", "info": "Start of range indicating what time-frame should be returned, inclusive. ISO 8601 date YYYY-MM-DD: string", "required": true, "schema": { "title": "startDate", "type": "string" } }, { "name": "endDate", "type": "string", "info": "End of range indicating what time-frame should be returned, inclusive. ISO 8601 date YYYY-MM-DD: string", "required": true, "schema": { "title": "endDate", "type": "string" } }, { "name": "domains", "type": "string", "info": "An array of domains to filter the results. If this filter is not provided, all domains will be returned: string", "required": false, "schema": { "title": "domains", "type": "string" } }, { "name": "domainLike", "type": "string", "info": "represent search keyword filtering domains. If not null, `domains` will be ignored: string", "required": false, "schema": { "title": "domainLike", "type": "string" } }, { "name": "portfolioId", "type": "string", "info": "Unique identifier for the portfolio to filter the results. If not provided, all domains within all porfolios will be returned: string", "required": false, "schema": { "title": "portfolioId", "type": "string" } }, { "name": "limit", "type": "number", "info": "Maximum number of items to return: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "offset", "type": "number", "info": "Number of results to skip for pagination: 123", "required": false, "schema": { "title": "offset", "type": "number" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getMetricsByDomain" }, "task": true }, { "name": "createSubaccount", "summary": "Create a Subaccount owned by the authenticated Reseller", "description": "Create a Subaccount owned by the authenticated Reseller", "input": [ { "name": "subaccount", "type": "object", "info": "The subaccount to create: {\"email\": \"string\", \"externalId\": 123, \"marketId\": \"Must be one of [da-DK, de-AT, de-CH, de-DE, el-GR, en-AE, en-AU, en-CA, en-GB, en-HK, en-IE, en-IL, en-IN, en-MY, en-NZ, en-PH, en-PK, en-SG, en-US, en-ZA, es-AR, es-CL, es-CO, es-ES, es-MX, es-PE, es-US, es-VE, fi-FI, fr-BE, fr-CA, fr-CH, fr-FR, hi-IN, id-ID, it-CH, it-IT, ja-JP, ko-KR, mr-IN, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sv-SE, ta-IN, th-TH, tr-TR, uk-UA, vi-VN, zh-HK, zh-SG, zh-TW]\", \"nameFirst\": \"string\", \"nameLast\": \"string\", \"password\": \"string\"}", "required": true, "schema": { "properties": { "email": { "type": "string" }, "externalId": { "type": "integer" }, "marketId": { "default": "en-US", "type": "string", "maxLength": 50, "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IL", "en-IN", "en-MY", "en-NZ", "en-PH", "en-PK", "en-SG", "en-US", "en-ZA", "es-AR", "es-CL", "es-CO", "es-ES", "es-MX", "es-PE", "es-US", "es-VE", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "id-ID", "it-CH", "it-IT", "ja-JP", "ko-KR", "mr-IN", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ru-RU", "sv-SE", "ta-IN", "th-TH", "tr-TR", "uk-UA", "vi-VN", "zh-HK", "zh-SG", "zh-TW" ] }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "password": { "type": "string" } }, "required": [ "email", "password", "nameFirst", "nameLast" ], "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createSubaccount" }, "task": true }, { "name": "getShopper", "summary": "Get details for the specified Shopper", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "shopperId", "type": "string", "info": "Shopper whose details are to be retrieved: string", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "includes", "type": "array", "info": "Additional properties to be included in the response shopper object: array", "required": false, "schema": { "title": "includes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getShopper" }, "task": true }, { "name": "updateShopper", "summary": "Update details for the specified Shopper", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "shopperId", "type": "string", "info": "The ID of the Shopper to update: string", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "shopper", "type": "object", "info": "The Shopper details to update: {\"email\": \"string\", \"externalId\": 123, \"marketId\": \"Must be one of [da-DK, de-AT, de-CH, de-DE, el-GR, en-AE, en-AU, en-CA, en-GB, en-HK, en-IE, en-IL, en-IN, en-MY, en-NZ, en-PH, en-PK, en-SG, en-US, en-ZA, es-AR, es-CL, es-CO, es-ES, es-MX, es-PE, es-US, es-VE, fi-FI, fr-BE, fr-CA, fr-CH, fr-FR, hi-IN, id-ID, it-CH, it-IT, ja-JP, ko-KR, mr-IN, nb-NO, nl-BE, nl-NL, pl-PL, pt-BR, pt-PT, ru-RU, sv-SE, ta-IN, th-TH, tr-TR, uk-UA, vi-VN, zh-HK, zh-SG, zh-TW]\", \"nameFirst\": \"string\", \"nameLast\": \"string\"}", "required": true, "schema": { "properties": { "email": { "type": "string" }, "externalId": { "type": "integer" }, "marketId": { "type": "string", "maxLength": 50, "enum": [ "da-DK", "de-AT", "de-CH", "de-DE", "el-GR", "en-AE", "en-AU", "en-CA", "en-GB", "en-HK", "en-IE", "en-IL", "en-IN", "en-MY", "en-NZ", "en-PH", "en-PK", "en-SG", "en-US", "en-ZA", "es-AR", "es-CL", "es-CO", "es-ES", "es-MX", "es-PE", "es-US", "es-VE", "fi-FI", "fr-BE", "fr-CA", "fr-CH", "fr-FR", "hi-IN", "id-ID", "it-CH", "it-IT", "ja-JP", "ko-KR", "mr-IN", "nb-NO", "nl-BE", "nl-NL", "pl-PL", "pt-BR", "pt-PT", "ru-RU", "sv-SE", "ta-IN", "th-TH", "tr-TR", "uk-UA", "vi-VN", "zh-HK", "zh-SG", "zh-TW" ] }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateShopper" }, "task": true }, { "name": "delete", "summary": "Request the deletion of a shopper profile", "description": "Notes: Shopper deletion is not supported in OTE **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "shopperId", "type": "string", "info": "The ID of the shopper to delete. Must agree with the shopper id on the token or header, if present. *Note*: **shopperId** is **not the same** as **customerId**. **shoppe...(description truncated): string", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "auditClientIp", "type": "string", "info": "The client IP of the user who originated the request leading to this call.: string", "required": true, "schema": { "title": "auditClientIp", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/delete" }, "task": true }, { "name": "getStatus", "summary": "Get details for the specified Shopper", "description": "Notes: **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "shopperId", "type": "string", "info": "The ID of the shopper to retrieve. Must agree with the shopper id on the token or header, if present: string", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "auditClientIp", "type": "string", "info": "The client IP of the user who originated the request leading to this call.: string", "required": true, "schema": { "title": "auditClientIp", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getStatus" }, "task": true }, { "name": "changePassword", "summary": "Set subaccount's password", "description": "Notes: Password set is only supported by API Resellers setting subaccount passwords. **shopperId** is **not the same** as **customerId**. **shopperId** is a number of max length 10 digits (*ex:* 1234567890) whereas **customerId** is a UUIDv4 (*ex:* 295e3bc3-b3b9-4d95-aae5-ede41a994d13)", "input": [ { "name": "shopperId", "type": "string", "info": "Shopper whose password will be set: string", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "secret", "type": "object", "info": "The value to set the subaccount's password to: {\"secret\": \"string\"}", "required": true, "schema": { "properties": { "secret": { "description": "The secret value used to set a subaccount's password", "type": "string", "example": "P@55w0rd+" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/changePassword" }, "task": true }, { "name": "list", "summary": "Retrieve a list of Subscriptions for the specified Shopper", "description": "Retrieve a list of Subscriptions for the specified Shopper", "input": [ { "name": "productGroupKeys", "type": "array", "info": "Only return Subscriptions with the specified product groups: array", "required": false, "schema": { "title": "productGroupKeys", "type": "array" } }, { "name": "includes", "type": "array", "info": "Optional details to be included in the response: array", "required": false, "schema": { "title": "includes", "type": "array" } }, { "name": "offset", "type": "number", "info": "Number of Subscriptions to skip before starting to return paged results (must be a multiple of the limit): 123", "required": false, "schema": { "title": "offset", "type": "number" } }, { "name": "limit", "type": "number", "info": "Number of Subscriptions to retrieve in this page, starting after offset: 123", "required": false, "schema": { "title": "limit", "type": "number" } }, { "name": "sort", "type": "string", "info": "Property name that will be used to sort results. \"-\" indicates descending: Must be one of [expiresAt, -expiresAt]", "required": false, "schema": { "title": "sort", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/list" }, "task": true }, { "name": "productGroups", "summary": "Retrieve a list of ProductGroups for the specified Shopper", "description": "Retrieve a list of ProductGroups for the specified Shopper", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "items": { "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": "array" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/productGroups" }, "task": true }, { "name": "cancelSubscription", "summary": "Cancel the specified Subscription", "description": "Cancel the specified Subscription", "input": [ { "name": "subscriptionId", "type": "string", "info": "Unique identifier of the Subscription to cancel: string", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/cancelSubscription" }, "task": true }, { "name": "getSubscription", "summary": "Retrieve details for the specified Subscription", "description": "Retrieve details for the specified Subscription", "input": [ { "name": "subscriptionId", "type": "string", "info": "Unique identifier of the Subscription to retrieve: string", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getSubscription" }, "task": true }, { "name": "updateSubscription", "summary": "Update details for the specified Subscription", "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", "input": [ { "name": "subscriptionId", "type": "string", "info": "Unique identifier of the Subscription to update: string", "required": true, "schema": { "title": "subscriptionId", "type": "string" } }, { "name": "subscription", "type": "object", "info": "Details of the Subscription to change: {\"paymentProfileId\": 123, \"renewAuto\": \"boolean\"}", "required": true, "schema": { "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" } }, "definitions": {} } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/updateSubscription" }, "task": true } ], "views": [] }