API URL https://my.gogetssl.com/api/v2: https://my.gogetssl.com/api/v2/
\nTo get started with GoGetSSL API you need:
\nAn account on GOGETSSL.COM platform.
\norder.status (and status in Service Updates) is one of:
For all requests Authorization header must be provided in following format:
\nAuthorization: GGS
\nauthorization_schema — always GGS
\ncredentials — {api_partner_code}:{api_password}, where api_partner_code is your assigned integration partner code and api_password is the secret token issued to you
In Postman, set the collection variables authorization_schema and credentials; every request already sends this header.
Example
\nAuthorization: GGS 657898:3fa85f64-5717-4562-b3fc-2c963f66afa6
To get api_partner_code and api_password, sign in to GoGetSSL account.
\nIn GoGetSSL account, in the left menu, go to Reseller Modules > API Settings.
\nOn the API Settings page, click Generate API Password.
\n⚠️ Your API password is shown only once upon creation and cannot be recovered later.
\nIf you lose it, you’ll need to generate a new one.
\nOn the API Settings page you can restrict the API permissions to a specified set of actions (order, reissue, cancel).
\n","_postman_id":"20c3d7b8-1432-4fc4-be38-39c612991a82"},{"name":"Products","item":[{"name":"List products","id":"e660ded1-1473-46fd-9cc5-0a83b449d04a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"url":"https://my.gogetssl.com/api/v2/products","description":"None
\nNone
\nThe response is a JSON array of objects, where each object represents a product and includes the following fields:
\nCode signing and S/MIME products are included in the list.
\n\"category\": \"cs\"): provisioning, tokens, and prices with term, selling, retail.\"category\": \"smime\"): id, label, description, description_url, type, category, validation (DV / OV / EV or null), vendor, brand, currency, prices (term, selling, retail).Products with category smime have a reduced set of fields:
id, label, description, description_url, type (certificate), category (smime), validation, vendor, brand, currency, prices.
common_name, san, dcv and provisioning are not returned.prices[] is flat: { \"term\": integer, \"selling\": number, \"retail\": number } (no base / san split).Returns the services (orders/certificates) whose status changed since the given time.
\n⚠️ This replaces GET /orders/updates, which has been removed and now returns 404.
None.
\n⚠️ Best practice: Store the timestamp of each request and use it as the since value in your next request to always keep statuses updated without missing changes.
An array of objects, one per service with a status update since the provided Unix timestamp.
\n","urlObject":{"path":["services","updates"],"host":["https://my.gogetssl.com/api/v2"],"query":[{"key":"since","value":""}],"variable":[]}},"response":[{"id":"16b33cdd-5330-4768-93fa-ec1fa158fc95","name":"Service Updates","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"GGS "}],"url":{"raw":"https://my.gogetssl.com/api/v2/services/updates?since=1735682400","host":["https://my.gogetssl.com/api/v2"],"path":["services","updates"],"query":[{"key":"since","value":"1735682400"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Thu, 20 Mar 2025 10:11:55 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Feature-Policy","value":"sync-xhr 'self';"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": 346199,\n \"type\": \"certificate\",\n \"category\": \"tls\",\n \"status\": \"pending\"\n },\n {\n \"id\": 346195,\n \"type\": \"certificate\",\n \"category\": \"smime\",\n \"status\": \"active\"\n },\n {\n \"id\": 346194,\n \"type\": \"certificate\",\n \"category\": \"cs\",\n \"status\": \"cancelled\"\n }\n]"}],"_postman_id":"95dc3287-4ad1-430b-95a6-8f28b35474c4"},{"name":"Cancel Order","id":"f6b2faab-fbee-48df-9b24-8c49eec10e32","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"reason\": \"Test order\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/orders//cancel","description":"Cancels an order by its order ID.
\n⚠️ The former path POST /certificates/{order_id}/cancel is deprecated. Use POST /orders/{order_id}/cancel instead. To cancel by certificate ID, use POST /certificates/{category}/{item_id}/cancel (category: tls, cs, smime, caas, ais), e.g. Cancel SMIME certificate.
- ID of the order. Returned as order.id.
The request body should be in JSON format with following properties:
\n204 No Content
\n","urlObject":{"path":["orders","","cancel"],"host":["https://my.gogetssl.com/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6b2faab-fbee-48df-9b24-8c49eec10e32"}],"id":"ea0bd63b-b6db-4cff-b23d-9c64c983d17b","_postman_id":"ea0bd63b-b6db-4cff-b23d-9c64c983d17b","description":""},{"name":"Certificates","item":[{"name":"Transport Layer Security","item":[{"name":"Create TLS Certificate","id":"0db429f0-9c3d-47c6-9d46-2e6e05efbd98","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"id\": \"45\",\n \"term\": 12\n },\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----MIICwTCCAakCAQAwfDELMAkGA1UEBhMCQVUxDjAMBgNVBAgMBXN0YXRlMQ0wCwYDVQQHDARjaXR5MQwwCgYDVQQKDANvcmcxDDAKBgNVBAsMA2RlcDESMBAGA1UEAwwJZ2dzc2wuY29tMR4wHAYJKoZIhvcNAQkBFg9lbWFpbEBlbWFpbC5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDhV95jhJy7ynSxZ37Qv3ypvfl9ixF5lZjEvWXL0dFwdu3EvV8voYk6uiaM366CUEeCV/ocgC6Xkaj0msEoQ79//h2bneTSkVoab9q/JwQ2ZFZv/MoAG3dKZVNF90GAh37jAy1piKbgI+Hv/33jL0I561pzRiiMz+rhZzDf8J0+ZEg/C2RWHIejcmEs6aarBXkut7GwLdm2qqccQDfK5JU4HW8pvBZlvRgrXT/Dduv1gvzOwij3HP5CEqzHYZX1ZOtPlkWO4wArGP/mDGDgFFgrXfDrEQI0vYNmKZbEp7qMy3uz00c0VKPP5QdX38nk/v7AVtv8SCjocj9MH9M4nis5AgMBAAGgADANBgkqhkiG9w0BAQsFAAOCAQEAIxVeTa9KnHISnb8se13Ufd5ZubjLbPymuITwN38RsqwHzu2y8e6s1WYQ7AlXuLqNQioxEiuZkS2iiAaHz59P2XEPWO+iWC6BMabzS45TzETnHv31M7rwYTrzrlIjosBEiRArmr+JQxTyH140TnzoETEuYbPhTRNpCkbXbwPTlpB2Sq8XbUj5SWUVXT4oOkOwps9mLo9gCq1HnU3D+xwGBW1y7FDJF1TS8YCqga/1vhfyy3Iuwweg3aDjsMc8iIftV8IfHmWmOnwpbUU7XP/qP8lRvH+e/0lm7i9m9s6Mvm/QHWVT1gQMRTyanzINDCenTyO0RFKG1U0SM1o6m7I1Qw==-----END CERTIFICATE REQUEST-----\",\n \"common_name\": {\n \"name\": \"ggssl.com\",\n \"validation_method\": \"admin@ggssl.com\"\n },\n \"alternative_names\": [\n {\n \"name\": \"san-1.com\",\n \"validation_method\": \"admin@san-1.com\"\n },\n {\n \"name\": \"san-2.com\",\n \"validation_method\": \"http\"\n }\n ],\n \"contacts\": {\n \"organization\": {\n \"name\": \"Test Organization\",\n \"address_line_1\": \"Street address 123\",\n \"address_line_2\": \"\",\n \"city\": \"City\",\n \"region\": \"Region/State\",\n \"country\": \"IT\",\n \"postal_code\": \"IT123\",\n \"phone\": \"+0078932144\"\n },\n \"administrator\": {\n \"first_name\": \"Firstname\",\n \"last_name\": \"Lastname\",\n \"title\": \"Title\",\n \"email\": \"email@email.com\",\n \"phone\": \"+0078932144\"\n },\n \"technical\": {\n \"first_name\": \"Firstname\",\n \"last_name\": \"Lastname\",\n \"title\": \"Title\",\n \"email\": \"email@email.com\",\n \"phone\": \"+0078932144\"\n }\n },\n \"renewal\": {\n \"prior_certificate_id\": 12345,\n \"remaining_days\": 10\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/certificates/tls","description":"None
\nThe request body should be in JSON format with following properties:
\nOnly usages differs from a regular TLS order; the other fields are as above.
{\n \"product\": {\n \"id\": \"<X9 PKI for TLS product id>\",\n \"term\": 12\n },\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIC...\\n-----END CERTIFICATE REQUEST-----\",\n \"common_name\": {\n \"name\": \"ggssl.com\",\n \"validation_method\": \"admin@ggssl.com\"\n },\n \"contacts\": {\n \"organization\": { \"...\": \"...\" },\n \"administrator\": { \"...\": \"...\" },\n \"technical\": { \"...\": \"...\" }\n },\n \"usages\": {\n \"server_authentication\": true,\n \"client_authentication\": false,\n \"key_encipherment\": true\n }\n}\n - ID of the certificate. Returned in the items array of the Create TLS Certificate response.
The request body should be in JSON format with following properties:
\n","urlObject":{"path":["certificates","tls",""],"host":["https://my.gogetssl.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"aadd0ca7-2b5e-4ba8-b785-cedc69784d40","name":"Reissue TLS Certificate-ERROR","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"csr\":\"\",\n \"common_name\":{\n \"domain\":\"test.com\",\n \"validation_method\":\"test@tst.com\"\n },\n \"existing_alternative_names\":[\n {\n \"domain\":\"test.com\",\n \"validation_method\": \"DNS\"\n },\n {\n \"domain\":\"test-1.com\",\n \"validation_method\": \"DNS\"\n }\n ],\n \"submitted_alternative_names\":[\n {\n \"domain\":\"test.com\",\n \"validation_method\": \"admin@test.com\"\n },\n {\n \"domain\":\"new-test-1.com\",\n \"validation_method\": \"DNS\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/certificates/"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Date","value":"Mon, 23 Dec 2024 10:08:15 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Feature-Policy","value":"sync-xhr 'self';"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"code\": \"GEX-1\",\n \"message\": \"CSR is not valid. CSR should begin with `-----BEGIN CERTIFICATE REQUEST-----...`\"\n}"}],"_postman_id":"c1cb41f9-2b53-47e7-ade6-2dced0d07c5a"},{"name":"Change DCV","id":"921d4349-0e29-4333-b084-c5fd2800a2d7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"domain\": {\n \"name\": \"example.com\",\n \"validation_method\": \"HTTP\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/certificates/tls//validation/change","description":" - ID of the certificate. Returned in the items array of the Create TLS Certificate response.
- ID of the certificate. Returned in the items array of the Create TLS Certificate response.
The request body should be JSON array that contains a list of objects. Each object represents a domain and the associated validation method
\nStatus Code: 204 No Content
This endpoint is used to resend domain validation emails for a specific TLS certificate, but only if the email validation method has been selected. If the validation email address needs to bt changed, you can do so by calling the Change DCV method before resending the validation emails.
\n - ID of the certificate. Returned in the items array of the Create TLS Certificate response.
Status Code: 204 No Content
- ID of the certificate. Returned in the items array of the Create TLS Certificate response.
The request body should be in JSON format with following properties:
\nSuccess: 200 OK
None
\nThe request body should be JSON array that contains a list of objects. Each object represents a domain and the associated validation method
\nThe response will return an array of objects, each containing a domain name and a list of available DCV email addresses.
\n","urlObject":{"path":["certificates","tls","validation","emails"],"host":["https://my.gogetssl.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"d364445b-af5d-4b5b-b108-e4c0bc6cb4a7","name":"Success example","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"domains\": [\"common-name.com\", \"san-1.com\", \"san-2.com\"],\n \"dcv_scope\": \"fqdn\"\n}","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/certificates/tls/validation/emails"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 19 Mar 2025 10:21:26 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Feature-Policy","value":"sync-xhr 'self';"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"domain\": \"common-name.com\",\n \"emails\": [\n \"admin@common-name.com\",\n \"administrator@common-name.com\",\n \"hostmaster@common-name.com\",\n \"webmaster@common-name.com\",\n \"postmaster@common-name.com\"\n ]\n },\n {\n \"domain\": \"san-1.com\",\n \"emails\": [\n \"admin@san-1.com\",\n \"administrator@san-1.com\",\n \"hostmaster@san-1.com\",\n \"webmaster@san-1.com\",\n \"postmaster@san-1.com\"\n ]\n },\n {\n \"domain\": \"san-2.com\",\n \"emails\": [\n \"admin@san-2.com\",\n \"administrator@san-2.com\",\n \"hostmaster@san-2.com\",\n \"webmaster@san-2.com\",\n \"postmaster@san-2.com\"\n ]\n }\n]"}],"_postman_id":"11def30b-16f5-458d-a464-c9818b5a99fd"},{"name":"Certificate Files","id":"62850f75-c60f-4a2f-b65d-60435551ccb5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"url":"https://my.gogetssl.com/api/v2/certificates/tls//files","description":" - ID of the certificate. Returned in the items array of the Create TLS Certificate response.
None
\nThis endpoint returns the issued certificate files for a specific TLS certificate order, along with its validity period.
The response includes the full certificate chain (root, intermediates, and end-entity certificate) in separate files with their respective content.
- ID of the certificate. Returned in the items array of the Create TLS Certificate response.
None
\nReturns all TLS certificates of your account, each with its order, in one call. Only the tls category is included; use the details endpoints for other categories.
None
\nNone. The list is not filtered or paginated; all certificates are returned, sorted by order ID in ascending order.
\nNone
\nA JSON array. Each element has exactly the structure of the Get TLS details response (order and items), so the field table of that endpoint applies to every element. items always holds the single TLS certificate of the order. An empty account returns [].
None
\nThe request body should be in JSON format with following properties:
\nThe response for the Create Certificate provides details about the order and purchased items.
\n","urlObject":{"path":["certificates","cs"],"host":["https://my.gogetssl.com/api/v2"],"query":[],"variable":[]}},"response":[{"id":"a36f7655-7616-4c11-b661-f975d042b6a5","name":"Digicert code signing with existing token provisioning","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product\":{\n \"id\":\"digi_csc\",\n \"term\": 12\n },\n \"provisioning\":{\n \"method\": \"existing-token\",\n \"model\": \"TOKEN_5110_FIPS\"\n },\n \"contacts\":{\n \"organization\":{\n \"name\": \"Test Org\",\n \"address_line_1\": \"Street address 1\",\n \"address_line_2\": \"\",\n \"city\": \"City\",\n \"region\": \"Region\",\n \"country\": \"LV\",\n \"postal_code\": \"Postal-code\",\n \"phone\": \"+4459544555\"\n },\n \"administrator\":{\n \"first_name\": \"Firstname\",\n \"last_name\": \"Lastname\",\n \"title\": \"Title\",\n \"email\": \"email@email.com\",\n \"phone\": \"+0078932144\"\n }\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/certificates/cs"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.18.0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Wed, 11 Jun 2025 11:40:48 GMT"},{"key":"Strict-Transport-Security","value":"max-age=63072000; includeSubdomains; preload"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Referrer-Policy","value":"same-origin"},{"key":"Feature-Policy","value":"sync-xhr 'self';"}],"cookie":[],"responseTime":null,"body":"{\n \"order\": {\n \"id\": 351084,\n \"status\": \"pending\",\n \"date\": \"2025-06-11T07:40:47+00:00\",\n \"currency\": null,\n \"total_amount\": \"320.36\",\n \"tax\": null\n },\n \"items\": [\n {\n \"id\": 351084,\n \"type\": \"certificate\",\n \"category\": \"cs\",\n \"product_id\": \"digi_csc\",\n \"vendor\": {\n \"id\": \"1293676344\",\n \"status\": \"pending\"\n }\n }\n ]\n}"}],"_postman_id":"01249b5c-93ec-4046-aec6-dea865f0438d"},{"name":"Get CS details","id":"b3d113f4-ff31-43f8-aee5-ec3054656369","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"url":"https://my.gogetssl.com/api/v2/certificates/cs/","description":" - ID of the certificate. Returned in the items array of the Create Code Signing Certificate response.
None
\nOrders an S/MIME certificate.
\nNone
\nThe request body should be in JSON format with following properties:
\ncontacts.administrator fields: first_name, last_name, title, organization, email, phone, country, region, city, postal_code, address_line_1, address_line_2. Other keys are ignored.
contacts.organization fields: name, division, duns, lei, phone, country, region, city, postal_code, address_line_1, address_line_2. Other keys are ignored.
1 - Mailbox-validated, one email
\n{\n \"product\": {\n \"id\": \"90\",\n \"term\": 12\n },\n \"emails\": [\n \"john.doe@example.com\"\n ]\n}\n2 - Several emails and CSR
\n{\n \"product\": {\n \"id\": \"90\",\n \"term\": 12\n },\n \"emails\": [\n \"john.doe@example.com\",\n \"j.doe@example.com\"\n ],\n \"csr\": \"-----BEGIN CERTIFICATE REQUEST-----\\nMIIC...\\n-----END CERTIFICATE REQUEST-----\"\n}\n3 - Organization-validated product
\n{\n \"product\": {\n \"id\": \"171\",\n \"term\": 12\n },\n \"emails\": [\n \"john.doe@example.com\"\n ],\n \"contacts\": {\n \"administrator\": {\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"title\": \"IT Manager\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"+37120000000\",\n \"country\": \"LV\",\n \"region\": \"Riga\",\n \"city\": \"Riga\",\n \"postal_code\": \"LV-1050\",\n \"address_line_1\": \"Brivibas iela 1\",\n \"address_line_2\": null\n },\n \"organization\": {\n \"name\": \"Example SIA\",\n \"division\": \"IT\",\n \"duns\": null,\n \"lei\": null,\n \"phone\": \"+37120000000\",\n \"country\": \"LV\",\n \"region\": \"Riga\",\n \"city\": \"Riga\",\n \"postal_code\": \"LV-1050\",\n \"address_line_1\": \"Brivibas iela 1\",\n \"address_line_2\": null\n }\n }\n}\nThe response body is the same as for Get SMIME details.
\nReturns S/MIME certificate details.
\n - ID of the certificate. Returned in the items array of the Create SMIME certificate response.
None
\nCancels an S/MIME certificate by its certificate ID.
\nThis is the S/MIME form of the generic POST /certificates/{category}/{item_id}/cancel, where category is tls, cs, smime, caas or ais. To cancel by order ID, use Orders → Cancel Order.
- ID of the certificate. Returned in the items array of the Create SMIME certificate response.
The request body should be in JSON format with following properties:
\n204 No Content
\n","urlObject":{"path":["certificates","smime","","cancel"],"host":["https://my.gogetssl.com/api/v2"],"query":[],"variable":[]}},"response":[],"_postman_id":"540fb670-b18c-4139-9f12-39e2d6cd0a4b"}],"id":"9da4d37e-a076-4b0e-8be5-989a15189484","_postman_id":"9da4d37e-a076-4b0e-8be5-989a15189484","description":""},{"name":"Certificate as a Service","item":[{"name":"Create CaaS","id":"9df12485-360e-4a01-974f-bb7b7f714734","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"GGS ","type":"text"}],"body":{"mode":"raw","raw":"{\n \"product\": {\n \"id\": 300\n },\n \"domains\": [\n \"domain.com\"\n ]\n \n}","options":{"raw":{"language":"json"}}},"url":"https://my.gogetssl.com/api/v2/certificates/caas","description":"Creates a new ACME subscription and adds the specified domains to it. For each base domain, the corresponding www subdomain is added automatically at no extra cost, and for each wildcard domain, the base domain is included for free. After the order is successfully created, use the Get CaaS Details method with returned items.id to retrieve the full subscription details and ACME account credentials (including eab_mac_id, eab_mac_key, and server_url) required for ACME client configuration.
None
\nThe request body should be in JSON format with following properties:
\nAdds one or more domains to an existing ACME subscription. For each base domain, the corresponding www subdomain is added automatically at no extra cost, and for each wildcard domain, the base domain is included for free.
- ID of the CaaS subscription. Returned in the items array of the Create CaaS response.
A JSON array containing domains to add. Supports FQDNs and wildcards (e.g. example.com, \\\\\\*.example.com).
⚠️ Note: Removing a domain will automatically cancel an order associated with that domain. If the domain is removed within 30 days of its addition to the subscription, the cancelled order amount will be refunded .
\n - ID of the CaaS subscription. Returned in the items array of the Create CaaS response.
{{domain_id}} - The internal identifier of the domain to remove.
\nNone.
\n⚠️ Note:
\nYou may only update a domain within 15 days of its addition.
\nWildcard domains can only replace other wildcard domains, and non-wildcard only replace non-wildcard.
\n - ID of the CaaS subscription. Returned in the items array of the Create CaaS response.
{{domain_id}} - The internal identifier of the domain to remove.
\nTurns subscription auto-renewal on or off. Turning it off does not end the subscription: it stays active until its end date and is not renewed.
\n - ID of the CaaS subscription. Returned in the items array of the Create CaaS response.
The legacy /acme routes are not extended with PATCH - use /caas with the CaaS ID.
The request body should be in JSON format with following properties:
\nEmpty body. Use Get CaaS details to read the subscription state: subscription.next_renewal is shown while auto-renewal is on, subscription.end when it is off.
- ID of the CaaS subscription. Returned in the items array of the Create CaaS response.
None
\nCreates a new Autoinstall SSL certificate subscription.
\nNone
\nThe request body should be in JSON format with following properties:
\nTurns subscription auto-renewal on or off. Turning it off does not end the subscription: it stays active until its end date and is not renewed.
\n - ID of the certificate. Returned in the items array of the Create AIS response.
The request body should be in JSON format with following properties:
\nEmpty body. Use Get AIS details to read the subscription state: subscription.next_renewal is shown while auto-renewal is on, subscription.end when it is off.
- ID of the certificate. Returned in the items array of the Create AIS response.
None
\ntls - The category of the product associated with the item_id. Allowed values: tls, cs, smime, caas, ais. Any other value returns 400 GEX-1 \"Category X not supported\". (The legacy category acme is also accepted; it takes an order ID instead of a certificate ID.)
- ID of certificate.
\nNone
\nAn unsuccessful API request will return a response in the following format:
\n{\n \"code\": \"ERROR-CODE\",\n \"message\": \"A human-readable error description.\"\n}\n\ncode: A unique error code that identifies the specific error.
message: A more detailed description of the error.
404 with {\"code\": \"GEX-1\", \"message\": \"Not Found\"}.VAX-* code. A missing required field returns VAX-1 with the message \"<field> is required.\".