@itentialopensource/adapter-godaddy

{ "swagger": "2.0", "info": { "title": "GoDaddy", "version": "2", "description": "GoDaddy Abuse API Terms of Use:GoDaddy’s Abuse API is provided to simplify and standardize the abuse reporting experience. To help us streamline the review of abuse reports, you acknowledge and agree that your use of GoDaddy’s Abuse API is subject to the following quality metrics and terms of use.GoDaddy may, in its sole and absolute discretion, change or modify these terms, and such changes or modifications shall be effective immediately upon notice to you. Your use of GoDaddy’s Abuse API after such changes or modifications shall constitute your acceptance of these terms as last revised. If you do not agree to be bound by these terms as last revised, do not use (or continue to use) our Abuse API.As an Abuse API user, you must only submit abuse reports via the API portal and cease all email submissions, including but not limited, to phishing@godaddy.com, netabuse@godaddy.com, malware@godaddy.com, or spam@godaddy.com, etc. Any additional or duplicate submission outside of the API portal will be deprioritized for review. Submissions related to trademark, copyright or content issues may still be sent to trademarkclaims@godaddy.com, coyprightclaims@godaddy.com, and contentcomplaints@godaddy.com, respectively. Our [Front of Site](https://supportcenter.godaddy.com/AbuseReport) also describes other scenarios not covered by the API.When you submit abuse reports via GoDaddy’s Abuse API, you must ensure that you accurately categorize the abuse type of each report to match our definitions in the API documentations provided to you. Any submission that fails to match our definitions or is miscategorized will be marked as a false positive. Examples include, but are not limited to, submissions of trademark complaints marked as phishing or malware, or submissions of copyright complaints marked as phishing or malware, etc.If, at any time, the false positive rate of submissions exceeds 40% of your total submissions, as determined by GoDaddy, GoDaddy may in its sole discretion deprioritize any subsequent reports submitted by you and/or your organization.You acknowledge and agree that submitting every URL for a single domain is not necessary and will not expedite the review process. If your submissions exceed five (5) URLs for a single domain, your report will be marked as a duplicate submission taking into account that the final outcome of such submissions would yield the same result as the original report. GoDaddy may in its sole discretion deprioritize reports submitted by you and/or your organization in the event more than 20% of your submissions are classified as duplicate submissions.You further acknowledge and agree that our Customer Support lines are not intended to address abuse reporting matters or your use of GoDaddy’s Abuse API. Contacting Customer Support will not expedite the review process and may result in abuse reports being deprioritized, to be determined in our sole discretion.Should you have any questions about GoDaddy’s Abuse API or any of the terms and conditions set forth above, please contact abuseapisupport@godaddy.com." }, "tags": [ { "name": "Abuse", "description": "" }, { "name": "Aftermarket", "description": "" }, { "name": "Agreements", "description": "" }, { "name": "Certificates", "description": "" }, { "name": "Countries", "description": "" }, { "name": "Domains", "description": "" }, { "name": "Orders", "description": "" }, { "name": "Parking", "description": "" }, { "name": "Shoppers", "description": "" }, { "name": "Subscriptions", "description": "" } ], "host": "api.ote-godaddy.com", "paths": { "/v1/aftermarket/listings": { "delete": { "tags": [ "Aftermarket" ], "consumes": [ "application/json", "application/xml", "text/xml" ], "produces": [ "application/json", "application/javascript", "application/xml", "text/javascript", "text/xml" ], "parameters": [ { "description": "A comma separated list of domain names", "in": "query", "items": { "type": "string" }, "name": "domains", "required": true, "type": "array" } ], "responses": { "200": { "description": "Request was successful", "schema": { "$ref": "#/definitions/AftermarketListingAction" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "\tRequired parameters must be specified in correct format", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too many requests received within interval", "schema": { "$ref": "#/definitions/ErrorLimit" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "deleteListings", "summary": "Remove listings from GoDaddy Auction" } }, "/v1/aftermarket/listings/expiry": { "post": { "tags": [ "Aftermarket" ], "consumes": [ "application/json", "application/xml", "text/xml" ], "produces": [ "application/json", "application/javascript", "application/xml", "text/javascript", "text/xml" ], "parameters": [ { "description": "An array of expiry listings to be loaded", "in": "body", "name": "expiryListings", "required": true, "schema": { "items": { "$ref": "#/definitions/AftermarketListingExpiryCreate" }, "type": "array" } } ], "responses": { "200": { "description": "Request was successful", "schema": { "$ref": "#/definitions/AftermarketListingAction" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "Required parameters must be specified in correct format Too many Listings provided Invalid Losing Registrar Id", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too many requests received within interval", "schema": { "$ref": "#/definitions/ErrorLimit" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "addExpiryListings", "summary": "Add expiry listings into GoDaddy Auction" } }, "/v1/abuse/tickets": { "get": { "tags": [ "Abuse" ], "parameters": [ { "description": "The type of abuse.", "enum": [ "A_RECORD", "CHILD_ABUSE", "CONTENT", "FRAUD_WIRE", "IP_BLOCK", "MALWARE", "NETWORK_ABUSE", "PHISHING", "SPAM" ], "in": "query", "name": "type", "required": false, "type": "string" }, { "default": false, "description": "Is this abuse ticket closed?", "in": "query", "name": "closed", "required": false, "type": "boolean" }, { "description": "The domain name or ip address the abuse originated from", "format": "host-name-or-ip-address", "in": "query", "name": "sourceDomainOrIp", "required": false, "type": "string" }, { "description": "The brand/company the abuse is targeting. ie: brand name/bank name", "in": "query", "name": "target", "required": false, "type": "string" }, { "description": "The earliest abuse ticket creation date to pull abuse tickets for", "format": "iso-datetime", "in": "query", "name": "createdStart", "required": false, "type": "string" }, { "description": "The latest abuse ticket creation date to pull abuse tickets for", "format": "iso-datetime", "in": "query", "name": "createdEnd", "required": false, "type": "string" }, { "default": 100, "description": "Number of abuse ticket numbers to return.", "format": "integer-positive", "in": "query", "maximum": 100, "name": "limit", "required": false, "type": "integer" }, { "default": 0, "description": "The earliest result set record number to pull abuse tickets for", "format": "integer-positive", "in": "query", "name": "offset", "required": false, "type": "integer" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AbuseTicketList" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "Error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "getTickets", "summary": "List all abuse tickets ids that match user provided filters" }, "post": { "tags": [ "Abuse" ], "parameters": [ { "description": "The endpoint which allows the Reporter to create a new abuse ticket", "in": "body", "name": "body", "required": true, "schema": { "$ref": "#/definitions/AbuseTicketCreate" } } ], "responses": { "200": { "description": "No response was specified" }, "201": { "description": "Success", "schema": { "$ref": "#/definitions/AbuseTicketId" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "Error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "createTicket", "summary": "Create a new abuse ticket" } }, "/v1/abuse/tickets/{ticketId}": { "get": { "tags": [ "Abuse" ], "parameters": [ { "description": "A unique abuse ticket identifier", "in": "path", "name": "ticketId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Success", "schema": { "$ref": "#/definitions/AbuseTicket" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Invalid ticket id provided", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "getTicketInfo", "summary": "Return the abuse ticket data for a given ticket id" } }, "/v1/agreements": { "get": { "tags": [ "Agreements" ], "consumes": [ "application/json", "application/xml", "text/xml" ], "produces": [ "application/json", "application/javascript", "application/xml", "text/javascript", "text/xml" ], "parameters": [ { "description": "PrivateLabelId to operate as, if different from JWT", "in": "header", "name": "X-Private-Label-Id", "required": false, "type": "integer" }, { "default": "en-US", "description": "Unique identifier of the Market used to retrieve/translate Legal Agreements", "format": "bcp-47", "in": "header", "name": "X-Market-Id", "required": false, "type": "string" }, { "description": "Keys for Agreements whose details are to be retrieved", "in": "query", "items": { "type": "string" }, "name": "keys", "required": true, "type": "array" } ], "responses": { "200": { "description": "Request was successful", "schema": { "items": { "$ref": "#/definitions/LegalAgreement" }, "type": "array" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "429": { "description": "Too many requests received within interval", "schema": { "$ref": "#/definitions/ErrorLimit" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "getAgreements", "summary": "Retrieve Legal Agreements for provided agreements keys" } }, "/v1/certificates": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "default": "Default locale for shopper account", "description": "Setting locale for communications such as emails and error messages", "in": "header", "name": "X-Market-Id", "required": false, "type": "string" }, { "description": "The certificate order information", "in": "body", "name": "certificateCreate", "required": true, "schema": { "$ref": "#/definitions/CertificateCreate" } } ], "responses": { "202": { "description": "Request was successful", "schema": { "$ref": "#/definitions/CertificateIdentifier" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow renew", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "`email` is not empty `csr` is invalid", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "Creating a certificate order can be a long running asynchronous operation in the PKI workflow. The PKI API supports 2 options for getting the completion stateful actions for this asynchronous operations: 1) by polling operations -- see /v1/certificates/{certificateId}/actions 2) via WebHook style callback -- see '/v1/certificates/{certificateId}/callback'.", "operationId": "certificate_create", "summary": "Create a pending order for certificate" } }, "/v1/certificates/validate": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "default": "Default locale for shopper account", "description": "Setting locale for communications such as emails and error messages", "in": "header", "name": "X-Market-Id", "required": false, "type": "string" }, { "description": "The certificate order info", "in": "body", "name": "certificateCreate", "required": true, "schema": { "$ref": "#/definitions/CertificateCreate" } } ], "responses": { "204": { "description": "Request validated successfully" }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow renew", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "`email` is not empty `csr` is invalid", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "certificate_validate", "summary": "Validate a pending order for certificate" } }, "/v1/certificates/{certificateId}": { "get": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to lookup", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Certificate details retrieved", "schema": { "$ref": "#/definitions/Certificate" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "Once the certificate order has been created, this method can be used to check the status of the certificate. This method can also be used to retrieve details of the certificate.", "operationId": "certificate_get", "summary": "Retrieve certificate details" } }, "/v1/certificates/{certificateId}/actions": { "get": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to register for callback", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Action retrieval successful", "schema": { "$ref": "#/definitions/ArrayOfCertificateAction" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method is used to retrieve all stateful actions relating to a certificate lifecycle.", "operationId": "certificate_action_retrieve", "summary": "Retrieve all certificate actions" } }, "/v1/certificates/{certificateId}/email/{emailId}/resend": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to resend email", "in": "path", "name": "certificateId", "required": true, "type": "string" }, { "description": "Email id for email to resend", "in": "path", "name": "emailId", "required": true, "type": "string" } ], "responses": { "204": { "description": "Email sent successfully" }, "404": { "description": "Certificate not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Email Id not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method can be used to resend emails by providing the certificate id and the email id", "operationId": "certificate_resend_email", "summary": "Resend an email" } }, "/v1/certificates/{certificateId}/email/resend/{emailAddress}": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to resend emails", "in": "path", "name": "certificateId", "required": true, "type": "string" }, { "description": "Specific email address to resend email", "in": "path", "name": "emailAddress", "required": true, "type": "string" } ], "responses": { "200": { "description": "Alternate email address added and emails re-sent", "schema": { "$ref": "#/definitions/CertificateEmailHistory" } }, "404": { "description": "Certificate not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow alternate email address", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method adds an alternate email address to a certificate order and re-sends all existing request emails to that address.", "operationId": "certificate_alternate_email_address", "summary": "Add alternate email address" } }, "/v1/certificates/{certificateId}/email/{emailId}/resend/{emailAddress}": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to resend emails", "in": "path", "name": "certificateId", "required": true, "type": "string" }, { "description": "Email id for email to resend", "in": "path", "name": "emailId", "required": true, "type": "string" }, { "description": "Specific email address to resend email", "in": "path", "name": "emailAddress", "required": true, "type": "string" } ], "responses": { "204": { "description": "Email sent successfully" }, "404": { "description": "Certificate not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Email Id not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method can be used to resend emails by providing the certificate id, the email id, and the recipient email address", "operationId": "certificate_resend_email_address", "summary": "Resend email to email address" } }, "/v1/certificates/{certificateId}/email/history": { "get": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to retrieve email history", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Email history retrieval successful", "schema": { "$ref": "#/definitions/CertificateEmailHistory" } }, "409": { "description": "Email history not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method can be used to retrieve all emails sent for a certificate.", "operationId": "certificate_email_history", "summary": "Retrieve email history" } }, "/v1/certificates/{certificateId}/callback": { "delete": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to unregister callback", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "204": { "description": "Callback removed" }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "Unregister the callback for a particular certificate.", "operationId": "certificate_callback_delete", "summary": "Unregister system callback" }, "get": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to register for stateful action callback", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Callback registered", "schema": { "$ref": "#/definitions/CertificateCallback" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method is used to retrieve the registered callback url for a certificate.", "operationId": "certificate_callback_get", "summary": "Retrieve system stateful action callback url" }, "put": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to register/replace for callback", "in": "path", "name": "certificateId", "required": true, "type": "string" }, { "description": "Callback url registered/replaced to receive stateful actions", "in": "query", "name": "callbackUrl", "required": true, "type": "string" } ], "responses": { "204": { "description": "Callback replaced/registered" }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "Callback url is missing Callback url is malformed", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "This method is used to register/replace url for callbacks for stateful actions relating to a certificate lifecycle. The callback url is a Webhook style pattern and will receive POST http requests with json body defined in the CertificateAction model definition for each certificate action. Only one callback URL is allowed to be registered for each certificateId, so it will replace a previous registration.", "operationId": "certificate_callback_replace", "summary": "Register of certificate action callback" } }, "/v1/certificates/{certificateId}/cancel": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to cancel", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "204": { "description": "Certificate order has been canceled" }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow cancel", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "Use the cancel call to cancel a pending certificate order.", "operationId": "certificate_cancel", "summary": "Cancel a pending certificate" } }, "/v1/certificates/{certificateId}/download": { "get": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to download", "in": "path", "name": "certificateId", "required": true, "type": "string" } ], "responses": { "200": { "description": "Certificate retrieved", "schema": { "$ref": "#/definitions/CertificateBundle" } }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow download", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "operationId": "certificate_download", "summary": "Download certificate" } }, "/v1/certificates/{certificateId}/reissue": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to reissue", "in": "path", "name": "certificateId", "required": true, "type": "string" }, { "description": "The reissue request info", "in": "body", "name": "reissueCreate", "required": true, "schema": { "$ref": "#/definitions/CertificateReissue" } } ], "responses": { "202": { "description": "Reissue request created" }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow reissue", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "`csr` is invalid Delay revocation exceeds maximum", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "Rekeying is the process by which the private and public key is changed for a certificate. It is a simplified reissue,where only the CSR is changed. Reissuing is the process by which domain names are added or removed from a certificate.Once a request is validated and approved, the certificate will be reissued with the new common name and sans specified. Unlimited reissues are available during the lifetime of the certificate.New names added to a certificate that do not share the base domain of the common name may take additional time to validate. If this API call is made before a previous pending reissue has been validated and issued, the previous reissue request is automatically rejected and replaced with the current request.", "operationId": "certificate_reissue", "summary": "Reissue active certificate" } }, "/v1/certificates/{certificateId}/renew": { "post": { "tags": [ "Certificate" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [ { "description": "Certificate id to renew", "in": "path", "name": "certificateId", "required": true, "type": "string" }, { "description": "The renew request info", "in": "body", "name": "renewCreate", "required": true, "schema": { "$ref": "#/definitions/CertificateRenew" } } ], "responses": { "202": { "description": "Renew request created" }, "400": { "description": "Request was malformed", "schema": { "$ref": "#/definitions/Error" } }, "401": { "description": "Authentication info not sent or invalid", "schema": { "$ref": "#/definitions/Error" } }, "403": { "description": "Authenticated user is not allowed access", "schema": { "$ref": "#/definitions/Error" } }, "404": { "description": "Certificate id not found", "schema": { "$ref": "#/definitions/Error" } }, "409": { "description": "Certificate state does not allow renew", "schema": { "$ref": "#/definitions/Error" } }, "422": { "description": "`csr` is invalid", "schema": { "$ref": "#/definitions/Error" } }, "500": { "description": "Internal server error", "schema": { "$ref": "#/definitions/Error" } } }, "description": "Renewal is the process by which the validity of a certificate is extended. Renewal is only available 60 days prior to expiration of the previous certificate and 30 days after the expiration of the previous certificate. The renewal supports modifying a set of the original certificate order information. Once a request is validated and approved, the certificate will be issued with extended validity. Since subject alternative names can be removed during a renewal, we require that you provide the subject alternative names you expect in the renewed certificate. New names added to a certificate that do not share the base domain of the common name may take additional time to validate. ", "operationId": "certificate_renew", "summary": "Renew active certificate" } }, "/v1/certificat