{ "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, "dceToken": "string", "status": "AWAITING", "createdAt": "string", "modifiedAt": "string", "type": "REGISTRATION_AUTHORITY_DOMAIN_ZONE_CONTROL", "usage": "SUBJECT_ALTERNATIVE_NAME" }, { "domain": "string", "domainEntityId": 9, "dceToken": "string", "status": "PENDING_POSSIBLE_FRAUD", "createdAt": "string", "modifiedAt": "string", "type": "REGISTRATION_AUTHORITY_DOMAIN_ACCESS_LETTER", "usage": "COMMON_NAME" }, { "domain": "string", "domainEntityId": 1, "dceToken": "string", "status": "PENDING_POSSIBLE_FRAUD", "createdAt": "string", "modifiedAt": "string", "type": "WEBSITE_CONTROL", "usage": "SUBJECT_ALTERNATIVE_NAME" } ] } } } }, "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/{domain}": { "get": { "tags": [ "Certificate" ], "operationId": "getDomainDetailsByDomain", "description": "The parameters and request body are for method: getDomainDetailsByDomain. 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" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/certificates/acme/externalAccountBinding": { "get": { "tags": [ "Certificate" ], "operationId": "getAcmeExternalAccountBinding", "description": "The parameters and request body are for method: getAcmeExternalAccountBinding. 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" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/countries": { "get": { "tags": [ "Countries" ], "operationId": "getCountries", "description": "The parameters and request body are for method: getCountries. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "marketId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "regionTypeId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "regionName", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/countries/{countryKey}": { "get": { "tags": [ "Countries" ], "operationId": "getCountry", "description": "The parameters and request body are for method: getCountry. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "countryKey", "in": "path", "required": true, "schema": { "title": "countryKey", "type": "string" } }, { "name": "marketId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "order", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains": { "get": { "tags": [ "Domains" ], "operationId": "listDomains", "description": "The parameters and request body are for method: listDomains. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "authCode": { "type": "string" }, "contactAdmin": { "type": "object", "properties": { "addressMailing": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } } }, "contactBilling": { "type": "object", "properties": { "addressMailing": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } } }, "contactRegistrant": { "type": "object", "properties": { "addressMailing": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } } }, "contactTech": { "type": "object", "properties": { "addressMailing": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "email": { "type": "string" }, "fax": { "type": "string" }, "jobTitle": { "type": "string" }, "nameFirst": { "type": "string" }, "nameLast": { "type": "string" }, "nameMiddle": { "type": "string" }, "organization": { "type": "string" }, "phone": { "type": "string" } } }, "createdAt": { "type": "string" }, "deletedAt": { "type": "string" }, "transferAwayEligibleAt": { "type": "string" }, "domain": { "type": "string" }, "domainId": { "type": "number" }, "expirationProtected": { "type": "boolean" }, "expires": { "type": "string" }, "exposeWhois": { "type": "boolean" }, "holdRegistrar": { "type": "boolean" }, "locked": { "type": "boolean" }, "nameServers": { "type": "array", "items": { "type": "string" } }, "privacy": { "type": "boolean" }, "registrarCreatedAt": { "type": "string" }, "renewAuto": { "type": "boolean" }, "renewDeadline": { "type": "string" }, "renewable": { "type": "boolean" }, "status": { "type": "string" }, "transferProtected": { "type": "boolean" } } } }, "example": [ { "authCode": "string", "contactAdmin": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactBilling": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactRegistrant": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactTech": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "createdAt": "string", "deletedAt": "string", "transferAwayEligibleAt": "string", "domain": "string", "domainId": 4, "expirationProtected": false, "expires": "string", "exposeWhois": false, "holdRegistrar": true, "locked": true, "nameServers": [ "string", "string" ], "privacy": true, "registrarCreatedAt": "string", "renewAuto": false, "renewDeadline": "string", "renewable": true, "status": "string", "transferProtected": true }, { "authCode": "string", "contactAdmin": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactBilling": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactRegistrant": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "contactTech": { "addressMailing": { "address1": "string", "address2": "string", "city": "string", "country": "US", "postalCode": "string", "state": "string" }, "email": "string", "fax": "string", "jobTitle": "string", "nameFirst": "string", "nameLast": "string", "nameMiddle": "string", "organization": "string", "phone": "string" }, "createdAt": "string", "deletedAt": "string", "transferAwayEligibleAt": "string", "domain": "string", "domainId": 2, "expirationProtected": false, "expires": "string", "exposeWhois": true, "holdRegistrar": false, "locked": true, "nameServers": [ "string", "string", "string", "string", "string", "string" ], "privacy": true, "registrarCreatedAt": "string", "renewAuto": true, "renewDeadline": "string", "renewable": false, "status": "string", "transferProtected": true } ] } } } }, "parameters": [ { "name": "statuses", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "statusGroups", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "marker", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "modifiedDate", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/agreements": { "get": { "tags": [ "Domains" ], "operationId": "getAgreement", "description": "The parameters and request body are for method: getAgreement. 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": "tlds", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "privacy", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "forTransfer", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/available": { "get": { "tags": [ "Domains" ], "operationId": "available", "description": "The parameters and request body are for method: available. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "checkType", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "forTransfer", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Domains" ], "operationId": "availableBulk", "description": "The parameters and request body are for method: availableBulk. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "checkType", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domains": { "type": "string" } } }, "example": { "domains": "domains" } } } } } }, "/v1/domains/contacts/validate": { "post": { "tags": [ "Domains" ], "operationId": "contactsValidate", "description": "The parameters and request body are for method: contactsValidate. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "marketId", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/purchase": { "post": { "tags": [ "Domains" ], "operationId": "purchase", "description": "The parameters and request body are for method: purchase. 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/domains/purchase/schema/{tld}": { "get": { "tags": [ "Domains" ], "operationId": "schema", "description": "The parameters and request body are for method: schema. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "tld", "in": "path", "required": true, "schema": { "title": "tld", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/purchase/validate": { "post": { "tags": [ "Domains" ], "operationId": "validate", "description": "The parameters and request body are for method: validate. 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/domains/suggest": { "get": { "tags": [ "Domains" ], "operationId": "suggest", "description": "The parameters and request body are for method: suggest. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" } } } }, "example": [ { "domain": "string" }, { "domain": "string" }, { "domain": "string" } ] } } } }, "parameters": [ { "name": "query", "in": "query", "required": false, "schema": { "type": "object" } }, { "name": "query", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "country", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "city", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sources", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "tlds", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lengthMax", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "lengthMin", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "waitMs", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/tlds": { "get": { "tags": [ "Domains" ], "operationId": "tlds", "description": "The parameters and request body are for method: tlds. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } } } }, "example": [ { "name": "string", "type": "GENERIC" }, { "name": "string", "type": "GENERIC" }, { "name": "string", "type": "GENERIC" } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/{domain}": { "delete": { "tags": [ "Domains" ], "operationId": "cancel", "description": "The parameters and request body are for method: cancel. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "get": { "tags": [ "Domains" ], "operationId": "getDomain", "description": "The parameters and request body are for method: getDomain. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Domains" ], "operationId": "update", "description": "The parameters and request body are for method: update. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{domain}/contacts": { "patch": { "tags": [ "Domains" ], "operationId": "updateContacts", "description": "The parameters and request body are for method: updateContacts. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "contacts" } } } } }, "/v1/domains/{domain}/privacy": { "delete": { "tags": [ "Domains" ], "operationId": "cancelPrivacy", "description": "The parameters and request body are for method: cancelPrivacy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/{domain}/privacy/purchase": { "post": { "tags": [ "Domains" ], "operationId": "purchasePrivacy", "description": "The parameters and request body are for method: purchasePrivacy. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{domain}/records": { "patch": { "tags": [ "Domains" ], "operationId": "recordAdd", "description": "The parameters and request body are for method: recordAdd. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "records" } } } }, "put": { "tags": [ "Domains" ], "operationId": "recordReplace", "description": "The parameters and request body are for method: recordReplace. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "records" } } } } }, "/v1/domains/{domain}/records/{type}/{name}": { "get": { "tags": [ "Domains" ], "operationId": "recordGet", "description": "The parameters and request body are for method: recordGet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "data": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "number" }, "priority": { "type": "number" }, "protocol": { "type": "string" }, "service": { "type": "string" }, "ttl": { "type": "number" }, "type": { "type": "string" }, "weight": { "type": "number" } } } }, "example": [ { "data": "string", "name": "string", "port": 3, "priority": 8, "protocol": "string", "service": "string", "ttl": 10, "type": "A", "weight": 7 }, { "data": "string", "name": "string", "port": 1, "priority": 2, "protocol": "string", "service": "string", "ttl": 5, "type": "TXT", "weight": 2 } ] } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "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": {} } } } }, "put": { "tags": [ "Domains" ], "operationId": "recordReplaceTypeName", "description": "The parameters and request body are for method: recordReplaceTypeName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "records" } } } }, "delete": { "tags": [ "Domains" ], "operationId": "recordDeleteTypeName", "description": "The parameters and request body are for method: recordDeleteTypeName. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } }, { "name": "name", "in": "path", "required": true, "schema": { "title": "name", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/domains/{domain}/records/{type}": { "put": { "tags": [ "Domains" ], "operationId": "recordReplaceType", "description": "The parameters and request body are for method: recordReplaceType. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "records" } } } } }, "/v1/domains/{domain}/renew": { "post": { "tags": [ "Domains" ], "operationId": "renew", "description": "The parameters and request body are for method: renew. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{domain}/transfer": { "post": { "tags": [ "Domains" ], "operationId": "transferIn", "description": "The parameters and request body are for method: transferIn. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v1/domains/{domain}/verifyRegistrantEmail": { "post": { "tags": [ "Domains" ], "operationId": "verifyEmail", "description": "The parameters and request body are for method: verifyEmail. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/{domain}": { "get": { "tags": [ "Domains" ], "operationId": "getV2CustomersCustomerIdDomainsDomain", "description": "The parameters and request body are for method: getV2CustomersCustomerIdDomainsDomain. 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": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "includes", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/{domain}/redeem": { "post": { "tags": [ "Domains" ], "operationId": "postV2CustomersCustomerIdDomainsDomainRedeem", "description": "The parameters and request body are for method: postV2CustomersCustomerIdDomainsDomainRedeem. 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": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/customers/{customerId}/domains/{domain}/transferOut": { "post": { "tags": [ "Domains" ], "operationId": "postV2CustomersCustomerIdDomainsDomainTransferOut", "description": "The parameters and request body are for method: postV2CustomersCustomerIdDomainsDomainTransferOut. 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": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "registrar", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/forwards/{fqdn}": { "delete": { "tags": [ "Domains" ], "operationId": "domainsForwardsDelete", "description": "The parameters and request body are for method: domainsForwardsDelete. 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": "fqdn", "in": "path", "required": true, "schema": { "title": "fqdn", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "get": { "tags": [ "Domains" ], "operationId": "domainsForwardsGet", "description": "The parameters and request body are for method: domainsForwardsGet. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "fqdn": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "mask": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "keywords": { "type": "string" } } } } } }, "example": [ { "fqdn": "string", "type": "REDIRECT_PERMANENT", "url": "string", "mask": { "title": "string", "description": "string", "keywords": "string" } } ] } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "fqdn", "in": "path", "required": true, "schema": { "title": "fqdn", "type": "string" } }, { "name": "includeSubs", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Domains" ], "operationId": "domainsForwardsPut", "description": "The parameters and request body are for method: domainsForwardsPut. 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": "fqdn", "in": "path", "required": true, "schema": { "title": "fqdn", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } }, "post": { "tags": [ "Domains" ], "operationId": "domainsForwardsPost", "description": "The parameters and request body are for method: domainsForwardsPost. 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": "fqdn", "in": "path", "required": true, "schema": { "title": "fqdn", "type": "string" } } ], "requestBody": { "description": "indeterminate body object", "content": { "application/json": { "schema": { "type": "object" } } } } } }, "/v2/domains/maintenances": { "get": { "tags": [ "Domains" ], "operationId": "getV2DomainsMaintenances", "description": "The parameters and request body are for method: getV2DomainsMaintenances. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "status", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "modifiedAtAfter", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "startsAtAfter", "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/domains/maintenances/{maintenanceId}": { "get": { "tags": [ "Domains" ], "operationId": "getV2DomainsMaintenancesMaintenanceId", "description": "The parameters and request body are for method: getV2DomainsMaintenancesMaintenanceId. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "maintenanceId", "in": "path", "required": true, "schema": { "title": "maintenanceId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/{domain}/actions": { "get": { "tags": [ "Actions" ], "operationId": "getV2CustomersCustomerIdDomainsDomainActions", "description": "The parameters and request body are for method: getV2CustomersCustomerIdDomainsDomainActions. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "origination": { "type": "string" }, "createdAt": { "type": "string" }, "startedAt": { "type": "string" }, "completedAt": { "type": "string" }, "modifiedAt": { "type": "string" }, "status": { "type": "string" }, "reason": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "path": { "type": "string" }, "pathRelated": { "type": "string" } } } } } }, "requestId": { "type": "string" } } } }, "example": [ { "type": "TRADE_CANCEL", "origination": "USER", "createdAt": "string", "startedAt": "string", "completedAt": "string", "modifiedAt": "string", "status": "ACCEPTED", "reason": { "code": "string", "message": "string", "fields": [ { "code": "string", "message": "string", "path": "string", "pathRelated": "string" }, { "code": "string", "message": "string", "path": "string", "pathRelated": "string" } ] }, "requestId": "string" }, { "type": "TRADE", "origination": "USER", "createdAt": "string", "startedAt": "string", "completedAt": "string", "modifiedAt": "string", "status": "ACCEPTED", "reason": { "code": "string", "message": "string", "fields": [ { "code": "string", "message": "string", "path": "string", "pathRelated": "string" }, { "code": "string", "message": "string", "path": "string", "pathRelated": "string" }, { "code": "string", "message": "string", "path": "string", "pathRelated": "string" } ] }, "requestId": "string" }, { "type": "TRANSFER_OUT_REJECT", "origination": "USER", "createdAt": "string", "startedAt": "string", "completedAt": "string", "modifiedAt": "string", "status": "ACCEPTED", "reason": { "code": "string", "message": "string", "fields": [ { "code": "string", "message": "string", "path": "string", "pathRelated": "string" } ] }, "requestId": "string" }, { "type": "TRANSFER_OUT_ACCEPT", "origination": "USER", "createdAt": "string", "startedAt": "string", "completedAt": "string", "modifiedAt": "string", "status": "ACCEPTED", "reason": { "code": "string", "message": "string", "fields": [ { "code": "string", "message": "string", "path": "string", "pathRelated": "string" }, { "code": "string", "message": "string", "path": "string", "pathRelated": "string" }, { "code": "string", "message": "string", "path": "string", "pathRelated": "string" }, { "code": "string", "message": "string", "path": "string", "pathRelated": "string" } ] }, "requestId": "string" } ] } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "title": "customerId", "type": "string" } }, { "name": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/{domain}/actions/{type}": { "delete": { "tags": [ "Actions" ], "operationId": "deleteV2CustomersCustomerIdDomainsDomainActionsType", "description": "The parameters and request body are for method: deleteV2CustomersCustomerIdDomainsDomainActionsType. 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": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "get": { "tags": [ "Actions" ], "operationId": "getV2CustomersCustomerIdDomainsDomainActionsType", "description": "The parameters and request body are for method: getV2CustomersCustomerIdDomainsDomainActionsType. 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": "domain", "in": "path", "required": true, "schema": { "title": "domain", "type": "string" } }, { "name": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/notifications": { "get": { "tags": [ "Notifications" ], "operationId": "getV2CustomersCustomerIdDomainsNotifications", "description": "The parameters and request body are for method: getV2CustomersCustomerIdDomainsNotifications. 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" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/notifications/optIn": { "get": { "tags": [ "Notifications" ], "operationId": "getV2CustomersCustomerIdDomainsNotificationsOptIn", "description": "The parameters and request body are for method: getV2CustomersCustomerIdDomainsNotificationsOptIn. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "notificationId": { "type": "string" }, "type": { "type": "string" }, "resource": { "type": "string" }, "resourceType": { "type": "string" }, "status": { "type": "string" }, "addedAt": { "type": "string" }, "requestId": { "type": "string" }, "metadata": { "type": "object" } } } }, "example": [ { "notificationId": "string", "type": "RENEW_UNDO", "resource": "string", "resourceType": "DOMAIN", "status": "PENDING", "addedAt": "string", "requestId": "string", "metadata": {} }, { "notificationId": "string", "type": "EXPIRY", "resource": "string", "resourceType": "HOST", "status": "FAILED", "addedAt": "string", "requestId": "string", "metadata": {} }, { "notificationId": "string", "type": "REGISTER", "resource": "string", "resourceType": "CONTACT", "status": "PENDING", "addedAt": "string", "requestId": "string", "metadata": {} } ] } } } }, "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "title": "customerId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "put": { "tags": [ "Notifications" ], "operationId": "putV2CustomersCustomerIdDomainsNotificationsOptIn", "description": "The parameters and request body are for method: putV2CustomersCustomerIdDomainsNotificationsOptIn. 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": "types", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/notifications/schemas/{type}": { "get": { "tags": [ "Notifications" ], "operationId": "getV2CustomersCustomerIdDomainsNotificationsSchemasType", "description": "The parameters and request body are for method: getV2CustomersCustomerIdDomainsNotificationsSchemasType. 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": "type", "in": "path", "required": true, "schema": { "title": "type", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v2/customers/{customerId}/domains/notifications/{notificationId}/acknowledge": { "post": { "tags": [ "Notifications" ], "operationId": "postV2CustomersCustomerIdDomainsNotificationsNotificationIdAcknowledge", "description": "The parameters and request body are for method: postV2CustomersCustomerIdDomainsNotificationsNotificationIdAcknowledge. 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": "notificationId", "in": "path", "required": true, "schema": { "title": "notificationId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/orders": { "get": { "tags": [ "Orders" ], "operationId": "listOrders", "description": "The parameters and request body are for method: listOrders. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "periodStart", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "periodEnd", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "domain", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "productGroupId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "paymentProfileId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "parentOrderId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/orders/{orderId}": { "get": { "tags": [ "Orders" ], "operationId": "get", "description": "The parameters and request body are for method: get. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "title": "orderId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/customers/{customerId}/parking/metrics": { "get": { "tags": [ "Parking" ], "operationId": "getMetrics", "description": "The parameters and request body are for method: getMetrics. 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": "periodStartPtz", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "periodEndPtz", "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": {} } } } } }, "/v1/customers/{customerId}/parking/metricsByDomain": { "get": { "tags": [ "Parking" ], "operationId": "getMetricsByDomain", "description": "The parameters and request body are for method: getMetricsByDomain. 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": "startDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "endDate", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "domains", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "domainLike", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "portfolioId", "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": {} } } } } }, "/v1/shoppers/subaccount": { "post": { "tags": [ "Shoppers" ], "operationId": "createSubaccount", "description": "The parameters and request body are for method: createSubaccount. 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": "subaccount" } } } } }, "/v1/shoppers/{shopperId}": { "get": { "tags": [ "Shoppers" ], "operationId": "getShopper", "description": "The parameters and request body are for method: getShopper. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "shopperId", "in": "path", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "includes", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "post": { "tags": [ "Shoppers" ], "operationId": "updateShopper", "description": "The parameters and request body are for method: updateShopper. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "shopperId", "in": "path", "required": true, "schema": { "title": "shopperId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "shopper" } } } }, "delete": { "tags": [ "Shoppers" ], "operationId": "delete", "description": "The parameters and request body are for method: delete. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "shopperId", "in": "path", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "auditClientIp", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/shoppers/{shopperId}/status": { "get": { "tags": [ "Shoppers" ], "operationId": "getStatus", "description": "The parameters and request body are for method: getStatus. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "shopperId", "in": "path", "required": true, "schema": { "title": "shopperId", "type": "string" } }, { "name": "auditClientIp", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/shoppers/{shopperId}/factors/password": { "put": { "tags": [ "Shoppers" ], "operationId": "changePassword", "description": "The parameters and request body are for method: changePassword. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "shopperId", "in": "path", "required": true, "schema": { "title": "shopperId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "secret" } } } } }, "/v1/subscriptions": { "get": { "tags": [ "Subscriptions" ], "operationId": "list", "description": "The parameters and request body are for method: list. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "productGroupKeys", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "includes", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "offset", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "sort", "in": "query", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/subscriptions/productGroups": { "get": { "tags": [ "Subscriptions" ], "operationId": "productGroups", "description": "The parameters and request body are for method: productGroups. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "productGroupKey": { "type": "string" }, "subscriptionCount": { "type": "number" } } } }, "example": [ { "productGroupKey": "string", "subscriptionCount": 4 }, { "productGroupKey": "string", "subscriptionCount": 4 } ] } } } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } } }, "/v1/subscriptions/{subscriptionId}": { "delete": { "tags": [ "Subscriptions" ], "operationId": "cancelSubscription", "description": "The parameters and request body are for method: cancelSubscription. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "get": { "tags": [ "Subscriptions" ], "operationId": "getSubscription", "description": "The parameters and request body are for method: getSubscription. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object" }, "example": {} } } } }, "patch": { "tags": [ "Subscriptions" ], "operationId": "updateSubscription", "description": "The parameters and request body are for method: updateSubscription. Same endpoint also used in methods:", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "title": "result", "type": "object" } } } } }, "parameters": [ { "name": "subscriptionId", "in": "path", "required": true, "schema": { "title": "subscriptionId", "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "string" }, "example": "subscription" } } } } } }, "components": { "schemas": {} } }