Download OpenAPI specification:Download
ZoneID APIv2 is JSON based RESTful API for managing Domain, Webhosting, Cloudserver VPS and DNS services.
HTTP basic auth is used for authentication:
Use following header:
Authorization: Basic base64(zoneid_username:zoneid_api_token)
URLs are built as:
https://api.zone.eu/v2/{service_type}/{service_name}/{resource_name*}/{resource_identificator*}
Where
{service_type} is
{service_name} is
Additional child endpoints may follow as /{child}/{child_identificator*}
* optional
For example to get single DNS A record, we use following url:
https://api.zone.eu/v2/dns/example.com/a/1
or to get all DNS A Records, we use following url:
https://api.zone.eu/v2/dns/example.com/a
There is exception for service ordering endpoints where path is build as:
https://api.zone.eu/v2/order/{service_type}
Request types are divided into 4 separate HTTP codes.
Code | Description |
---|---|
GET | Access one or more resource. All resources are returned in array. Single resources are returned as single array element. When accessing single resourse, then URL must end with giver resource identificator |
POST | Create new resource. Resouce data in JSON structure should be sent in request body. Generated resource is returned in response as single array element. |
PUT | Update existing resource. URL must contain given resource identificator of resource that is updated. Otherwise same as POST request |
DELETE | Delete existing resource. URL must contain given resource identificator. |
Standard HTTP status codes are used to give feedback about operation. In addition, human readable response message is sent in header X-Status-Message. Using response message in your scripts is not recommended as these may change without warning. Descriptions of all HTTP standard status codes are here. Most commonly used in ZoneID API are:
Code | Description |
---|---|
200 | successful GET request |
201 | successful POST/PUT request |
202 | successful POST/PUT request in case request was accepted, but will be processed later (for example ordering new services) |
204 | successful DELETE request |
422 | unsuccessful request in case resource in request has validation errors. Error codes in response are in same structure as resource itself. |
400 | unsuccessful request in case request itself is invalid |
402 | unsuccessful request in case payment is required for further actions. Mostly used when package upgrade is required. |
409 | unsuccessful request in case there is a conflict with the current state of the target resource. Mostly it indicates a concurrent request. |
The number of request is limited to 60 per minute per IP.
Rate limit information is contained in every response headers.
If you have reached the rate limit, then HTTP response code 429 is returned
Don't create requests without need. Don't update resources that are not modified and don't ask for data that you already know.
For example when writing custom dynamic DNS style script for DNS A record, then.
On some GET endpoints we have enabled pagination. In that case there is header x-pager-enabled is sent in response.
Response headers describing pager:
Header | Description |
---|---|
x-pager-enabled | 1 when pager is enabled |
x-pager-page | Current page number |
x-pager-pages | Total number of pages |
x-pager-limit | Items per page |
x-pager-items | Total number of items |
Request headers to use pager:
Header | Description |
---|---|
x-pager-page | Current page number |
x-pager-limit | Items per page. Default is 10 and maximum is 100 |
x-order-by | Sort by field. Sortable fields are described in Resource documentation |
x-order-dir | Sort direction: asc or desc |
Example CURL request to get DNS A record
curl -X GET https://api.zone.eu/v2/dns/example.com/a/1 \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic em9uZWRfdXNlcm5hbWU6em9uZWlkX2FwaV9rZXk='
Example CURL request to create DNS A record
curl -X POST https://api.zone.eu/v2/dns/example.com/a \
-H 'Content-Type: application/json' \
-H 'Authorization: Basic em9uZWRfdXNlcm5hbWU6em9uZWlkX2FwaV9rZXk=' \
-d '{"name": "prefix.example.com","destination": "123.123.123.123"}'
Successful GET, POST and PUT responses always contain requested (or created/updated) resource(s). For example:
[
{
"id": "123",
"resource_url": "https://api.zone.eu/v2/dns/example.com/a/123",
"name": "prefix.example.com",
"destination": "123.123.123.123",
"delete": true,
"modify": true
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | string identificator |
active | boolean Is zone active |
ipv6 | boolean Are ipv6 records allowed |
[- {
- "resource_url": "string",
- "identificator": "string",
- "active": true,
- "ipv6": false
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | string identificator |
active | boolean Is zone active |
ipv6 | boolean Are ipv6 records allowed |
[- {
- "resource_url": "string",
- "identificator": "string",
- "active": true,
- "ipv6": false
}
]
service_name required | string Unique name of service |
destination | string IPv4 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string IPv4 |
name | string Hostname |
destination | string IPv4 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string IPv4 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string IPv4 |
name | string Hostname |
destination | string IPv4 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
destination | string IPv6 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string IPv6 |
name | string Hostname |
destination | string IPv6 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string IPv6 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string IPv6 |
name | string Hostname |
destination | string IPv6 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string Destination |
name | string Hostname |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string Destination |
name | string Hostname |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
priority | integer Priority |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
priority | integer Priority |
destination | string Destination |
name | string Hostname |
priority | integer Priority |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
priority | integer Priority |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
priority | integer Priority |
destination | string Destination |
name | string Hostname |
priority | integer Priority |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string Destination |
name | string Hostname |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string Destination |
name | string Hostname |
resource_url | string API url to get this entity |
destination | string Destination |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
destination | string TXT content value |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string TXT content value |
name | string Hostname |
destination | string TXT content value |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string TXT content value |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string TXT content value |
name | string Hostname |
destination | string TXT content value |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
algorithm | integer Algorithm: 1=RSA, 2=DSA, 3=ECDSA, 4=Ed25519 |
type | integer Type: 1=SHA-1, 2=SHA-256 |
destination | string Fingerprint |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
algorithm | integer Algorithm: 1=RSA, 2=DSA, 3=ECDSA, 4=Ed25519 |
type | integer Type: 1=SHA-1, 2=SHA-256 |
destination | string Fingerprint |
name | string Hostname |
algorithm | integer Algorithm: 1=RSA, 2=DSA, 3=ECDSA, 4=Ed25519 |
type | integer Type: 1=SHA-1, 2=SHA-256 |
destination | string Fingerprint |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
algorithm | integer Algorithm: 1=RSA, 2=DSA, 3=ECDSA, 4=Ed25519 |
type | integer Type: 1=SHA-1, 2=SHA-256 |
destination | string Fingerprint |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
algorithm | integer Algorithm: 1=RSA, 2=DSA, 3=ECDSA, 4=Ed25519 |
type | integer Type: 1=SHA-1, 2=SHA-256 |
destination | string Fingerprint |
name | string Hostname |
algorithm | integer Algorithm: 1=RSA, 2=DSA, 3=ECDSA, 4=Ed25519 |
type | integer Type: 1=SHA-1, 2=SHA-256 |
destination | string Fingerprint |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
priority | integer Priority |
weight | integer Weight |
port | integer Port |
destination | string Target |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
priority | integer Priority |
weight | integer Weight |
port | integer Port |
destination | string Target |
name | string Hostname |
priority | integer Priority |
weight | integer Weight |
port | integer Port |
destination | string Target |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
priority | integer Priority |
weight | integer Weight |
port | integer Port |
destination | string Target |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
priority | integer Priority |
weight | integer Weight |
port | integer Port |
destination | string Target |
name | string Hostname |
priority | integer Priority |
weight | integer Weight |
port | integer Port |
destination | string Target |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
destination | string URL where hostname is redirected to |
type | integer Default: "301" Redirect HTTP redirect status code. Accepted values are 301 and 302 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string URL where hostname is redirected to |
type | integer Default: "301" Redirect HTTP redirect status code. Accepted values are 301 and 302 |
name | string Hostname |
destination | string URL where hostname is redirected to |
type | integer Default: "301" Redirect HTTP redirect status code. Accepted values are 301 and 302 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string URL where hostname is redirected to |
type | integer Default: "301" Redirect HTTP redirect status code. Accepted values are 301 and 302 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string URL where hostname is redirected to |
type | integer Default: "301" Redirect HTTP redirect status code. Accepted values are 301 and 302 |
name | string Hostname |
destination | string URL where hostname is redirected to |
type | integer Default: "301" Redirect HTTP redirect status code. Accepted values are 301 and 302 |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
destination | string Value |
flag | integer Flag |
tag | string Tag |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
destination | string Value |
flag | integer Flag |
tag | string Tag |
name | string Hostname |
destination | string Value |
flag | integer Flag |
tag | string Tag |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string Value |
flag | integer Flag |
tag | string Tag |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
destination | string Value |
flag | integer Flag |
tag | string Tag |
name | string Hostname |
destination | string Value |
flag | integer Flag |
tag | string Tag |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
certificate_usage | integer Certificate usage: 0-3 |
selector | integer selector: 0-1 |
matching_type | integer Matching type: 0-2 |
destination | string Certificate Association Data |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
certificate_usage | integer Certificate usage: 0-3 |
selector | integer selector: 0-1 |
matching_type | integer Matching type: 0-2 |
destination | string Certificate Association Data |
name | string Hostname |
certificate_usage | integer Certificate usage: 0-3 |
selector | integer selector: 0-1 |
matching_type | integer Matching type: 0-2 |
destination | string Certificate Association Data |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
certificate_usage | integer Certificate usage: 0-3 |
selector | integer selector: 0-1 |
matching_type | integer Matching type: 0-2 |
destination | string Certificate Association Data |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
certificate_usage | integer Certificate usage: 0-3 |
selector | integer selector: 0-1 |
matching_type | integer Matching type: 0-2 |
destination | string Certificate Association Data |
name | string Hostname |
certificate_usage | integer Certificate usage: 0-3 |
selector | integer selector: 0-1 |
matching_type | integer Matching type: 0-2 |
destination | string Certificate Association Data |
resource_url | string API url to get this entity |
id | integer identificator |
name | string Hostname |
delete | boolean Can this record be deleted |
modify | boolean Can this record be modified |
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
Returns list of emails. Possible x-order-by values are created, address and disk_usage.
service_name required | string Unique name of service |
address | string Filter by address. |
archived | boolean Display with archived accounts. |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
x-order-by | string Order by field name |
x-order-dir | string Enum: "asc" "desc" Order direction |
resource_url | string API url to get this entity |
address | string identificator E-mail address (domain is in unicode format) |
comment | string Comment |
disk_size | integer Mailbox size in bytes |
disk_size_human | string Mailbox size in human readable form |
disk_usage | integer Mailbox usage in bytes |
disk_usage_human | string Mailbox usage in human readable form |
disk_usage_updated | string Disk usage update datetime in ISO 8601 format |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
spamlevel | string Enum: "none" "low" "medium" "high" Spamfilter level |
two_factor_auth | boolean 2-factor authentication state. Can only be set to false from API |
deleted_at | string <ISO 8601 date> Date and time the account was archived |
addresses | Array of strings Mail account associated addresses |
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "disk_size": 0,
- "disk_size_human": "string",
- "disk_usage": 0,
- "disk_usage_human": "string",
- "disk_usage_updated": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "spamlevel": "none",
- "two_factor_auth": true,
- "deleted_at": "string",
- "addresses": [
- "string"
]
}
]
service_name required | string Unique name of service |
address | string identificator E-mail address (domain is in unicode format) |
password | string Length: 10-64 digits. |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
spamlevel | string Enum: "none" "low" "medium" "high" Spamfilter level |
two_factor_auth | boolean 2-factor authentication state. Can only be set to false from API |
resource_url | string API url to get this entity |
address | string identificator E-mail address (domain is in unicode format) |
comment | string Comment |
disk_size | integer Mailbox size in bytes |
disk_size_human | string Mailbox size in human readable form |
disk_usage | integer Mailbox usage in bytes |
disk_usage_human | string Mailbox usage in human readable form |
disk_usage_updated | string Disk usage update datetime in ISO 8601 format |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
spamlevel | string Enum: "none" "low" "medium" "high" Spamfilter level |
two_factor_auth | boolean 2-factor authentication state. Can only be set to false from API |
deleted_at | string <ISO 8601 date> Date and time the account was archived |
addresses | Array of strings Mail account associated addresses |
{- "address": "string",
- "password": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "spamlevel": "none",
- "two_factor_auth": true
}
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "disk_size": 0,
- "disk_size_human": "string",
- "disk_usage": 0,
- "disk_usage_human": "string",
- "disk_usage_updated": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "spamlevel": "none",
- "two_factor_auth": true,
- "deleted_at": "string",
- "addresses": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
addresses | boolean Display email account associated addresses. |
resource_url | string API url to get this entity |
address | string identificator E-mail address (domain is in unicode format) |
comment | string Comment |
disk_size | integer Mailbox size in bytes |
disk_size_human | string Mailbox size in human readable form |
disk_usage | integer Mailbox usage in bytes |
disk_usage_human | string Mailbox usage in human readable form |
disk_usage_updated | string Disk usage update datetime in ISO 8601 format |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
spamlevel | string Enum: "none" "low" "medium" "high" Spamfilter level |
two_factor_auth | boolean 2-factor authentication state. Can only be set to false from API |
deleted_at | string <ISO 8601 date> Date and time the account was archived |
addresses | Array of strings Mail account associated addresses |
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "disk_size": 0,
- "disk_size_human": "string",
- "disk_usage": 0,
- "disk_usage_human": "string",
- "disk_usage_updated": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "spamlevel": "none",
- "two_factor_auth": true,
- "deleted_at": "string",
- "addresses": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
address | string identificator E-mail address (domain is in unicode format) |
password | string Length: 10-64 digits. |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
spamlevel | string Enum: "none" "low" "medium" "high" Spamfilter level |
two_factor_auth | boolean 2-factor authentication state. Can only be set to false from API |
resource_url | string API url to get this entity |
address | string identificator E-mail address (domain is in unicode format) |
comment | string Comment |
disk_size | integer Mailbox size in bytes |
disk_size_human | string Mailbox size in human readable form |
disk_usage | integer Mailbox usage in bytes |
disk_usage_human | string Mailbox usage in human readable form |
disk_usage_updated | string Disk usage update datetime in ISO 8601 format |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
spamlevel | string Enum: "none" "low" "medium" "high" Spamfilter level |
two_factor_auth | boolean 2-factor authentication state. Can only be set to false from API |
deleted_at | string <ISO 8601 date> Date and time the account was archived |
addresses | Array of strings Mail account associated addresses |
{- "address": "string",
- "password": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "spamlevel": "none",
- "two_factor_auth": true
}
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "disk_size": 0,
- "disk_size_human": "string",
- "disk_usage": 0,
- "disk_usage_human": "string",
- "disk_usage_updated": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "spamlevel": "none",
- "two_factor_auth": true,
- "deleted_at": "string",
- "addresses": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
address | string Filter by address. |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
resource_url | string API url to get this entity |
address | string E-mail address |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
mail_to_http_url | string URL where email is posted to |
change_pw_disabled | boolean Disable password change in webmail |
webmail_fw_disabled | boolean Disable forward in webmail |
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "mail_to_http_url": "string",
- "change_pw_disabled": true,
- "webmail_fw_disabled": true
}
]
Create E-mail account/forwarder
service_name required | string Unique name of service |
address | string E-mail address |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
resource_url | string API url to get this entity |
address | string E-mail address |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
mail_to_http_url | string URL where email is posted to |
change_pw_disabled | boolean Disable password change in webmail |
webmail_fw_disabled | boolean Disable forward in webmail |
{- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
]
}
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "mail_to_http_url": "string",
- "change_pw_disabled": true,
- "webmail_fw_disabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
address | string E-mail address |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
mail_to_http_url | string URL where email is posted to |
change_pw_disabled | boolean Disable password change in webmail |
webmail_fw_disabled | boolean Disable forward in webmail |
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "mail_to_http_url": "string",
- "change_pw_disabled": true,
- "webmail_fw_disabled": true
}
]
Update E-mail account/forwarder
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
address | string E-mail address |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
resource_url | string API url to get this entity |
address | string E-mail address |
comment | string Comment |
fwd_addresses | Array of strings Forward list |
autoreply | boolean Autoreply enabled state |
mail_to_http_url | string URL where email is posted to |
change_pw_disabled | boolean Disable password change in webmail |
webmail_fw_disabled | boolean Disable forward in webmail |
{- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
]
}
[- {
- "resource_url": "string",
- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "autoreply": true,
- "mail_to_http_url": "string",
- "change_pw_disabled": true,
- "webmail_fw_disabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
identificator | string identificator |
resource_url | string API url to get this entity |
type | string Enum: "zmail" "zonecloud" Account type |
name | string Application specific password description |
scopes | Array of strings Allowed scopes for the Application Password |
created | string Nullable Application password created timestamp |
last_used | string Nullable Datestring of last use or false if password has not been used |
[- {
- "identificator": "string",
- "resource_url": "string",
- "type": "zmail",
- "name": "string",
- "scopes": [
- "string"
], - "created": "string",
- "last_used": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
asp_id required | integer Application password identificator |
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
is_enabled | boolean Is enabled |
fromname | string Autoreply from name |
subject | string Autoreply subject |
body | string Autoreply body |
datestart | string <date> Autoreply start date (yyyy-mm-dd) |
dateend | string <date> Autoreply end date (yyyy-mm-dd) |
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
is_enabled | boolean Is enabled |
fromname | string Autoreply from name |
subject | string Autoreply subject |
body | string Autoreply body |
datestart | string <date> Autoreply start date (yyyy-mm-dd) |
dateend | string <date> Autoreply end date (yyyy-mm-dd) |
resource_url | string API url to get this entity |
is_enabled | boolean Is enabled |
fromname | string Autoreply from name |
subject | string Autoreply subject |
body | string Autoreply body |
datestart | string <date> Autoreply start date (yyyy-mm-dd) |
dateend | string <date> Autoreply end date (yyyy-mm-dd) |
{- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
is_enabled | boolean Is enabled |
fromname | string Autoreply from name |
subject | string Autoreply subject |
body | string Autoreply body |
datestart | string <date> Autoreply start date (yyyy-mm-dd) |
dateend | string <date> Autoreply end date (yyyy-mm-dd) |
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
is_enabled | boolean Is enabled |
fromname | string Autoreply from name |
subject | string Autoreply subject |
body | string Autoreply body |
datestart | string <date> Autoreply start date (yyyy-mm-dd) |
dateend | string <date> Autoreply end date (yyyy-mm-dd) |
resource_url | string API url to get this entity |
is_enabled | boolean Is enabled |
fromname | string Autoreply from name |
subject | string Autoreply subject |
body | string Autoreply body |
datestart | string <date> Autoreply start date (yyyy-mm-dd) |
dateend | string <date> Autoreply end date (yyyy-mm-dd) |
{- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
package | string Premium package handle or 'none' if not premium |
package_allowed | boolean Indicates if package can be enabled |
disk_size | integer Premium package allowed disk size in bytes |
disk_size_human | string Premium package allowed human readable disk size |
price_month | number <float> Premium package month price excluding VAT |
price_year | number <float> Premium package year price excluding VAT |
[- {
- "package": "string",
- "package_allowed": true,
- "disk_size": 0,
- "disk_size_human": "string",
- "price_month": 0,
- "price_year": 0
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
package | string Package handle of the premium package to be activated (use OPTIONS call to see available package handles) |
package | string Premium package handle or 'none' if not premium |
package_allowed | boolean Indicates if package can be enabled |
disk_size | integer Premium package allowed disk size in bytes |
disk_size_human | string Premium package allowed human readable disk size |
price_month | number <float> Premium package month price excluding VAT |
price_year | number <float> Premium package year price excluding VAT |
{- "package": "string"
}
[- {
- "package": "string",
- "package_allowed": true,
- "disk_size": 0,
- "disk_size_human": "string",
- "price_month": 0,
- "price_year": 0
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
package | string Premium package handle or 'none' if not premium |
package_allowed | boolean Indicates if package can be enabled |
disk_size | integer Premium package allowed disk size in bytes |
disk_size_human | string Premium package allowed human readable disk size |
price_month | number <float> Premium package month price excluding VAT |
price_year | number <float> Premium package year price excluding VAT |
[- {
- "package": "string",
- "package_allowed": true,
- "disk_size": 0,
- "disk_size_human": "string",
- "price_month": 0,
- "price_year": 0
}
]
service_name required | string Unique name of service |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
resource_url | string API url to get this entity |
username | string identificator readonly in update mode |
comment | string User assigned comment to account |
require_ssl | boolean Require SSL connection |
hosts | Array of strings Array of IP's that can connect using this user. Additional element can be added: ws - webserver, pma - phpmyadmin, vpn - vpn and list of external IP's (IPv4 and IPv6 are supported) |
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]
username field will be used as suffix for virtual server based name. When prefix is given inside name, then it's automatically detected
service_name required | string Unique name of service |
username | string identificator readonly in update mode |
comment | string User assigned comment to account |
password | string Length: 10-64 digits. |
require_ssl | boolean Require SSL connection |
hosts | Array of strings Array of IP's that can connect using this user. Additional element can be added: ws - webserver, pma - phpmyadmin, vpn - vpn and list of external IP's (IPv4 and IPv6 are supported) |
resource_url | string API url to get this entity |
username | string identificator readonly in update mode |
comment | string User assigned comment to account |
require_ssl | boolean Require SSL connection |
hosts | Array of strings Array of IP's that can connect using this user. Additional element can be added: ws - webserver, pma - phpmyadmin, vpn - vpn and list of external IP's (IPv4 and IPv6 are supported) |
{- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "password": "Rea11yS7r0ngPassw0rd",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]
service_name required | string Unique name of service |
database_username required | string Database account username |
resource_url | string API url to get this entity |
username | string identificator readonly in update mode |
comment | string User assigned comment to account |
require_ssl | boolean Require SSL connection |
hosts | Array of strings Array of IP's that can connect using this user. Additional element can be added: ws - webserver, pma - phpmyadmin, vpn - vpn and list of external IP's (IPv4 and IPv6 are supported) |
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]
only comment, password and hosts can be updated
service_name required | string Unique name of service |
database_username required | string Database account username |
username | string identificator readonly in update mode |
comment | string User assigned comment to account |
password | string Length: 10-64 digits. |
require_ssl | boolean Require SSL connection |
hosts | Array of strings Array of IP's that can connect using this user. Additional element can be added: ws - webserver, pma - phpmyadmin, vpn - vpn and list of external IP's (IPv4 and IPv6 are supported) |
resource_url | string API url to get this entity |
username | string identificator readonly in update mode |
comment | string User assigned comment to account |
require_ssl | boolean Require SSL connection |
hosts | Array of strings Array of IP's that can connect using this user. Additional element can be added: ws - webserver, pma - phpmyadmin, vpn - vpn and list of external IP's (IPv4 and IPv6 are supported) |
{- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "password": "Rea11yS7r0ngPassw0rd",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]
service_name required | string Unique name of service |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
resource_url | string API url to get this entity |
name required | string identificator |
comment | string User assigned comment to database |
collation | string Available only during creation. Defaults to utf8mb4_unicode_ci (check options request for available collations). |
disk_usage | string Database disk usage in bytes |
disk_usage_human | string Database disk usage in human readable format |
disk_usage_updated | string Disk usage update datetime |
[- {
- "resource_url": "string",
- "name": "string",
- "comment": "string",
- "collation": "string",
- "disk_usage": "string",
- "disk_usage_human": "string",
- "disk_usage_updated": "string"
}
]
name field will be used as suffix for virtual server based name. When prefix is given inside name, then it's automatically detected
service_name required | string Unique name of service |
name required | string identificator |
comment | string User assigned comment to database |
collation | string Available only during creation. Defaults to utf8mb4_unicode_ci (check options request for available collations). |
resource_url | string API url to get this entity |
name required | string identificator |
comment | string User assigned comment to database |
collation | string Available only during creation. Defaults to utf8mb4_unicode_ci (check options request for available collations). |
disk_usage | string Database disk usage in bytes |
disk_usage_human | string Database disk usage in human readable format |
disk_usage_updated | string Disk usage update datetime |
{- "name": "string",
- "comment": "string",
- "collation": "string"
}
[- {
- "resource_url": "string",
- "name": "string",
- "comment": "string",
- "collation": "string",
- "disk_usage": "string",
- "disk_usage_human": "string",
- "disk_usage_updated": "string"
}
]
service_name required | string Unique name of service |
database_name required | string Database name |
resource_url | string API url to get this entity |
name required | string identificator |
comment | string User assigned comment to database |
collation | string Available only during creation. Defaults to utf8mb4_unicode_ci (check options request for available collations). |
disk_usage | string Database disk usage in bytes |
disk_usage_human | string Database disk usage in human readable format |
disk_usage_updated | string Disk usage update datetime |
[- {
- "resource_url": "string",
- "name": "string",
- "comment": "string",
- "collation": "string",
- "disk_usage": "string",
- "disk_usage_human": "string",
- "disk_usage_updated": "string"
}
]
Get all account detailed permissions to all databases that it has access
service_name required | string Unique name of service |
database_username required | string Database account username |
resource_url | string API url to get this entity |
username | string Database username |
database | string Database name |
permissions | Array of strings Attributes that are allowed for this database |
[- {
- "resource_url": "string",
- "username": "string",
- "database": "string",
- "permissions": [
- "string"
]
}
]
Get list of supported MySQL permissions for this account
service_name required | string Unique name of service |
database_username required | string Database account username |
[- "string"
]
Get all account detailed permissions to given database
service_name required | string Unique name of service |
database_username required | string Database account username |
database_name required | string Database name |
resource_url | string API url to get this entity |
username | string Database username |
database | string Database name |
permissions | Array of strings Attributes that are allowed for this database |
[- {
- "resource_url": "string",
- "username": "string",
- "database": "string",
- "permissions": [
- "string"
]
}
]
service_name required | string Unique name of service |
database_username required | string Database account username |
database_name required | string Database name |
permissions | Array of strings Attributes that are allowed for this database |
resource_url | string API url to get this entity |
username | string Database username |
database | string Database name |
permissions | Array of strings Attributes that are allowed for this database |
{- "permissions": [
- "string"
]
}
[- {
- "resource_url": "string",
- "username": "string",
- "database": "string",
- "permissions": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
id | integer identificator |
name required | string Certificate name |
cn | string CN |
connected | boolean Connected to SSL cert in SSL services |
letsencrypt | boolean Is Let's Encrypt auto renewal certificate |
created | string Created datetime in ISO 8601 format |
private_key required | string Private key |
certificate required | string Certificate contents |
ca_certificate | string CA Certificate contents |
expires | string Expire datetime in ISO 8601 format |
hosts | Array of strings Hosts where this certificate is used |
Array of objects Relations |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "cn": "string",
- "connected": true,
- "letsencrypt": true,
- "created": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "expires": "string",
- "hosts": [
- "string"
], - "_links": [
- {
- "certificate": "string"
}
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
name required | string Certificate name |
private_key required | string Private key |
certificate required | string Certificate contents |
ca_certificate | string CA Certificate contents |
hosts | Array of strings Hosts where this certificate is used |
resource_url | string API url to get this entity |
id | integer identificator |
name required | string Certificate name |
cn | string CN |
connected | boolean Connected to SSL cert in SSL services |
letsencrypt | boolean Is Let's Encrypt auto renewal certificate |
created | string Created datetime in ISO 8601 format |
private_key required | string Private key |
certificate required | string Certificate contents |
ca_certificate | string CA Certificate contents |
expires | string Expire datetime in ISO 8601 format |
hosts | Array of strings Hosts where this certificate is used |
Array of objects Relations |
{- "name": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "hosts": [
- "string"
]
}
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "cn": "string",
- "connected": true,
- "letsencrypt": true,
- "created": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "expires": "string",
- "hosts": [
- "string"
], - "_links": [
- {
- "certificate": "string"
}
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
id | integer identificator |
name required | string Certificate name |
cn | string CN |
connected | boolean Connected to SSL cert in SSL services |
letsencrypt | boolean Is Let's Encrypt auto renewal certificate |
created | string Created datetime in ISO 8601 format |
private_key required | string Private key |
certificate required | string Certificate contents |
ca_certificate | string CA Certificate contents |
expires | string Expire datetime in ISO 8601 format |
hosts | Array of strings Hosts where this certificate is used |
Array of objects Relations |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "cn": "string",
- "connected": true,
- "letsencrypt": true,
- "created": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "expires": "string",
- "hosts": [
- "string"
], - "_links": [
- {
- "certificate": "string"
}
]
}
]
service_name required | string Unique name of service |
name required | string Certificate name |
private_key required | string Private key |
certificate required | string Certificate contents |
ca_certificate | string CA Certificate contents |
hosts | Array of strings Hosts where this certificate is used |
resource_url | string API url to get this entity |
id | integer identificator |
name required | string Certificate name |
cn | string CN |
connected | boolean Connected to SSL cert in SSL services |
letsencrypt | boolean Is Let's Encrypt auto renewal certificate |
created | string Created datetime in ISO 8601 format |
private_key required | string Private key |
certificate required | string Certificate contents |
ca_certificate | string CA Certificate contents |
expires | string Expire datetime in ISO 8601 format |
hosts | Array of strings Hosts where this certificate is used |
Array of objects Relations |
{- "name": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "hosts": [
- "string"
]
}
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "cn": "string",
- "connected": true,
- "letsencrypt": true,
- "created": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "expires": "string",
- "hosts": [
- "string"
], - "_links": [
- {
- "certificate": "string"
}
]
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | integer identificator |
name | string Name |
type | string Enum: "http" "system" Crontab type (http/system) |
active | boolean Is active |
report | string Enum: "never" "onerror" "onoutputorerror" "onoutput" "always" When to send report |
report_email | string Report e-mail |
command | string Crontab command location (url or path) |
priority | string Enum: "low" "normal" Priority |
schedule | string Schedule |
timezone | string Enum: "UTC" "Europe/Tallinn" "Europe/Amsterdam" "Europe/Helsinki" Timezone (only available when type==system) |
runtime_limit | integer Enum: 900 1800 3600 10800 86340 Runtime limit in seconds (only available when type==system) |
[- {
- "resource_url": "string",
- "identificator": 0,
- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "command": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}
]
service_name required | string Unique name of service |
name | string Name |
type | string Enum: "http" "system" Crontab type (http/system) |
active | boolean Is active |
report | string Enum: "never" "onerror" "onoutputorerror" "onoutput" "always" When to send report |
report_email | string Report e-mail |
command | string Crontab command location (url or path) |
priority | string Enum: "low" "normal" Priority |
schedule | string Schedule |
timezone | string Enum: "UTC" "Europe/Tallinn" "Europe/Amsterdam" "Europe/Helsinki" Timezone (only available when type==system) |
runtime_limit | integer Enum: 900 1800 3600 10800 86340 Runtime limit in seconds (only available when type==system) |
resource_url | string API url to get this entity |
identificator | integer identificator |
name | string Name |
type | string Enum: "http" "system" Crontab type (http/system) |
active | boolean Is active |
report | string Enum: "never" "onerror" "onoutputorerror" "onoutput" "always" When to send report |
report_email | string Report e-mail |
command | string Crontab command location (url or path) |
priority | string Enum: "low" "normal" Priority |
schedule | string Schedule |
timezone | string Enum: "UTC" "Europe/Tallinn" "Europe/Amsterdam" "Europe/Helsinki" Timezone (only available when type==system) |
runtime_limit | integer Enum: 900 1800 3600 10800 86340 Runtime limit in seconds (only available when type==system) |
{- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "command": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "command": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
identificator | integer identificator |
name | string Name |
type | string Enum: "http" "system" Crontab type (http/system) |
active | boolean Is active |
report | string Enum: "never" "onerror" "onoutputorerror" "onoutput" "always" When to send report |
report_email | string Report e-mail |
command | string Crontab command location (url or path) |
priority | string Enum: "low" "normal" Priority |
schedule | string Schedule |
timezone | string Enum: "UTC" "Europe/Tallinn" "Europe/Amsterdam" "Europe/Helsinki" Timezone (only available when type==system) |
runtime_limit | integer Enum: 900 1800 3600 10800 86340 Runtime limit in seconds (only available when type==system) |
[- {
- "resource_url": "string",
- "identificator": 0,
- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "command": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
name | string Name |
type | string Enum: "http" "system" Crontab type (http/system) |
active | boolean Is active |
report | string Enum: "never" "onerror" "onoutputorerror" "onoutput" "always" When to send report |
report_email | string Report e-mail |
command | string Crontab command location (url or path) |
priority | string Enum: "low" "normal" Priority |
schedule | string Schedule |
timezone | string Enum: "UTC" "Europe/Tallinn" "Europe/Amsterdam" "Europe/Helsinki" Timezone (only available when type==system) |
runtime_limit | integer Enum: 900 1800 3600 10800 86340 Runtime limit in seconds (only available when type==system) |
resource_url | string API url to get this entity |
identificator | integer identificator |
name | string Name |
type | string Enum: "http" "system" Crontab type (http/system) |
active | boolean Is active |
report | string Enum: "never" "onerror" "onoutputorerror" "onoutput" "always" When to send report |
report_email | string Report e-mail |
command | string Crontab command location (url or path) |
priority | string Enum: "low" "normal" Priority |
schedule | string Schedule |
timezone | string Enum: "UTC" "Europe/Tallinn" "Europe/Amsterdam" "Europe/Helsinki" Timezone (only available when type==system) |
runtime_limit | integer Enum: 900 1800 3600 10800 86340 Runtime limit in seconds (only available when type==system) |
{- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "command": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "command": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
password | string Redis auth key |
port | string Redis port |
ip | string IP address |
host | string Hostname |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
name | string Application name |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
{- "name": "string"
}
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
home_dir | string Application main instance home dir |
scriptname | string Application script name |
memory_limit | integer Application max memory usage |
available_memory | integer Allocatable memory for application |
resource_url | string API url to get this entity |
id | integer Application id |
name | string Application name |
status | string Application status |
enabled | boolean Application is enabled |
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
ip | string IP address |
id | integer identificator |
identificator | integer identificator |
ip | string IP address |
{- "ip": "string"
}
[- {
- "id": 0,
- "identificator": 0,
- "ip": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
acl_ip_identificator required | string Acl IP identificator |
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
id | integer (deprecated use identificator) |
identificator | integer identificator |
comment | string Name of host |
object (VServerDedicatedIP) | |
fport | integer From port |
dport | integer Destination port (is automatically filled with From port) |
acl_enabled | boolean Is acl enabled |
acls | Array of strings Access list ips and ids |
[- {
- "resource_url": "string",
- "id": 0,
- "identificator": 0,
- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "dport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
comment | string Name of host |
object (VServerDedicatedIP) | |
fport | integer From port |
acl_enabled | boolean Is acl enabled |
acls | Array of strings Access list ips and ids |
resource_url | string API url to get this entity |
id | integer (deprecated use identificator) |
identificator | integer identificator |
comment | string Name of host |
object (VServerDedicatedIP) | |
fport | integer From port |
dport | integer Destination port (is automatically filled with From port) |
acl_enabled | boolean Is acl enabled |
acls | Array of strings Access list ips and ids |
{- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}
[- {
- "resource_url": "string",
- "id": 0,
- "identificator": 0,
- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "dport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
resource_url | string API url to get this entity |
id | integer (deprecated use identificator) |
identificator | integer identificator |
comment | string Name of host |
object (VServerDedicatedIP) | |
fport | integer From port |
dport | integer Destination port (is automatically filled with From port) |
acl_enabled | boolean Is acl enabled |
acls | Array of strings Access list ips and ids |
[- {
- "resource_url": "string",
- "id": 0,
- "identificator": 0,
- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "dport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}
]
service_name required | string Unique name of service |
comment | string Name of host |
object (VServerDedicatedIP) | |
fport | integer From port |
acl_enabled | boolean Is acl enabled |
acls | Array of strings Access list ips and ids |
resource_url | string API url to get this entity |
id | integer (deprecated use identificator) |
identificator | integer identificator |
comment | string Name of host |
object (VServerDedicatedIP) | |
fport | integer From port |
dport | integer Destination port (is automatically filled with From port) |
acl_enabled | boolean Is acl enabled |
acls | Array of strings Access list ips and ids |
{- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}
[- {
- "resource_url": "string",
- "id": 0,
- "identificator": 0,
- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "dport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
ipv4 | string IPv4 |
ipv6 | string IPv6 |
vhosts | Array of strings Virtual hosts where this IP is used |
[- {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
ipv4 | string IPv4 |
ipv6 | string IPv6 |
vhosts | Array of strings Virtual hosts where this IP is used |
[- {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
ipv4 | string IPv4 |
ipv6 | string IPv6 |
vhosts | Array of strings Virtual hosts where this IP is used |
[- {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
identificator | string identificator |
resource_url | string API url to get this entity |
package | string Additional package uname |
name | string Additional package name |
quantity | integer Additional package quantity |
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]
service_name required | string Unique name of service |
quantity | integer Additional package quantity |
identificator | string identificator |
resource_url | string API url to get this entity |
package | string Additional package uname |
name | string Additional package name |
quantity | integer Additional package quantity |
{- "quantity": 0
}
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
identificator | string identificator |
resource_url | string API url to get this entity |
package | string Additional package uname |
name | string Additional package name |
quantity | integer Additional package quantity |
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
quantity | integer Additional package quantity |
identificator | string identificator |
resource_url | string API url to get this entity |
package | string Additional package uname |
name | string Additional package name |
quantity | integer Additional package quantity |
{- "quantity": 0
}
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | integer identificator |
comment | string Comment |
created | string Created |
created_human | string Created date in human readable format |
fingerprint | string Fingerprint |
last_used | string Last used |
type | string Type |
size | integer Size |
public_key | string Content |
[- {
- "resource_url": "string",
- "identificator": 0,
- "comment": "string",
- "created": "string",
- "created_human": "string",
- "fingerprint": "string",
- "last_used": "string",
- "type": "string",
- "size": 0,
- "public_key": "string"
}
]
service_name required | string Unique name of service |
comment | string Comment |
public_key | string Content |
resource_url | string API url to get this entity |
identificator | integer identificator |
comment | string Comment |
created | string Created |
created_human | string Created date in human readable format |
fingerprint | string Fingerprint |
last_used | string Last used |
type | string Type |
size | integer Size |
public_key | string Content |
{- "comment": "string",
- "public_key": "string"
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "comment": "string",
- "created": "string",
- "created_human": "string",
- "fingerprint": "string",
- "last_used": "string",
- "type": "string",
- "size": 0,
- "public_key": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
identificator | integer identificator |
comment | string Comment |
created | string Created |
created_human | string Created date in human readable format |
fingerprint | string Fingerprint |
last_used | string Last used |
type | string Type |
size | integer Size |
public_key | string Content |
[- {
- "resource_url": "string",
- "identificator": 0,
- "comment": "string",
- "created": "string",
- "created_human": "string",
- "fingerprint": "string",
- "last_used": "string",
- "type": "string",
- "size": 0,
- "public_key": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | integer identificator |
username | string Username |
webhosts | Array of strings Webhosts |
server_fingerprints | Array of strings Server fingerprints |
access | string Enum: "whitelist" "public" Access type |
ipv4 | string Server IPv4 |
ipv6 | string Server IPv6 |
[- {
- "resource_url": "string",
- "identificator": 0,
- "username": "string",
- "webhosts": [
- "string"
], - "server_fingerprints": [
- "string"
], - "access": "whitelist",
- "ipv4": "string",
- "ipv6": "string"
}
]
service_name required | string Unique name of service |
access | string Enum: "whitelist" "public" Access type |
resource_url | string API url to get this entity |
identificator | integer identificator |
username | string Username |
webhosts | Array of strings Webhosts |
server_fingerprints | Array of strings Server fingerprints |
access | string Enum: "whitelist" "public" Access type |
ipv4 | string Server IPv4 |
ipv6 | string Server IPv6 |
{- "access": "whitelist"
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "username": "string",
- "webhosts": [
- "string"
], - "server_fingerprints": [
- "string"
], - "access": "whitelist",
- "ipv4": "string",
- "ipv6": "string"
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | integer identificator |
ip | string IP (IPv4 or IPv6, supports prefix i.e. '217.128.0.0/24' etc) |
comment | string Comment |
[- {
- "resource_url": "string",
- "identificator": 0,
- "ip": "string",
- "comment": "string"
}
]
service_name required | string Unique name of service |
ip | string IP (IPv4 or IPv6, supports prefix i.e. '217.128.0.0/24' etc) |
comment | string Comment |
resource_url | string API url to get this entity |
identificator | integer identificator |
ip | string IP (IPv4 or IPv6, supports prefix i.e. '217.128.0.0/24' etc) |
comment | string Comment |
{- "ip": "string",
- "comment": "string"
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "ip": "string",
- "comment": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
identificator | integer identificator |
ip | string IP (IPv4 or IPv6, supports prefix i.e. '217.128.0.0/24' etc) |
comment | string Comment |
[- {
- "resource_url": "string",
- "identificator": 0,
- "ip": "string",
- "comment": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
status | string Current processing status |
datacenter | string Nullable Datacenter |
package | string Package |
package_human | string Package (human readable) |
os | string Operating System |
os_human | string Operating System (human readable) |
billing_period | integer Billing period in months |
identificator | integer identificator |
container | string Nullable Created container name/identificator |
ssh_public_key | string Nullable SSH public key for login |
[- {
- "resource_url": "string",
- "status": "string",
- "datacenter": "string",
- "package": "string",
- "package_human": "string",
- "os": "string",
- "os_human": "string",
- "billing_period": 0,
- "identificator": 0,
- "container": "string",
- "ssh_public_key": "string"
}
]
datacenter | string Nullable Datacenter |
package | string Package |
os | string Operating System |
billing_period | integer Billing period in months |
ssh_public_key | string Nullable SSH public key for login |
resource_url | string API url to get this entity |
status | string Current processing status |
datacenter | string Nullable Datacenter |
package | string Package |
package_human | string Package (human readable) |
os | string Operating System |
os_human | string Operating System (human readable) |
billing_period | integer Billing period in months |
identificator | integer identificator |
container | string Nullable Created container name/identificator |
ssh_public_key | string Nullable SSH public key for login |
{- "datacenter": "string",
- "package": "string",
- "os": "string",
- "billing_period": 0,
- "ssh_public_key": "string"
}
[- {
- "resource_url": "string",
- "status": "string",
- "datacenter": "string",
- "package": "string",
- "package_human": "string",
- "os": "string",
- "os_human": "string",
- "billing_period": 0,
- "identificator": 0,
- "container": "string",
- "ssh_public_key": "string"
}
]
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
status | string Current processing status |
datacenter | string Nullable Datacenter |
package | string Package |
package_human | string Package (human readable) |
os | string Operating System |
os_human | string Operating System (human readable) |
billing_period | integer Billing period in months |
identificator | integer identificator |
container | string Nullable Created container name/identificator |
ssh_public_key | string Nullable SSH public key for login |
[- {
- "resource_url": "string",
- "status": "string",
- "datacenter": "string",
- "package": "string",
- "package_human": "string",
- "os": "string",
- "os_human": "string",
- "billing_period": 0,
- "identificator": 0,
- "container": "string",
- "ssh_public_key": "string"
}
]
Returns list of all domains that user owns or is delegated to manage. Possible x-order-by values are expires and name.
name | string Only get domain names which contain the string |
renewable | boolean Show renewable domains for user |
delegated | boolean Filter domains by only delegated or only owner services. |
needs_renewal | boolean Filter domains that will expire in 30 days. |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
x-order-by | string Order by field name |
x-order-dir | string Enum: "asc" "desc" Order direction |
resource_url | string API url to get this entity |
name | string Domain name |
delegated | string Username of the domain owner if delegated |
expires | string When does this domain expire |
dnssec | boolean Dnssec |
autorenew | boolean Is domain autorenew enabled |
renew_order | string False if not renewable domain, null if no pending order or order_id |
renewal_notifications | boolean Are renewal reminders turned on |
has_pending_trade | integer|null Domain has a pending trade operation |
has_pending_dnssec | boolean Domain has a pending dnssec change |
reactivate | boolean Can this domain be reactivated |
auth_key_enabled | boolean Does this TLD use authorization key |
signing_required | boolean Signing required |
nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Array of objects Relations |
[- {
- "resource_url": "string",
- "name": "string",
- "delegated": "string",
- "expires": "string",
- "dnssec": true,
- "autorenew": true,
- "renew_order": "string",
- "renewal_notifications": true,
- "has_pending_trade": null,
- "has_pending_dnssec": true,
- "reactivate": true,
- "auth_key_enabled": true,
- "signing_required": true,
- "nameservers_custom": true,
- "_links": [
- {
- "nameserver": "string",
- "contact": "string",
- "webhosting": null
}
]
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
name | string Domain name |
delegated | string Username of the domain owner if delegated |
expires | string When does this domain expire |
dnssec | boolean Dnssec |
autorenew | boolean Is domain autorenew enabled |
renew_order | string False if not renewable domain, null if no pending order or order_id |
renewal_notifications | boolean Are renewal reminders turned on |
has_pending_trade | integer|null Domain has a pending trade operation |
has_pending_dnssec | boolean Domain has a pending dnssec change |
reactivate | boolean Can this domain be reactivated |
auth_key_enabled | boolean Does this TLD use authorization key |
signing_required | boolean Signing required |
nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Array of objects Relations |
[- {
- "resource_url": "string",
- "name": "string",
- "delegated": "string",
- "expires": "string",
- "dnssec": true,
- "autorenew": true,
- "renew_order": "string",
- "renewal_notifications": true,
- "has_pending_trade": null,
- "has_pending_dnssec": true,
- "reactivate": true,
- "auth_key_enabled": true,
- "signing_required": true,
- "nameservers_custom": true,
- "_links": [
- {
- "nameserver": "string",
- "contact": "string",
- "webhosting": null
}
]
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
name | string Domain name |
delegated | string Username of the domain owner if delegated |
expires | string When does this domain expire |
dnssec | boolean Dnssec |
autorenew | boolean Is domain autorenew enabled |
renew_order | string False if not renewable domain, null if no pending order or order_id |
renewal_notifications | boolean Are renewal reminders turned on |
has_pending_trade | integer|null Domain has a pending trade operation |
has_pending_dnssec | boolean Domain has a pending dnssec change |
reactivate | boolean Can this domain be reactivated |
auth_key_enabled | boolean Does this TLD use authorization key |
signing_required | boolean Signing required |
nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Array of objects Relations |
[- {
- "resource_url": "string",
- "name": "string",
- "delegated": "string",
- "expires": "string",
- "dnssec": true,
- "autorenew": true,
- "renew_order": "string",
- "renewal_notifications": true,
- "has_pending_trade": null,
- "has_pending_dnssec": true,
- "reactivate": true,
- "auth_key_enabled": true,
- "signing_required": true,
- "nameservers_custom": true,
- "_links": [
- {
- "nameserver": "string",
- "contact": "string",
- "webhosting": null
}
]
}
]
Array of objects | |
Array of objects | |
Array of objects |
{- "renewal_options": [
- {
- "action": "string",
- "action_periods": [
- {
- "period": 0,
- "expire_new": "2019-08-24T14:15:22Z",
- "price_per_year": 0,
- "total_price": 0,
- "total_price_with_tax": 0
}
]
}
], - "nameserver": [
- {
- "min": 0,
- "max": 0
}
], - "contact": [
- {
- "registrant": [
- {
- "min": 0,
- "max": 0
}
], - "admin": [
- {
- "min": 0,
- "max": 0
}
], - "tech": [
- {
- "min": 0,
- "max": 0
}
]
}
]
}
Returns all domain preferences
resource_url | string API url to get this entity |
renewal_notifications | boolean Are renewal reminders turned on |
[- {
- "resource_url": "string",
- "renewal_notifications": true
}
]
service_name required | string Unique name of service |
renewal_notifications | boolean Are renewal reminders turned on |
resource_url | string API url to get this entity |
renewal_notifications | boolean Are renewal reminders turned on |
{- "renewal_notifications": true
}
[- {
- "resource_url": "string",
- "renewal_notifications": true
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
hostname | string Hostname |
ip | Array of strings IP address |
[- {
- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
]
service_name required | string Unique name of service |
hostname | string Hostname |
ip | Array of strings IP address |
resource_url | string API url to get this entity |
hostname | string Hostname |
ip | Array of strings IP address |
[- {
- "hostname": "string",
- "ip": [
- "string"
]
}
]
[- {
- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
]
service_name required | string Unique name of service |
hostname required | string Hostname (main or subdomain) |
resource_url | string API url to get this entity |
hostname | string Hostname |
ip | Array of strings IP address |
[- {
- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
]
service_name required | string Unique name of service |
hostname required | string Hostname (main or subdomain) |
hostname | string Hostname |
ip | Array of strings IP address |
resource_url | string API url to get this entity |
hostname | string Hostname |
ip | Array of strings IP address |
{- "hostname": "string",
- "ip": [
- "string"
]
}
{- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
x-pager-page | integer Page number. Default is 1. |
x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
identificator | string identificator |
errors | string Number of failed rows. null when none |
datetime_ordered | string <ISO 8601 date> Date and time the order was created in |
resource_url | string API url to get this entity |
[- {
- "identificator": "string",
- "errors": "string",
- "datetime_ordered": "string",
- "resource_url": "string"
}
]
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
identificator | string identificator |
errors | string Number of failed rows. null when none |
datetime_ordered | string <ISO 8601 date> Date and time the order was created in |
resource_url | string API url to get this entity |
[- {
- "identificator": "string",
- "errors": "string",
- "datetime_ordered": "string",
- "resource_url": "string"
}
]
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
domain | string Domain name |
period | integer Renew/reactivate period from Domain Options request |
identificator | string identificator |
errors | string Number of failed rows. null when none |
datetime_ordered | string <ISO 8601 date> Date and time the order was created in |
resource_url | string API url to get this entity |
[- {
- "domain": "string",
- "period": 0
}
]
[- {
- "identificator": "string",
- "errors": "string",
- "datetime_ordered": "string",
- "resource_url": "string"
}
]
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | integer identificator |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
[- {
- "resource_url": "string",
- "identificator": 0,
- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
]
NB! fillable and required fields depend on TLD and on data sent (eg. person/company)
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
resource_url | string API url to get this entity |
identificator | integer identificator |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
{- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
resource_url | string API url to get this entity |
identificator | integer identificator |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
[- {
- "resource_url": "string",
- "identificator": 0,
- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
]
NB! fillable and required fields depend on TLD and on data sent (eg. person/company)
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
resource_url | string API url to get this entity |
identificator | integer identificator |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
{- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
[- {
- "resource_url": "string",
- "identificator": 0,
- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
]
service_name required | string Unique name of service |
identificator required | string Unique identificator of requested resource. If applicable then human readable (for example domain name, hostname etc...), if not, then usually numeric ID. Marked as identificator in resource schema, otherwise same as resource identificator property. |
service_name required | string Unique name of service |
resource_url | string API url to get this entity |
identificator | integer identificator |
role | string Enum: "registrant" "tech" "admin" Role |
type | string Type |
first_name | string First name |
last_name | string Last name |
name | string Full name |
organization | string Organization |
string | |
voice | string Phone |
fax | string Fax |
country | string Country |
state | string State |
city | string City |
street | string Street |
postalcode | string Postal code |
ext_language | string Language |
ext_ident | string Identification number |
ext_ident_type | string Enum: "private_number" "company_number" "birthday" Identification type |
ext_ident_cc | string Identification country code |
ext_vatnr | string VAT number |
ext_department | string Department |
ext_passport | string Passport |
ext_legal_form | string Legal form |
registry_handle | string The domain holder's ID |
[- {
- "resource_url": "string",
- "identificator": 0,
- "role": "registrant",
- "type": "string",
- "first_name": "string",
- "last_name": "string",
- "name": "string",
- "organization": "string",
- "email": "string",
- "voice": "string",
- "fax": "string",
- "country": "string",
- "state": "string",
- "city": "string",
- "street": "string",
- "postalcode": "string",
- "ext_language": "string",
- "ext_ident": "string",
- "ext_ident_type": "private_number",
- "ext_ident_cc": "string",
- "ext_vatnr": "string",
- "ext_department": "string",
- "ext_passport": "string",
- "ext_legal_form": "string",
- "registry_handle": "string"
}
]