@itentialopensource/adapter-godaddy

{ "openapi": "3.1.0", "info": { "title": "", "version": "1.0.0" }, "paths": { "/v1/aftermarket/listings": { "delete": { "tags": [ "Aftermarket" ], "operationId": "deleteListings", "description": "The parameters and request body are for method: deleteListings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domains", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/aftermarket/listings/expiry": { "post": { "tags": [ "Aftermarket" ], "operationId": "addExpiryListings", "description": "The parameters and request body are for method: addExpiryListings. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "expiryListings": { "type": "string" } } }, "example": { "expiryListings": "expiryListings" } } } } } }, "/v1/abuse/tickets": { "get": { "tags": [ "Abuse" ], "operationId": "getTickets", "description": "The parameters and request body are for method: getTickets. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "type", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "closed", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sourceDomainOrIp", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "target", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdStart", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "createdEnd", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Abuse" ], "operationId": "createTicket", "description": "The parameters and request body are for method: createTicket. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/abuse/tickets/{ticketId}": { "get": { "tags": [ "Abuse" ], "operationId": "getTicketInfo", "description": "The parameters and request body are for method: getTicketInfo. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "ticketId", "in": "path", "required": true, "schema": { "title": "ticketId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/agreements": { "get": { "tags": [ "Agreements" ], "operationId": "getAgreements", "description": "The parameters and request body are for method: getAgreements. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "agreementKey": { "type": "string" }, "content": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" } } } }, "example": [ { "agreementKey": "string", "content": "string", "title": "string", "url": "string" } ] } } } }, "parameters": [ { "name": "keys", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates": { "post": { "tags": [ "Certificate" ], "operationId": "certificateCreate", "description": "The parameters and request body are for method: certificateCreate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "certificateCreate" } } } } }, "/v1/certificates/validate": { "post": { "tags": [ "Certificate" ], "operationId": "certificateValidate", "description": "The parameters and request body are for method: certificateValidate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "certificateCreate" } } } } }, "/v1/certificates/{certificateId}": { "get": { "tags": [ "Certificate" ], "operationId": "certificateGet", "description": "The parameters and request body are for method: certificateGet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/actions": { "get": { "tags": [ "Certificate" ], "operationId": "certificateActionRetrieve", "description": "The parameters and request body are for method: certificateActionRetrieve. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/email/{emailId}/resend": { "post": { "tags": [ "Certificate" ], "operationId": "certificateResendEmail", "description": "The parameters and request body are for method: certificateResendEmail. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "emailId", "in": "path", "required": true, "schema": { "title": "emailId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/email/resend/{emailAddress}": { "post": { "tags": [ "Certificate" ], "operationId": "certificateAlternateEmailAddress", "description": "The parameters and request body are for method: certificateAlternateEmailAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "emailAddress", "in": "path", "required": true, "schema": { "title": "emailAddress", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/email/{emailId}/resend/{emailAddress}": { "post": { "tags": [ "Certificate" ], "operationId": "certificateResendEmailAddress", "description": "The parameters and request body are for method: certificateResendEmailAddress. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "emailId", "in": "path", "required": true, "schema": { "title": "emailId", "type": "string" } }, { "name": "emailAddress", "in": "path", "required": true, "schema": { "title": "emailAddress", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/email/history": { "get": { "tags": [ "Certificate" ], "operationId": "certificateEmailHistory", "description": "The parameters and request body are for method: certificateEmailHistory. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/callback": { "delete": { "tags": [ "Certificate" ], "operationId": "certificateCallbackDelete", "description": "The parameters and request body are for method: certificateCallbackDelete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "get": { "tags": [ "Certificate" ], "operationId": "certificateCallbackGet", "description": "The parameters and request body are for method: certificateCallbackGet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Certificate" ], "operationId": "certificateCallbackReplace", "description": "The parameters and request body are for method: certificateCallbackReplace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "callbackUrl", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/cancel": { "post": { "tags": [ "Certificate" ], "operationId": "certificateCancel", "description": "The parameters and request body are for method: certificateCancel. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/download": { "get": { "tags": [ "Certificate" ], "operationId": "certificateDownload", "description": "The parameters and request body are for method: certificateDownload. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/reissue": { "post": { "tags": [ "Certificate" ], "operationId": "certificateReissue", "description": "The parameters and request body are for method: certificateReissue. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "reissueCreate" } } } } }, "/v1/certificates/{certificateId}/renew": { "post": { "tags": [ "Certificate" ], "operationId": "certificateRenew", "description": "The parameters and request body are for method: certificateRenew. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "renewCreate" } } } } }, "/v1/certificates/{certificateId}/revoke": { "post": { "tags": [ "Certificate" ], "operationId": "certificateRevoke", "description": "The parameters and request body are for method: certificateRevoke. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "certificateRevoke" } } } } }, "/v1/certificates/{certificateId}/siteSeal": { "get": { "tags": [ "Certificate" ], "operationId": "certificateSitesealGet", "description": "The parameters and request body are for method: certificateSitesealGet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } }, { "name": "theme", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "locale", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/certificates/{certificateId}/verifyDomainControl": { "post": { "tags": [ "Certificate" ], "operationId": "certificateVerifydomaincontrol", "description": "The parameters and request body are for method: certificateVerifydomaincontrol. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/certificates": { "get": { "tags": [ "Certificate" ], "operationId": "certificateGetEntitlement", "description": "The parameters and request body are for method: certificateGetEntitlement. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "certificateId": { "type": "string" }, "commonName": { "type": "string" }, "contact": { "type": "object", "properties": { "email": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "phone": { "type": "string" }, "suffix": { "type": "string" } } }, "createdAt": { "type": "string" }, "deniedReason": { "type": "string" }, "organization": { "type": "object", "properties": { "address": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "assumedName": { "type": "string" }, "jurisdictionOfIncorporation": { "type": "object", "properties": { "city": { "type": "string" }, "country": { "type": "string" }, "county": { "type": "string" }, "state": { "type": "string" } } }, "name": { "type": "string" }, "phone": { "type": "string" }, "registrationAgent": { "type": "string" }, "registrationNumber": { "type": "string" } } }, "period": { "type": "number" }, "productType": { "type": "string" }, "progress": { "type": "number" }, "revokedAt": { "type": "string" }, "rootType": { "type": "string" }, "serialNumber": { "type": "string" }, "serialNumberHex": { "type": "string" }, "slotSize": { "type": "string" }, "status": { "type": "string" }, "subjectAlternativeNames": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "subjectAlternativeName": { "type": "string" } } } }, "validEnd": { "type": "string" }, "validStart": { "type": "string" } } } }, "example": [ { "certificateId": "string", "commonName": "string", "contact": { "email": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "phone": "string", "suffix": "string" }, "createdAt": "string", "deniedReason": "string", "organization": { "address": { "address1": "string", "address2": "string", "city": "string", "country": "IE", "postalCode": "string", "state": "string" }, "assumedName": "string", "jurisdictionOfIncorporation": { "city": "string", "country": "string", "county": "string", "state": "string" }, "name": "string", "phone": "string", "registrationAgent": "string", "registrationNumber": "string" }, "period": 4, "productType": "OV_CS", "progress": 2, "revokedAt": "string", "rootType": "STARFIELD_SHA_2", "serialNumber": "string", "serialNumberHex": "string", "slotSize": "TWENTY", "status": "PENDING_REVOCATION", "subjectAlternativeNames": [ { "status": "COMPLETED", "subjectAlternativeName": "string" }, { "status": "INVALID", "subjectAlternativeName": "string" }, { "status": "PENDING", "subjectAlternativeName": "string" }, { "status": "PENDING", "subjectAlternativeName": "string" }, { "status": "PENDING", "subjectAlternativeName": "string" } ], "validEnd": "string", "validStart": "string" }, { "certificateId": "string", "commonName": "string", "contact": { "email": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "phone": "string", "suffix": "string" }, "createdAt": "string", "deniedReason": "string", "organization": { "address": { "address1": "string", "address2": "string", "city": "string", "country": "TH", "postalCode": "string", "state": "string" }, "assumedName": "string", "jurisdictionOfIncorporation": { "city": "string", "country": "string", "county": "string", "state": "string" }, "name": "string", "phone": "string", "registrationAgent": "string", "registrationNumber": "string" }, "period": 3, "productType": "DV_WILDCARD_SSL", "progress": 4, "revokedAt": "string", "rootType": "GODADDY_SHA_1", "serialNumber": "string", "serialNumberHex": "string", "slotSize": "ONE_HUNDRED", "status": "EXPIRED", "subjectAlternativeNames": [ { "status": "INVALID", "subjectAlternativeName": "string" }, { "status": "FRAUD", "subjectAlternativeName": "string" }, { "status": "PENDING", "subjectAlternativeName": "string" }, { "status": "FRAUD", "subjectAlternativeName": "string" }, { "status": "INVALID", "subjectAlternativeName": "string" }, { "status": "FRAUD", "subjectAlternativeName": "string" }, { "status": "FRAUD", "subjectAlternativeName": "string" }, { "status": "FRAUD", "subjectAlternativeName": "string" } ], "validEnd": "string", "validStart": "string" }, { "certificateId": "string", "commonName": "string", "contact": { "email": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "phone": "string", "suffix": "string" }, "createdAt": "string", "deniedReason": "string", "organization": { "address": { "address1": "string", "address2": "string", "city": "string", "country": "NF", "postalCode": "string", "state": "string" }, "assumedName": "string", "jurisdictionOfIncorporation": { "city": "string", "country": "string", "county": "string", "state": "string" }, "name": "string", "phone": "string", "registrationAgent": "string", "registrationNumber": "string" }, "period": 3, "productType": "OV_SSL", "progress": 5, "revokedAt": "string", "rootType": "STARFIELD_SHA_2", "serialNumber": "string", "serialNumberHex": "string", "slotSize": "ONE_HUNDRED", "status": "PENDING_REKEY", "subjectAlternativeNames": [ { "status": "COMPLETED", "subjectAlternativeName": "string" } ], "validEnd": "string", "validStart": "string" } ] } } } }, "parameters": [ { "name": "entitlementId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "latest", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/certificates/download": { "get": { "tags": [ "Certificate" ], "operationId": "certificateDownloadEntitlement", "description": "The parameters and request body are for method: certificateDownloadEntitlement. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "entitlementId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/certificates": { "get": { "tags": [ "Certificate" ], "operationId": "getCustomerCertificatesByCustomerId", "description": "The parameters and request body are for method: getCustomerCertificatesByCustomerId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/certificates/{certificateId}": { "get": { "tags": [ "Certificate" ], "operationId": "getCertificateDetailByCertIdentifier", "description": "The parameters and request body are for method: getCertificateDetailByCertIdentifier. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "certificateId", "in": "path", "required": true, "schema": { "title": "certificateId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/certificates/{certificateId}/domainVerifications": { "get": { "tags": [ "Certificate" ], "operationId": "getDomainInformationByCertificateId", "description": "The parameters and request body are for method: getDomainInformationByCertificateId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "domainEntityId": { "type": "number" }, "dceToken": { "type": "string" }, "status": { "type": "string" }, "createdAt": { "type": "string" }, "modifiedAt": { "type": "string" }, "type": { "type": "string" }, "usage": { "type": "string" } } } }, "example": [ { "domain": "string", "domainEntityId": 7,