Private Keys - 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/private-key

Gets all private keys on the account

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

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

400 Response

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

GET/dom/private-key/{uuid}

Gets the specified private key

Request Details

Response Details

Request Details

URL and Query String Parameters

Name
Type
Required

- uuid
- String
- True
The UUID of the Private Key to be queried

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-06-07",
        "updated_on" : "2023-06-07",
        "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/private-key

Creates a new Private Key

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

JSON all-fields example:

{}

Response Details

201 Response

{
    "result" : {
        "created_on" : "2023-06-07",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 201,
    "status_message" : "Created"
}

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/private-key/{uuid}

Deletes the specified Private Key
Back to top

Request Details

Response Details
Request Details

URL and Query String Parameters
- Name
- Type
- Required
- uuid
  
  String
  
  True
  
  The UUID of the Private Key to be deleted
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"
}
```