SSL Certificates - Domain Name API

Become a Reseller

Filter:

All
GET
POST
PUT
DELETE
DELETE
Chargeable *

* You will be charged every time this command is run.

GET/dom/domain/{domain_uuid}/ssl-certificate

Gets all SSL certificates for the specific domain

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- domain_uuid
- String
- True
The UUID of the domain to query the certificates for

Response Details

200 Response

{
    "result" : [
        {
            "created_on" : "2023-06-04",
            "updated_on" : "2023-06-04",
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
        }
    ],
    "status_code" : 200,
    "status_message" : "OK"
}

400 Response

{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}

GET/dom/domain/{domain_uuid}/ssl-certificate/{uuid}

Gets all SSL certificates for the specific domain
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the web forward to query
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to query the certificates for
Response Details

200 Response
```
{
    "result" : {
        "created_on" : "2023-06-04",
        "updated_on" : "2023-06-04",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
POST/dom/domain/{domain_uuid}/ssl-certificate

Creates a new SSL certificate for the specified domain
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to create the certificates for
POST body
- Name
- Type
- Required
- alternative_names
  
  Array of String
  
  False
  
  A list of SAN's (subdomains) for the SSL certificate
- is_root
  
  boolean
  
  False
  
  Is this a root SSL certificate
- is_wildcard
  
  boolean
  
  False
  
  Is this a wildcard certificate? If true, the `alternative_names` parameter should not be provided
- private_key
  
  String
  
  True
  
  The UUID of the PrivateKey object to sign this certificate
JSON all-fields example:
{ "alternative_names" : "", "is_root" : true, "is_wildcard" : true, "private_key" : "e81f8eab-5da4-4f46-8f92-b40aa095e0e1" }
Response Details

200 Response
```
{
    "result" : {
        "created_on" : "2023-06-04",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```
409 Response
```
{
    "result" : {},
    "status_code" : 409,
    "status_message" : "Conflict"
}
```
DELETE/dom/domain/{domain_uuid}/ssl-certificate/{uuid}

Deletes the specified SSL certificate
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- domain_uuid
  
  String
  
  True
  
  The UUID of the domain to update the SSL certificate for
- uuid
  
  String
  
  True
  
  The UUID of the SSL certificate to be updated
- revoke
  
  String
  
  True
  
  When true, revokes the certificate at the issuing CA
Response Details

204 Response
```
{
    "result" : {},
    "status_code" : 204,
    "status_message" : "No Content"
}
```
400 Response
```
{
    "result" : {},
    "status_code" : 400,
    "status_message" : "Bad Request"
}
```
404 Response
```
{
    "result" : {},
    "status_code" : 404,
    "status_message" : "Not Found"
}
```