{"note":"OpenAPI conversion -- returning structured metadata","name":"ote-godaddy-com-certificates","description":"spec","version":"unknown","base_url":"https://api.ote-godaddy.com","endpoints":28,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api spec\n@base https://api.ote-godaddy.com\n@endpoints 28\n@hint download_for_search\n@toc certificates(23), customers(5)\n\n@group certificates\n@endpoint POST /v1/certificates\n@desc Create a pending order for certificate\n@required {certificateCreate: any # The certificate order information}\n@optional {X-Market-Id: any # Setting locale for communications such as emails and error messages}\n@returns(202) Request was successful\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 409: Certificate state does not allow renew, 422: `email` is not empty<br>`csr` is invalid, 500: Internal server error}\n\n@endpoint POST /v1/certificates/validate\n@desc Validate a pending order for certificate\n@required {certificateCreate: any # The certificate order info}\n@optional {X-Market-Id: any # Setting locale for communications such as emails and error messages}\n@returns(204) Request validated successfully\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 409: Certificate state does not allow renew, 422: `email` is not empty <br> `csr` is invalid, 500: Internal server error}\n\n@endpoint GET /v1/certificates/{certificateId}\n@desc Retrieve certificate details\n@required {certificateId: any # Certificate id to lookup}\n@returns(200) Certificate details retrieved\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 500: Internal server error}\n\n@endpoint GET /v1/certificates/{certificateId}/actions\n@desc Retrieve all certificate actions\n@required {certificateId: any # Certificate id to register for callback}\n@returns(200) Action retrieval successful\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate not found, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/email/{emailId}/resend\n@desc Resend an email\n@required {certificateId: any # Certificate id to resend email, emailId: any # Email id for email to resend}\n@returns(204) Email sent successfully\n@errors {404: Certificate not found, 409: Email Id not found, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/email/resend/{emailAddress}\n@desc Add alternate email address\n@required {certificateId: any # Certificate id to resend emails, emailAddress: any # Specific email address to resend email}\n@returns(200) Alternate email address added and emails re-sent\n@errors {404: Certificate not found, 409: Certificate state does not allow alternate email address, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/email/{emailId}/resend/{emailAddress}\n@desc Resend email to email address\n@required {certificateId: any # Certificate id to resend emails, emailId: any # Email id for email to resend, emailAddress: any # Specific email address to resend email}\n@returns(204) Email sent successfully\n@errors {404: Certificate not found, 409: Email Id not found, 500: Internal server error}\n\n@endpoint GET /v1/certificates/{certificateId}/email/history\n@desc Retrieve email history\n@required {certificateId: any # Certificate id to retrieve email history}\n@returns(200) Email history retrieval successful\n@errors {409: Email history not found, 500: Internal server error}\n\n@endpoint DELETE /v1/certificates/{certificateId}/callback\n@desc Unregister system callback\n@required {certificateId: any # Certificate id to unregister callback}\n@returns(204) Callback removed\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 500: Internal server error}\n\n@endpoint GET /v1/certificates/{certificateId}/callback\n@desc Retrieve system stateful action callback url\n@required {certificateId: any # Certificate id to register for stateful action callback}\n@returns(200) Callback registered\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 500: Internal server error}\n\n@endpoint PUT /v1/certificates/{certificateId}/callback\n@desc Register of certificate action callback\n@required {certificateId: any # Certificate id to register/replace for callback, callbackUrl: any # Callback url registered/replaced to receive stateful actions}\n@returns(204) Callback replaced/registered\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 422: Callback url is missing <br> Callback url is malformed, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/cancel\n@desc Cancel a pending certificate\n@required {certificateId: any # Certificate id to cancel}\n@returns(204) Certificate order has been canceled\n@errors {401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Certificate state does not allow cancel, 500: Internal server error}\n\n@endpoint GET /v1/certificates/{certificateId}/download\n@desc Download certificate\n@required {certificateId: any # Certificate id to download}\n@returns(200) Certificate retrieved\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Certificate state does not allow download, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/reissue\n@desc Reissue active certificate\n@required {certificateId: any # Certificate id to reissue, reissueCreate: any # The reissue request info}\n@returns(202) Reissue request created\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Certificate state does not allow reissue, 422: `csr` is invalid<br>Delay revocation exceeds maximum, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/renew\n@desc Renew active certificate\n@required {certificateId: any # Certificate id to renew, renewCreate: any # The renew request info}\n@returns(202) Renew request created\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Certificate state does not allow renew, 422: `csr` is invalid, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/revoke\n@desc Revoke active certificate\n@required {certificateId: any # Certificate id to revoke, certificateRevoke: any # The certificate revocation request}\n@returns(204) Certificate Revoked\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Certificate state does not allow revoke, 500: Internal server error}\n\n@endpoint GET /v1/certificates/{certificateId}/siteSeal\n@desc Get Site seal\n@required {certificateId: any # Certificate id}\n@optional {theme: any # This value represents the visual theme of the seal. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present., locale: any # Determine locale for text displayed in seal image and verification page. If seal doesn't exist, default values are used if params not present. If seal does exist, default values will not be used to update unless params present.}\n@returns(200) Site seal retrieved\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Certificate state does not allow seal, 422: 'locale' is invalid, 500: Internal server error}\n\n@endpoint POST /v1/certificates/{certificateId}/verifyDomainControl\n@desc Check Domain Control\n@required {certificateId: any # Certificate id to lookup}\n@returns(204) Domain control was successful\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Certificate id not found, 409: Domain control was not successful <br> Certificate state does not allow domain control, 500: Internal server error}\n\n@endpoint GET /v2/certificates\n@desc Search for certificate details by entitlement\n@required {entitlementId: any # Entitlement id to lookup}\n@optional {latest: any # Fetch only the most recent certificate}\n@returns(200) Certificate details retrieved\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 422: Entitlement id not provided, 500: Internal server error}\n\n@endpoint POST /v2/certificates\n@desc Create a pending order for certificate\n@required {subscriptionCertificateCreate: any # The certificate order information}\n@optional {X-Market-Id: any # Setting locale for communications such as emails and error messages}\n@returns(202) Request was successful\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 409: Certificate state does not allow renew, 422: `email` is not empty<br>`csr` is invalid, 500: Internal server error}\n\n@endpoint GET /v2/certificates/download\n@desc Download certificate by entitlement\n@required {entitlementId: any # Entitlement id to download}\n@returns(200) Certificate retrieved\n@errors {400: Request was malformed, 401: Authentication info not sent or invalid, 403: Authenticated user is not allowed access, 404: Entitlement id not found, 409: Certificate state does not allow download, 422: Entitlement id not provided, 500: Internal server error}\n\n@endgroup\n\n@group customers\n@endpoint GET /v2/customers/{customerId}/certificates\n@desc Retrieve customer's certificates\n@required {customerId: any # An identifier for a customer}\n@optional {offset: any # Number of results to skip for pagination, limit: any # Maximum number of items to return}\n@returns(200) Customer certificate information retrieved.\n@errors {401: Authentication info not sent or is invalid, 403: Authenticated user is not allowed access, 422: Application-specific request error, 429: Too many requests received within interval, 500: Internal server error}\n\n@endpoint GET /v2/customers/{customerId}/certificates/{certificateId}\n@desc Retrieve individual certificate details\n@required {customerId: any # An identifier for a customer, certificateId: any # Certificate id to lookup}\n@returns(200) Certificate details retrieved\n@errors {401: Authentication info not sent or is invalid, 403: Authenticated user is not allowed access, 404: Resource not found, 422: Application-specific request error, 429: Too many requests received within interval, 500: Internal server error}\n\n@endpoint GET /v2/customers/{customerId}/certificates/{certificateId}/domainVerifications\n@desc Retrieve domain verification status\n@required {customerId: any # An identifier for a customer, certificateId: any # Certificate id to lookup}\n@returns(200) Domain verification status list for specified certificateId.\n@errors {401: Authentication info not sent or is invalid, 403: Authenticated user is not allowed access, 404: Resource not found, 422: Application-specific request error, 429: Too many requests received within interval, 500: Internal server error}\n\n@endpoint GET /v2/customers/{customerId}/certificates/{certificateId}/domainVerifications/{domain}\n@desc Retrieve detailed information for supplied domain\n@required {customerId: any # An identifier for a customer, certificateId: any # Certificate id to lookup, domain: any # A valid domain name in the certificate request}\n@returns(200) Retrieve detailed information for supplied domain, including domain verification details and Certificate Authority Authorization (CAA) verification details.\n@errors {401: Authentication info not sent or is invalid, 403: Authenticated user is not allowed access, 404: Resource not found, 422: Application-specific request error, 429: Too many requests received within interval, 500: Internal server error}\n\n@endpoint GET /v2/customers/{customerId}/certificates/acme/externalAccountBinding\n@desc Retrieves the external account binding for the specified customer\n@required {customerId: any # An identifier for a customer}\n@returns(200) Acme key identifier and HMAC key for the external account binding. Directory URI is also provided for making ACME requests.\n@errors {401: Authentication info not sent or is invalid, 403: Authenticated user is not allowed access, 404: Resource not found, 422: Application-specific request error, 429: Too many requests received within interval, 500: Internal server error}\n\n@endgroup\n\n@group certificates\n@endpoint GET /v2/certificates/subscriptions/search\n@desc Get a page of subscriptions by domain\n@optional {pageSize: any # The number of records to return per query., page: any # The page number. <b>(First page is <i>one</i> instead of zero.)</b>, domain: any # Filter by domain name / common name. This will look for the text inside the content of the domain. This is not a \"find domains that start with x\" search., status: any # The certificate lifecycle stage. <br> Active, Expired, and Revoked are all Issued certificates. <br> Active means the validity period includes today. <br> Expired means the validity period was prior to today. <br> Revoked means that the certificate has been revoked. <br> Pending means that the certificate is still going through the issuance process and has not been signed or issued yet. <br> Denied means that the certificate went from pending to denied for any valid denial reason.  (Customer canceled request, CAA records exist for the domain, fraud, etc...), type: any # The type of certificate in terms of the number of applicable domains., validation: any # The validation type for the certificate.  Standard/Basic Validation (DV).  Organizational/Deluxe Vetting (OV). Extended/Premium Validation (EV).}\n@returns(200) OK\n\n@endpoint GET /v2/certificates/subscription/{guid}\n@desc GET a page of certificates for a specific domain product\n@required {guid: any # The Subscription GUID containing the certificates being requested.}\n@optional {pageSize: any # The number of records to return per query., page: any # The page number. <b>(First page is <i>one</i> instead of zero.)</b>, domain: any # Filter by domain name / common name. This will look for the text inside the content of the domain. This is not a \"find domains that start with x\" search., status: any # The certificate lifecycle stage. <br> Active, Expired, and Revoked are all Issued certificates. <br> Active means the validity period includes today. <br> Expired means the validity period was prior to today. <br> Revoked means that the certificate has been revoked. <br> Pending means that the certificate is still going through the issuance process and has not been signed or issued yet. <br> Denied means that the certificate went from pending to denied for any valid denial reason.  (Customer canceled request, CAA records exist for the domain, fraud, etc...), type: any # The type of certificate in terms of the number of applicable domains., validation: any # The validation type for the certificate.  Standard/Basic Validation (DV).  Organizational/Deluxe Vetting (OV). Extended/Premium Validation (EV).}\n@returns(200) OK\n\n@endgroup\n\n@end\n"}