ZoneID API (2.0)
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:
- username is ZoneID username
- password is API key that can be generated under ZoneID account management
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
- Domain: domain
- Webhosting: vserver
- DNS: dns
- Cloudserver VPS: cloud
{service_name} is
- Domain: domain name (e.g. example.com)
- Webhosting: virtual server name (e.g. example.com)
- DNS: Nameserver zone name (e.g. example.com)
- Cloudserver VPS: VPS host name (e.g. uvn-XX-XXX.tll01.zonevs.eu)
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/1or to get all DNS A Records, we use following url:
https://api.zone.eu/v2/dns/example.com/aThere 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.
- X-Ratelimit-Limit The number of request that is allowed to be made in a minute
- X-Ratelimit-Remaining The number of remaining requests until reset
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.
- Update IP only when it's changed and don't post same data again.
- Keep track of last IP on your side and don't ask it from API after every n minutes to compare it with current one.
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
}
]Get DNS zone
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| identificator | string identificator |
| active | boolean Is zone active |
| ipv6 | boolean Are ipv6 records allowed |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": "string",
- "active": true,
- "ipv6": false
}
]Update DNS zone
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| identificator | string identificator |
| active | boolean Is zone active |
| ipv6 | boolean Are ipv6 records allowed |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": "string",
- "active": true,
- "ipv6": false
}
]get Zone A records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create A record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| destination | string IPv4 |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get A record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update A record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| destination | string IPv4 |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete A record
Authorizations:
path Parameters
| 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. |
Responses
get Zone AAAA records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create AAAA record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| destination | string IPv6 |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get AAAA record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update AAAA record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| destination | string IPv6 |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete AAAA record
Authorizations:
path Parameters
| 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. |
Responses
get Zone NS records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create NS record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| destination | string Destination |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get NS record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update NS record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| destination | string Destination |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete NS record
Authorizations:
path Parameters
| 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. |
Responses
get Zone MX records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create MX record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| priority | integer Priority |
| destination | string Destination |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get MX record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update MX record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| priority | integer Priority |
| destination | string Destination |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete MX record
Authorizations:
path Parameters
| 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. |
Responses
get Zone CNAME records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create CNAME record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| destination | string Destination |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get CNAME record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update CNAME record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| destination | string Destination |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete CNAME record
Authorizations:
path Parameters
| 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. |
Responses
get Zone TXT records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create TXT record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| destination | string TXT content value |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get TXT record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update TXT record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| destination | string TXT content value |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete TXT record
Authorizations:
path Parameters
| 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. |
Responses
get Zone SSHFP records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create SSHFP record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get SSHFP record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update SSHFP record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete SSHFP record
Authorizations:
path Parameters
| 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. |
Responses
get Zone SRV records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create SRV record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| priority | integer Priority |
| weight | integer Weight |
| port | integer Port |
| destination | string Target |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get SRV record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update SRV record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| priority | integer Priority |
| weight | integer Weight |
| port | integer Port |
| destination | string Target |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete SRV record
Authorizations:
path Parameters
| 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. |
Responses
get Zone URL records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create URL record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get URL record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update URL record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete URL record
Authorizations:
path Parameters
| 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. |
Responses
get Zone CAA records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create CAA record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| destination | string Value |
| flag | integer Flag |
| tag | string Tag |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get CAA record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update CAA record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| destination | string Value |
| flag | integer Flag |
| tag | string Tag |
| name | string Hostname |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete CAA record
Authorizations:
path Parameters
| 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. |
Responses
get Zone TLSA records
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Create TLSA record
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 201
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]get TLSA record
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Update TLSA record
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
| comment | string Comment |
Request samples
- Payload
{- "destination": "server.example.com",
- "name": "prefix.example.com"
}Response samples
- 200
[- {
- "resource_url": "string",
- "destination": "server.example.com",
- "id": "123",
- "name": "prefix.example.com",
- "delete": true,
- "modify": true,
- "comment": "string"
}
]Delete TLSA record
Authorizations:
path Parameters
| 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. |
Responses
Display listing of E-mail accounts
Returns list of emails. Possible x-order-by values are created, address and disk_usage.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
query Parameters
| address | string Filter by address. |
| archived | boolean Display with archived accounts. |
header Parameters
| 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 |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
]
}
]Create E-mail account
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "address": "string",
- "password": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "spamlevel": "none",
- "two_factor_auth": true
}Response samples
- 201
[- {
- "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"
]
}
]Get specific E-mail account
Authorizations:
path Parameters
| 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. |
query Parameters
| addresses | boolean Display email account associated addresses. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
]
}
]Update E-mail account
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "address": "string",
- "password": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
], - "spamlevel": "none",
- "two_factor_auth": true
}Response samples
- 200
[- {
- "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"
]
}
]Delete E-mail account
Authorizations:
path Parameters
| 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. |
Responses
Display listing of E-mail forwarders
Authorizations:
path Parameters
| service_name required | string Unique name of service |
query Parameters
| address | string Filter by address. |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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 forwarder
Create E-mail account/forwarder
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| address | string E-mail address |
| comment | string Comment |
| fwd_addresses | Array of strings Forward list |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
]
}Response samples
- 201
[- {
- "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
}
]Get specific E-mail forwarder
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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 forwarder
Update E-mail account/forwarder
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| address | string E-mail address |
| comment | string Comment |
| fwd_addresses | Array of strings Forward list |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "address": "string",
- "comment": "string",
- "fwd_addresses": [
- "string"
]
}Response samples
- 200
[- {
- "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
}
]Delete E-mail forwarder
Authorizations:
path Parameters
| 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. |
Responses
Display listing of E-mail app passwords
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "type": "zmail",
- "name": "string",
- "scopes": [
- "string"
], - "created": "string",
- "last_used": "string"
}
]Delete E-mail app passsword
Authorizations:
path Parameters
| 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 |
Responses
Get autoreply info for mail account
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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) |
Response samples
- 200
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]Update autoreply for mail account
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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) |
Responses
Response Schema: application/json
| 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) |
Request samples
- Payload
{- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}Response samples
- 200
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]Get autoreply info for mail forwarder
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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) |
Response samples
- 200
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]Update autoreply for mail forwarder
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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) |
Responses
Response Schema: application/json
| 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) |
Request samples
- Payload
{- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}Response samples
- 200
[- {
- "resource_url": "string",
- "is_enabled": true,
- "fromname": "string",
- "subject": "string",
- "body": "string",
- "datestart": "2019-08-24",
- "dateend": "2019-08-24"
}
]Get specific E-mail accounts premium status
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| trial_period | integer Trial period in days |
Response samples
- 200
[- {
- "package": "string",
- "package_allowed": true,
- "disk_size": 0,
- "disk_size_human": "string",
- "price_month": 0,
- "price_year": 0,
- "trial_period": 0
}
]Turn on/off specific E-mail accounts premium package
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| package | string Package handle of the premium package to be activated (use OPTIONS call to see available package handles) |
Responses
Response Schema: application/json
| 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 |
| trial_period | integer Trial period in days |
Request samples
- Payload
{- "package": "string"
}Response samples
- 201
[- {
- "package": "string",
- "package_allowed": true,
- "disk_size": 0,
- "disk_size_human": "string",
- "price_month": 0,
- "price_year": 0,
- "trial_period": 0
}
]See available premium packages for specific E-mail account or new account (enter @Virtserver.Name as identificator)
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
| trial_period | integer Trial period in days |
Response samples
- 200
[- {
- "package": "string",
- "package_allowed": true,
- "disk_size": 0,
- "disk_size_human": "string",
- "price_month": 0,
- "price_year": 0,
- "trial_period": 0
}
]Get apache config
Get apache config for this (sub)domain
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| scheme | string Enum: "https" "http" HTTP scheme |
| homedir | string Home directory path |
| docroot | string Directory where Apache serves files from. Relative to homedir. Not used when proxy_backend_port is configured. |
| proxy_backend_port | string Nullable Mod_proxy port. Used to serve applications using loopback IP address (e.g NodeJS application). Disabled serving PHP over apache. |
| php_version | string PHP version |
| php_version_deprecated | boolean PHP version deprecation status |
| php_version_test_url | string URL to GUI to test other PHP versions without changing server configs |
| is_php_version_owner | boolean Whether the PHP version on this (sub)domain affects others (false when use_http_settings_for_https or HTTP redirect are true, or a proxy_backend_port is configured for subdomain). |
| php_upgrade_strategy | string Value: "" Strategy for auto updating PHP versions. Check OPTIONS query for values |
Response samples
- 200
[- {
- "resource_url": "string",
- "scheme": "https",
- "homedir": "string",
- "docroot": "string",
- "proxy_backend_port": "string",
- "php_version": "string",
- "php_version_deprecated": true,
- "php_version_test_url": "string",
- "is_php_version_owner": true,
- "php_upgrade_strategy": ""
}
]Update apache config
Update apache config for this (sub)domain. When host has both schemes present, scheme must be provided in request body.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Request Body schema: application/json
| docroot | string Directory where Apache serves files from. Relative to homedir. Not used when proxy_backend_port is configured. |
| proxy_backend_port | string Nullable Mod_proxy port. Used to serve applications using loopback IP address (e.g NodeJS application). Disabled serving PHP over apache. |
| php_version | string PHP version |
| php_upgrade_strategy | string Value: "" Strategy for auto updating PHP versions. Check OPTIONS query for values |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| scheme | string Enum: "https" "http" HTTP scheme |
| homedir | string Home directory path |
| docroot | string Directory where Apache serves files from. Relative to homedir. Not used when proxy_backend_port is configured. |
| proxy_backend_port | string Nullable Mod_proxy port. Used to serve applications using loopback IP address (e.g NodeJS application). Disabled serving PHP over apache. |
| php_version | string PHP version |
| php_version_deprecated | boolean PHP version deprecation status |
| php_version_test_url | string URL to GUI to test other PHP versions without changing server configs |
| is_php_version_owner | boolean Whether the PHP version on this (sub)domain affects others (false when use_http_settings_for_https or HTTP redirect are true, or a proxy_backend_port is configured for subdomain). |
| php_upgrade_strategy | string Value: "" Strategy for auto updating PHP versions. Check OPTIONS query for values |
Request samples
- Payload
{- "docroot": "string",
- "proxy_backend_port": "string",
- "php_version": "string",
- "php_upgrade_strategy": ""
}Response samples
- 201
[- {
- "resource_url": "string",
- "scheme": "https",
- "homedir": "string",
- "docroot": "string",
- "proxy_backend_port": "string",
- "php_version": "string",
- "php_version_deprecated": true,
- "php_version_test_url": "string",
- "is_php_version_owner": true,
- "php_upgrade_strategy": ""
}
]Get apache config options
Get applicable apache config options
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Responses
Response Schema: application/json
object (HostApacheOptions) List of options when applicable | |
object (HostApacheOptions) List of options when applicable |
Response samples
- 200
{- "https": {
- "php_version": [
- "string"
], - "php_upgrade_strategy": [
- "string"
]
}, - "http": {
- "php_version": [
- "string"
], - "php_upgrade_strategy": [
- "string"
]
}
}Get a single (sub)domain
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
query Parameters
| check_ready | boolean Checks for host reachability; adds a |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| name | string Host name. Required when creating a new host. Cannot be updated. |
| type | string Enum: "parent" "child" Indicates whether host is a primary domain or a subdomain. |
| scheme | string Enum: "http" "https" "http&https" "http|https" What scheme is used to serve this host |
| letsencrypt_status | string|null Enum: "waiting" "failed" Let's Encrypt certificate processing status |
| certificate | integer|null SSL certificate id |
| ready | boolean Indicates that host is deployed to server and is usable. Only shown when check_ready query parameter is true. |
Array of objects (HostApache) Apache settings per scheme. Only present when the apache query parameter is used. |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "parent",
- "scheme": "http",
- "letsencrypt_status": "waiting",
- "certificate": null,
- "ready": true,
- "apache": [
- {
- "resource_url": "string",
- "scheme": "https",
- "homedir": "string",
- "docroot": "string",
- "proxy_backend_port": "string",
- "php_version": "string",
- "php_version_deprecated": true,
- "php_version_test_url": "string",
- "is_php_version_owner": true,
- "php_upgrade_strategy": ""
}
]
}
]Get all (sub)domains
Authorizations:
path Parameters
| service_name required | string Unique name of service |
query Parameters
| hostname | string Only hosts whose name contains this string |
| apache | boolean Include apache settings for each host |
| apache[php_version_deprecated] | boolean Only hosts that use a deprecated PHP version when true |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| name | string Host name. Required when creating a new host. Cannot be updated. |
| type | string Enum: "parent" "child" Indicates whether host is a primary domain or a subdomain. |
| scheme | string Enum: "http" "https" "http&https" "http|https" What scheme is used to serve this host |
| letsencrypt_status | string|null Enum: "waiting" "failed" Let's Encrypt certificate processing status |
| certificate | integer|null SSL certificate id |
| ready | boolean Indicates that host is deployed to server and is usable. Only shown when check_ready query parameter is true. |
Array of objects (HostApache) Apache settings per scheme. Only present when the apache query parameter is used. |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "parent",
- "scheme": "http",
- "letsencrypt_status": "waiting",
- "certificate": null,
- "ready": true,
- "apache": [
- {
- "resource_url": "string",
- "scheme": "https",
- "homedir": "string",
- "docroot": "string",
- "proxy_backend_port": "string",
- "php_version": "string",
- "php_version_deprecated": true,
- "php_version_test_url": "string",
- "is_php_version_owner": true,
- "php_upgrade_strategy": ""
}
]
}
]Create new (sub)domain
Create a new https host for webhosting service. name is required and must be a subdomain for services main domain.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| name | string Host name. Required when creating a new host. Cannot be updated. |
| certificate | integer|null SSL certificate id |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| name | string Host name. Required when creating a new host. Cannot be updated. |
| type | string Enum: "parent" "child" Indicates whether host is a primary domain or a subdomain. |
| scheme | string Enum: "http" "https" "http&https" "http|https" What scheme is used to serve this host |
| letsencrypt_status | string|null Enum: "waiting" "failed" Let's Encrypt certificate processing status |
| certificate | integer|null SSL certificate id |
| ready | boolean Indicates that host is deployed to server and is usable. Only shown when check_ready query parameter is true. |
Array of objects (HostApache) Apache settings per scheme. Only present when the apache query parameter is used. |
Request samples
- Payload
{- "name": "string",
- "certificate": null
}Response samples
- 201
[- {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "parent",
- "scheme": "http",
- "letsencrypt_status": "waiting",
- "certificate": null,
- "ready": true,
- "apache": [
- {
- "resource_url": "string",
- "scheme": "https",
- "homedir": "string",
- "docroot": "string",
- "proxy_backend_port": "string",
- "php_version": "string",
- "php_version_deprecated": true,
- "php_version_test_url": "string",
- "is_php_version_owner": true,
- "php_upgrade_strategy": ""
}
]
}
]Get MySQL account list
Authorizations:
path Parameters
| service_name required | string Unique name of service |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
Responses
Response Schema: application/json
| 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) |
Response samples
- 200
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]Add new MySQL account
username field will be used as suffix for virtual server based name. When prefix is given inside name, then it's automatically detected
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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) |
Responses
Response Schema: application/json
| 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) |
Request samples
- Payload
{- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "password": "Rea11yS7r0ngPassw0rd",
- "require_ssl": true,
- "hosts": [
- "string"
]
}Response samples
- 201
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]Get MySQL account
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_username required | string Database account username |
Responses
Response Schema: application/json
| 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) |
Response samples
- 200
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]Update MySQL account
only comment, password and hosts can be updated
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_username required | string Database account username |
Request Body schema: application/json
| 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) |
Responses
Response Schema: application/json
| 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) |
Request samples
- Payload
{- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "password": "Rea11yS7r0ngPassw0rd",
- "require_ssl": true,
- "hosts": [
- "string"
]
}Response samples
- 200
[- {
- "resource_url": "string",
- "username": "dnXXX_myname",
- "comment": "New database for development application",
- "require_ssl": true,
- "hosts": [
- "string"
]
}
]Get MySQL Database list
Authorizations:
path Parameters
| service_name required | string Unique name of service |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "name": "string",
- "comment": "string",
- "collation": "string",
- "disk_usage": "string",
- "disk_usage_human": "string",
- "disk_usage_updated": "string"
}
]Add new MySQL database
name field will be used as suffix for virtual server based name. When prefix is given inside name, then it's automatically detected
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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). |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "name": "string",
- "comment": "string",
- "collation": "string"
}Response samples
- 201
[- {
- "resource_url": "string",
- "name": "string",
- "comment": "string",
- "collation": "string",
- "disk_usage": "string",
- "disk_usage_human": "string",
- "disk_usage_updated": "string"
}
]Get MySQL Database
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_name required | string Database name |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "name": "string",
- "comment": "string",
- "collation": "string",
- "disk_usage": "string",
- "disk_usage_human": "string",
- "disk_usage_updated": "string"
}
]Get all SQL account permissions
Get all account detailed permissions to all databases that it has access
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_username required | string Database account username |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "username": "string",
- "database": "string",
- "permissions": [
- "string"
]
}
]Get available permissions for SQL account
Get list of supported MySQL permissions for this account
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_username required | string Database account username |
Responses
Response Schema: application/json
Response samples
- 200
[- "string"
]Get SQL account permissions for specific database
Get all account detailed permissions to given database
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_username required | string Database account username |
| database_name required | string Database name |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "username": "string",
- "database": "string",
- "permissions": [
- "string"
]
}
]Set SQL account permissions for specific database
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| database_username required | string Database account username |
| database_name required | string Database name |
Request Body schema: application/json
| permissions | Array of strings Attributes that are allowed for this database |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "permissions": [
- "string"
]
}Response samples
- 200
[- {
- "resource_url": "string",
- "username": "string",
- "database": "string",
- "permissions": [
- "string"
]
}
]Get specific SSL from this webhosting server
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
}
]
}
]Update certificate data
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "name": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "hosts": [
- "string"
]
}Response samples
- 200
[- {
- "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"
}
]
}
]Delete SSL certificate
Authorizations:
path Parameters
| 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. |
Responses
Get all SSL certificates that are added to this webhosting server
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
}
]
}
]Add new SSL certificate
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "name": "string",
- "private_key": "string",
- "certificate": "string",
- "ca_certificate": "string",
- "hosts": [
- "string"
]
}Response samples
- 201
[- {
- "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"
}
]
}
]Display listing of crontabs
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| identificator | integer identificator |
| name | string Name |
| type | string Enum: "http" "system" Crontab exec 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" "high" 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) |
Response samples
- 200
[- {
- "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
}
]Create crontab
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| command | string Crontab command location (url or path). Crontab commands with type "system" may use path and binary variables from the options response. |
| name | string Name |
| type | string Enum: "http" "system" Crontab exec 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 |
| priority | string Enum: "low" "normal" "high" 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) |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| identificator | integer identificator |
| name | string Name |
| type | string Enum: "http" "system" Crontab exec 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" "high" 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) |
Request samples
- Payload
{- "command": "string",
- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}Response samples
- 201
[- {
- "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
}
]Get crontab options
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| exec_type | Array of strings Execution types |
| schedule_type | Array of strings Schedule types |
| report | Array of strings Reporting options |
| nice | Array of strings Priority of crontab |
| timezone | Array of strings Available timezones |
| default_timezone | string Default timezone based on server location |
| runtime_limit | Array of integers Runtime limit in seconds |
object List of variables which can be used in system commands |
Response samples
- 200
{- "exec_type": [
- "string"
], - "schedule_type": [
- "string"
], - "report": [
- "string"
], - "nice": [
- "string"
], - "timezone": [
- "string"
], - "default_timezone": "string",
- "runtime_limit": [
- 0
], - "command_variables": {
- "[[$PHP86]]": "/opt/zone/bin/php86-cli"
}
}Display specific crontab
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| identificator | integer identificator |
| name | string Name |
| type | string Enum: "http" "system" Crontab exec 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" "high" 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) |
Response samples
- 200
[- {
- "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
}
]Update crontab
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| command | string Crontab command location (url or path). Crontab commands with type "system" may use path and binary variables from the options response. |
| name | string Name |
| type | string Enum: "http" "system" Crontab exec 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 |
| priority | string Enum: "low" "normal" "high" 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) |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| identificator | integer identificator |
| name | string Name |
| type | string Enum: "http" "system" Crontab exec 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" "high" 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) |
Request samples
- Payload
{- "command": "string",
- "name": "string",
- "type": "http",
- "active": true,
- "report": "never",
- "report_email": "string",
- "priority": "low",
- "schedule": "string",
- "timezone": "UTC",
- "runtime_limit": 900
}Response samples
- 200
[- {
- "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
}
]Delete crontab
Authorizations:
path Parameters
| 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. |
Responses
Get Redis database process
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Activate Redis database
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Get specified Redis database process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Start Redis process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Restart Redis process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Stop Redis process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Generate new Redis auth key
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 201
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Get PM2 (NodeJS, Python, sh, PHP etc..) moderated applications
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Create new PM2 process
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| scriptname | string Application script name |
| memory_limit | integer Application max memory usage |
| name | string Application name |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "name": "string"
}Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Get specified PM2 (NodeJS, Python, sh, PHP etc..) moderated application
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Modify and save PM2 process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Delete PM2 process
Authorizations:
path Parameters
| 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. |
Responses
Start PM2 process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Restart PM2 process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Stop PM2 process
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "id": 0,
- "name": "string",
- "status": "string",
- "enabled": true
}
]Add IP address to access list
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| ip | string IP address |
Responses
Response Schema: application/json
| id | integer identificator |
| identificator | integer identificator |
| ip | string IP address |
Request samples
- Payload
{- "ip": "string"
}Response samples
- 200
[- {
- "id": 0,
- "identificator": 0,
- "ip": "string"
}
]Delete IP address from access list
Authorizations:
path Parameters
| 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 |
Responses
Get single port forward
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
]
}
]Save port forward
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}Response samples
- 200
[- {
- "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"
]
}
]Delete port forward
Authorizations:
path Parameters
| 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. |
Responses
Get port forwards
Authorizations:
path Parameters
| service_name required | string Unique name of service |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
]
}
]Add new port forward
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "comment": "string",
- "ip": {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}, - "fport": 0,
- "acl_enabled": true,
- "acls": [
- "string"
]
}Response samples
- 200
[- {
- "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"
]
}
]Get all dedicated ips
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}
]Create dedicated IP
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 201
[- {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}
]Get specific dedicated ip
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "ipv4": "string",
- "ipv6": "string",
- "vhosts": [
- "string"
]
}
]Delete dedicated IP
Authorizations:
path Parameters
| 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. |
Responses
Get webhosting package and billing period configuration
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| package | string package |
| package_name | string Package name |
| billing_period | integer Billing period in months |
| allow_changes | boolean Whether billing changes are allowed for this service |
| turbo_allowed | boolean Whether the package is eligible for Turbo |
Response samples
- 200
[- {
- "package": "string",
- "package_name": "string",
- "billing_period": 0,
- "allow_changes": true,
- "turbo_allowed": true
}
]Change webhosting package or billing period
By upgrading the user agrees to any changes in service fees and terms of services. Already issued invoices will be credited and a new invoice will be issued in accordance with the changed conditions.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| package | string package |
| billing_period | integer Billing period in months |
Responses
Response Schema: application/json
| package | string package |
| package_name | string Package name |
| billing_period | integer Billing period in months |
| allow_changes | boolean Whether billing changes are allowed for this service |
| turbo_allowed | boolean Whether the package is eligible for Turbo |
Request samples
- Payload
{- "package": "string",
- "billing_period": 0
}Response samples
- 201
[- {
- "package": "string",
- "package_name": "string",
- "billing_period": 0,
- "allow_changes": true,
- "turbo_allowed": true
}
]Get available webhosting package or billing period options for this service.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
Array of objects Available packages | |
| period | Array of integers Available billing periods in months |
Response samples
- 200
{- "package": [
- {
- "package": "string",
- "package_name": "string",
- "package_description": "string",
- "package_description_long": "string",
- "price_month": 0,
- "price_year": 0,
- "parameters": {
- "disk_size": null,
- "disk_inodes": null,
- "cron_limit": null,
- "mysql_total_size": null,
- "mailaccount_limit": null,
- "mailbox_size": null,
- "backup_retention_days": null
}
}
], - "period": [
- 0
]
}Display listing of Additional resources that are used by webhosting service
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| package | string Additional resource package tag |
| name | string Additional resource package name |
| quantity | integer Additional resource package quantity |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]Add Additional resources
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| quantity | integer Additional resource package quantity |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| package | string Additional resource package tag |
| name | string Additional resource package name |
| quantity | integer Additional resource package quantity |
Request samples
- Payload
{- "quantity": 0
}Response samples
- 201
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]Display specific Additional resources that is used by webhosting service
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| package | string Additional resource package tag |
| name | string Additional resource package name |
| quantity | integer Additional resource package quantity |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]Edit Additional resource quantity
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| quantity | integer Additional resource package quantity |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| package | string Additional resource package tag |
| name | string Additional resource package name |
| quantity | integer Additional resource package quantity |
Request samples
- Payload
{- "quantity": 0
}Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "package": "string",
- "name": "string",
- "quantity": 0
}
]Delete an Additional resource
Authorizations:
path Parameters
| 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. |
Responses
Show all public keys
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": 0,
- "comment": "string",
- "created": "string",
- "created_human": "string",
- "fingerprint": "string",
- "last_used": "string",
- "type": "string",
- "size": 0,
- "public_key": "string"
}
]Create public key
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| comment | string Comment |
| public_key | string Content |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "comment": "string",
- "public_key": "string"
}Response samples
- 201
[- {
- "resource_url": "string",
- "identificator": 0,
- "comment": "string",
- "created": "string",
- "created_human": "string",
- "fingerprint": "string",
- "last_used": "string",
- "type": "string",
- "size": 0,
- "public_key": "string"
}
]Show single public key
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": 0,
- "comment": "string",
- "created": "string",
- "created_human": "string",
- "fingerprint": "string",
- "last_used": "string",
- "type": "string",
- "size": 0,
- "public_key": "string"
}
]Delete public key
Authorizations:
path Parameters
| 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. |
Responses
Show ssh settings
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": 0,
- "username": "string",
- "webhosts": [
- "string"
], - "server_fingerprints": [
- "string"
], - "access": "whitelist",
- "ipv4": "string",
- "ipv6": "string"
}
]Update ssh settings
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| access | string Enum: "whitelist" "public" Access type |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "access": "whitelist"
}Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": 0,
- "username": "string",
- "webhosts": [
- "string"
], - "server_fingerprints": [
- "string"
], - "access": "whitelist",
- "ipv4": "string",
- "ipv6": "string"
}
]Show whitelisted IP addresses
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": 0,
- "ip": "string",
- "comment": "string"
}
]Add IP to whitelist
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| ip | string IP (IPv4 or IPv6, supports prefix i.e. '217.128.0.0/24' etc) |
| comment | string Comment |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "ip": "string",
- "comment": "string"
}Response samples
- 201
[- {
- "resource_url": "string",
- "identificator": 0,
- "ip": "string",
- "comment": "string"
}
]Show single whitelisted IP address
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "resource_url": "string",
- "identificator": 0,
- "ip": "string",
- "comment": "string"
}
]Delete IP from whitelist
Authorizations:
path Parameters
| 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. |
Responses
Get LE certificate status
Get Let's Encrypt queue status for this (sub)domain
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| status | string Enum: "waiting" "alive" "failed" Status |
object Info about the last failed attempt | |
| last_try | string <date-time> Nullable Last try |
| ignore_hostnames | Array of strings Ignore hostnames |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "status": "waiting",
- "info": {
- "last_failed_hostnames": [
- "string"
]
}, - "last_try": "2019-08-24T14:15:22Z",
- "ignore_hostnames": [
- "string"
]
}
]Request LE certificate re-generation
Regenerate Let's Encrypt certificate for this (sub)domain. Only status is updatable. Setting status to waiting requests certificate regeneration.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Request Body schema: application/json
| status | string Value: "waiting" Status |
Responses
Request samples
- Payload
{- "status": "waiting"
}Response samples
- 202
[- {
- "identificator": "string",
- "resource_url": "string",
- "status": "waiting",
- "info": {
- "last_failed_hostnames": [
- "string"
]
}, - "last_try": "2019-08-24T14:15:22Z",
- "ignore_hostnames": [
- "string"
]
}
]Get ZonePlus applications list
Authorizations:
path Parameters
| service_name required | string Unique name of service |
query Parameters
| roles | string Roles to fetch. Comma separated. Possible values: web, addon, proxy, wp |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| name | string Name |
| type | string Type |
| category | string Category in human readable format (English) |
| category_id | string Category in machine readable format |
| tags | Array of strings Tags |
| roles | Array of strings Roles |
| website | string Website |
| description | string Description |
| featured | boolean Featured |
| features | Array of strings Features |
| icon | string Icon |
| icon_small | string Small icon |
| screenshots | Array of strings Screenshots |
| minimum_price | number <float> Minimum price |
| minimum_price_first_year | string Minimum price in first year |
| trial_period | integer Trial period duration in days |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}
]Get ZonePlus application
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| app_id required | string Application id |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| name | string Name |
| type | string Type |
| category | string Category in human readable format (English) |
| category_id | string Category in machine readable format |
| tags | Array of strings Tags |
| roles | Array of strings Roles |
| website | string Website |
| description | string Description |
| featured | boolean Featured |
| features | Array of strings Features |
| icon | string Icon |
| icon_small | string Small icon |
| screenshots | Array of strings Screenshots |
| minimum_price | number <float> Minimum price |
| minimum_price_first_year | string Minimum price in first year |
| trial_period | integer Trial period duration in days |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}
]Get ZonePlus application options
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| app_id required | string Application id |
Responses
Response Schema: application/json
Array of objects (ZonePlus application version) Supported application versions | |
| location | Array of strings Available hosts for installing |
| location_type | string Location type ('host'/'url') |
| terms_of_service_url | string Terms of service url |
| settings_autoupdates | Array of strings Autoupdate setting presets |
| application_options | object Additional install options |
Response samples
- 200
{- "version": [
- {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}
], - "location": [
- "string"
], - "location_type": "string",
- "terms_of_service_url": "string",
- "settings_autoupdates": [
- "string"
], - "application_options": { }
}Get ZonePlus application version list
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| app_id required | string Application id |
Responses
Response Schema: application/json
| identificator | string identificator |
| name | string Name |
| description | string Description |
| price | string Price |
| price_first_year | string Discount price for first year |
| languages | Array of strings Languages |
| trial_period | integer Trial period duration in days |
Response samples
- 200
[- {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}
]Get ZonePlus application version
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| app_id required | string Application id |
| 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. |
Responses
Response Schema: application/json
| identificator | string identificator |
| name | string Name |
| description | string Description |
| price | string Price |
| price_first_year | string Discount price for first year |
| languages | Array of strings Languages |
| trial_period | integer Trial period duration in days |
Response samples
- 200
[- {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}
]Get ZonePlus install backup list
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| created | string Creation time |
| label | string Descriptive label |
| version | string Backed up application version |
| size_human | string Human readable size on disk |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "created": "string",
- "label": "string",
- "version": "string",
- "size_human": "string"
}
]Create ZonePlus install backup
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Request Body schema: application/json
| label | string Label to describe the snapshot, longer values are trimmed to 100 characters |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| created | string Creation time |
| label | string Descriptive label |
| version | string Backed up application version |
| size_human | string Human readable size on disk |
Request samples
- Payload
{- "label": "string"
}Response samples
- 201
[- {
- "identificator": "string",
- "resource_url": "string",
- "created": "string",
- "label": "string",
- "version": "string",
- "size_human": "string"
}
]Get specific ZonePlus install backup
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
| backup_id required | string ZonePlus install backup id |
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| created | string Creation time |
| label | string Descriptive label |
| version | string Backed up application version |
| size_human | string Human readable size on disk |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "created": "string",
- "label": "string",
- "version": "string",
- "size_human": "string"
}
]Get ZonePlus installs list
Authorizations:
path Parameters
| service_name required | string Unique name of service |
query Parameters
| staging | boolean Filter by staging status |
| url_or_app | string Filter by url or app name |
header Parameters
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
| x-pager-page | integer Page number. Default is 1. |
Responses
Response Schema: application/json
| identificator | integer identificator |
| resource_url | string API url to get this entity |
| location | string Install location |
| login_url | string Login url |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_language | string Language |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| support_snapshots | boolean Snapshots are supported |
| support_versions | boolean Version are supported |
| support_packages | boolean Packages are supported |
| support_clones | boolean Clones are supported |
| support_sync | boolean Sync between staging/procution are supported |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| is_staging | boolean This site is staging site. See: support_sync |
| is_production | boolean This site is produiction site. See: support_sync |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Response samples
- 200
[- {
- "identificator": 0,
- "resource_url": "string",
- "location": "string",
- "login_url": "string",
- "application": {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "support_snapshots": true,
- "support_versions": true,
- "support_packages": true,
- "support_clones": true,
- "support_sync": true,
- "sync_destinations": [
- 0
], - "is_staging": true,
- "is_production": true,
- "access_ips": [
- "string"
], - "email": "string"
}
]Create ZonePlus install
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| application required | string Slug of the application to install (for example 'wordpress') from the application list |
| version required | string Name of the application version to install for the given application |
| location required | string Install location (host name or full url, depending on application) |
| settings_language | string Language. Required for most applications, valid values depend on version |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates. Required for most applications |
| settings_autoupdates_plugins | boolean Autoupdate plugins (only WordPress) |
| settings_autoupdates_themes | boolean Autoupdate themes (only WordPress) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
string Site contact e-mail. Required for most brands | |
| plugins | Array of strings Plugins to install (only WordPress) |
| themes | Array of strings Themes to install (only WordPress) |
| template | string Starter template (only WordPress) |
Responses
Response Schema: application/json
| identificator | integer identificator |
| resource_url | string API url to get this entity |
| location | string Install location |
| login_url | string Login url |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_language | string Language |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| support_snapshots | boolean Snapshots are supported |
| support_versions | boolean Version are supported |
| support_packages | boolean Packages are supported |
| support_clones | boolean Clones are supported |
| support_sync | boolean Sync between staging/procution are supported |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| is_staging | boolean This site is staging site. See: support_sync |
| is_production | boolean This site is produiction site. See: support_sync |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Request samples
- Payload
{- "application": "string",
- "version": "string",
- "location": "string",
- "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "email": "string",
- "plugins": [
- "string"
], - "themes": [
- "string"
], - "template": "string"
}Response samples
- 201
[- {
- "identificator": 0,
- "resource_url": "string",
- "location": "string",
- "login_url": "string",
- "application": {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "support_snapshots": true,
- "support_versions": true,
- "support_packages": true,
- "support_clones": true,
- "support_sync": true,
- "sync_destinations": [
- 0
], - "is_staging": true,
- "is_production": true,
- "access_ips": [
- "string"
], - "email": "string"
}
]Get ZonePlus install
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Responses
Response Schema: application/json
| identificator | integer identificator |
| resource_url | string API url to get this entity |
| location | string Install location |
| login_url | string Login url |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_language | string Language |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| support_snapshots | boolean Snapshots are supported |
| support_versions | boolean Version are supported |
| support_packages | boolean Packages are supported |
| support_clones | boolean Clones are supported |
| support_sync | boolean Sync between staging/procution are supported |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| is_staging | boolean This site is staging site. See: support_sync |
| is_production | boolean This site is produiction site. See: support_sync |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Response samples
- 200
[- {
- "identificator": 0,
- "resource_url": "string",
- "location": "string",
- "login_url": "string",
- "application": {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "support_snapshots": true,
- "support_versions": true,
- "support_packages": true,
- "support_clones": true,
- "support_sync": true,
- "sync_destinations": [
- 0
], - "is_staging": true,
- "is_production": true,
- "access_ips": [
- "string"
], - "email": "string"
}
]Update ZonePlus install
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Request Body schema: application/json
| location | string Install location |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| plugins | Array of strings Plugins to install. Only for Wordpress |
| themes | Array of strings Themes to install. Only for Wordpress |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Responses
Response Schema: application/json
| identificator | integer identificator |
| resource_url | string API url to get this entity |
| location | string Install location |
| login_url | string Login url |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_language | string Language |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| support_snapshots | boolean Snapshots are supported |
| support_versions | boolean Version are supported |
| support_packages | boolean Packages are supported |
| support_clones | boolean Clones are supported |
| support_sync | boolean Sync between staging/procution are supported |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| is_staging | boolean This site is staging site. See: support_sync |
| is_production | boolean This site is produiction site. See: support_sync |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Request samples
- Payload
{- "location": "string",
- "application": {
- "identificator": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "sync_destinations": [
- 0
], - "plugins": [
- "string"
], - "themes": [
- "string"
], - "access_ips": [
- "string"
], - "email": "string"
}Response samples
- 200
[- {
- "identificator": 0,
- "resource_url": "string",
- "location": "string",
- "login_url": "string",
- "application": {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "support_snapshots": true,
- "support_versions": true,
- "support_packages": true,
- "support_clones": true,
- "support_sync": true,
- "sync_destinations": [
- 0
], - "is_staging": true,
- "is_production": true,
- "access_ips": [
- "string"
], - "email": "string"
}
]Copy ZonePlus application
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Request Body schema: application/json
| location required | string Copy location hostname |
| path | string Path under the host where the copy is installed. Installed at the host root when not set or empty. |
| staging | boolean Copy as staging |
Responses
Response Schema: application/json
| webhosting_id | integer Webhosting id of the copied install |
| install_id | integer Id of the copied install |
Request samples
- Payload
{- "location": "string",
- "path": "string",
- "staging": true
}Response samples
- 201
{- "webhosting_id": 0,
- "install_id": 0
}Sync ZonePlus WordPress install between staging and production
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| source_id required | integer Source identificator |
| destination_id required | integer Destination identificator |
query Parameters
| backup | boolean Create backup of destination before sync. |
| files | Array of any Array of files and directories to sync. Empty array syncs nothing; when not set, all files are synced. |
| tables | Array of any Array of database tables to sync. Empty array syncs nothing; when not set, all database tables are synced. |
Responses
Get list of files and database tables to sync
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| source_id required | integer Source identificator |
Responses
Response Schema: application/json
| files | Array of strings List of files which can be synced |
| tables | Array of strings List of databases which can be synced |
Response samples
- 200
{- "files": [
- "string"
], - "tables": [
- "string"
]
}Upgrade ZonePlus application
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Request Body schema: application/json
| version required | string Version to upgrade to from one of the available upgrade versions (see OPTIONS request) |
| plugins | boolean Upgrade plugins (only available for WordPress) |
| themes | boolean Upgrade themes (only available for WordPress) |
Responses
Request samples
- Payload
{- "version": "string",
- "plugins": true,
- "themes": true
}Get ZonePlus application login url
Generate WordPress/Brizy login url
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Responses
Response Schema: application/json
| url | string Login url |
Response samples
- 200
{- "url": "string"
}Get ZonePlus install with available addons
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| install_id required | string ZonePlus install id |
Responses
Response Schema: application/json
| identificator | integer identificator |
| resource_url | string API url to get this entity |
| location | string Install location |
| login_url | string Login url |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_language | string Language |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| support_snapshots | boolean Snapshots are supported |
| support_versions | boolean Version are supported |
| support_packages | boolean Packages are supported |
| support_clones | boolean Clones are supported |
| support_sync | boolean Sync between staging/procution are supported |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| is_staging | boolean This site is staging site. See: support_sync |
| is_production | boolean This site is produiction site. See: support_sync |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Response samples
- 200
[- {
- "identificator": 0,
- "resource_url": "string",
- "location": "string",
- "login_url": "string",
- "application": {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "support_snapshots": true,
- "support_versions": true,
- "support_packages": true,
- "support_clones": true,
- "support_sync": true,
- "sync_destinations": [
- 0
], - "is_staging": true,
- "is_production": true,
- "access_ips": [
- "string"
], - "email": "string"
}
]Import existing WordPress install
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| url required | string URL of the existing WordPress site |
| source_ip | string Valid source IP address |
| source | string Valid source URL |
| ftu | string Valid FTP/SSH url or app:// uri. Required when source is set. |
Responses
Response Schema: application/json
| identificator | integer identificator |
| resource_url | string API url to get this entity |
| location | string Install location |
| login_url | string Login url |
object (Application) | |
object (ZonePlus application version) | |
| available_versions | Array of strings Available versions |
| settings_language | string Language |
| settings_autoupdates | string Enum: "any" "minor" "manual" Auto updates |
| settings_autoupdates_plugins | boolean Autoup plugins (only wordpress & during edit) |
| settings_autoupdates_themes | boolean Autoup themes (only wordpress & during edit) |
| settings_notifications | boolean Enable e-mail notifications for new versions & updates |
| support_snapshots | boolean Snapshots are supported |
| support_versions | boolean Version are supported |
| support_packages | boolean Packages are supported |
| support_clones | boolean Clones are supported |
| support_sync | boolean Sync between staging/procution are supported |
| sync_destinations | Array of integers Possible destinations when sync between production & staging is supproted. See: support_sync |
| is_staging | boolean This site is staging site. See: support_sync |
| is_production | boolean This site is produiction site. See: support_sync |
| access_ips | Array of strings HTTP Access IP's for staging sites. Empty array means public access. See: support_sync |
string |
Request samples
- Payload
{- "url": "string",
- "source_ip": "string",
- "source": "string",
- "ftu": "string"
}Response samples
- 200
[- {
- "identificator": 0,
- "resource_url": "string",
- "location": "string",
- "login_url": "string",
- "application": {
- "identificator": "string",
- "resource_url": "string",
- "name": "string",
- "type": "string",
- "category": "string",
- "category_id": "string",
- "tags": [
- "string"
], - "roles": [
- "string"
], - "website": "string",
- "description": "string",
- "featured": true,
- "features": [
- "string"
], - "icon": "string",
- "icon_small": "string",
- "screenshots": [
- "string"
], - "minimum_price": 0,
- "minimum_price_first_year": "string",
- "trial_period": 0
}, - "version": {
- "identificator": "string",
- "name": "string",
- "description": "string",
- "price": "string",
- "price_first_year": "string",
- "languages": [
- "string"
], - "trial_period": 0
}, - "available_versions": [
- "string"
], - "settings_language": "string",
- "settings_autoupdates": "any",
- "settings_autoupdates_plugins": true,
- "settings_autoupdates_themes": true,
- "settings_notifications": true,
- "support_snapshots": true,
- "support_versions": true,
- "support_packages": true,
- "support_clones": true,
- "support_sync": true,
- "sync_destinations": [
- 0
], - "is_staging": true,
- "is_production": true,
- "access_ips": [
- "string"
], - "email": "string"
}
]Show current user billing info
Authorizations:
Responses
Response Schema: application/json
| identificator | string identificator |
| resource_url | string API url to get this entity |
| balance | number <float> User account balance |
Response samples
- 200
[- {
- "identificator": "string",
- "resource_url": "string",
- "balance": 0
}
]Pay invoices
Pays given invoices from available credits. Already paid invoices, credit notes and invoices without an unpaid sum are skipped silently. No data is returned; use the invoice endpoints to verify payment status.
Authorizations:
Request Body schema: application/json
| method required | string Value: "prepayment" Payment method. Only 'prepayment' (pay from available credits) is supported |
| invoices required | Array of integers Invoice numbers to pay |
Responses
Request samples
- Payload
{- "method": "prepayment",
- "invoices": [
- 0
]
}Response samples
- 205
[- {
- "identificator": 0,
- "invoice_number": 0,
- "type": "string",
- "identificator_public": "string",
- "pay_url": "string",
- "description": "string",
- "created": "string",
- "due": "string",
- "total_sum": "string",
- "total_sum_with_vat": "string",
- "einvoice_active": true,
- "total_paid_sum": "string",
- "total_due_sum": "string",
- "paid": true,
- "payment_processing": "string",
- "einvoice_sent": "string",
- "resource_url": "string",
- "download_url": "string",
- "requires_authentication": true,
- "_links": [
- {
- "domain_order": "string"
}
]
}
]Get all invoices
Returns list of all invoices
Authorizations:
query Parameters
| paid | boolean Filter by payment status |
| search | string Search string for invoice number |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
| x-order-dir | string Enum: "asc" "desc" Order direction |
Responses
Response Schema: application/json
| identificator | integer identificator |
| invoice_number | integer Invoice number |
| type | string Invoice type |
| identificator_public | string Public identificator to show invoice without authentication for some time |
| pay_url | string Payment URL to GUI to pay current invoice |
| description | string Description |
| created | string Created datetime |
| due | string Due datetime |
| total_sum | string Total sum without VAT |
| total_sum_with_vat | string Total sum with VAT |
| einvoice_active | boolean E-invoice should be sent |
| total_paid_sum | string Invoice sum that is actually paid(with VAT) |
| total_due_sum | string Sum that is yet to be paid(with VAT) |
| paid | boolean Invoice is paid |
| payment_processing | string Payment is paid but currently still processing |
| einvoice_sent | string E-invoice delivery time. Null when not yet sent |
| resource_url | string API url to get this entity |
| download_url | string Url to download this invoice in PDF format |
| requires_authentication | boolean If the related order requires authentication |
Array of objects Relations |
Response samples
- 200
[- {
- "identificator": 0,
- "invoice_number": 0,
- "type": "string",
- "identificator_public": "string",
- "pay_url": "string",
- "description": "string",
- "created": "string",
- "due": "string",
- "total_sum": "string",
- "total_sum_with_vat": "string",
- "einvoice_active": true,
- "total_paid_sum": "string",
- "total_due_sum": "string",
- "paid": true,
- "payment_processing": "string",
- "einvoice_sent": "string",
- "resource_url": "string",
- "download_url": "string",
- "requires_authentication": true,
- "_links": [
- {
- "domain_order": "string"
}
]
}
]Get single invoice
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| identificator | integer identificator |
| invoice_number | integer Invoice number |
| type | string Invoice type |
| identificator_public | string Public identificator to show invoice without authentication for some time |
| pay_url | string Payment URL to GUI to pay current invoice |
| description | string Description |
| created | string Created datetime |
| due | string Due datetime |
| total_sum | string Total sum without VAT |
| total_sum_with_vat | string Total sum with VAT |
| einvoice_active | boolean E-invoice should be sent |
| total_paid_sum | string Invoice sum that is actually paid(with VAT) |
| total_due_sum | string Sum that is yet to be paid(with VAT) |
| paid | boolean Invoice is paid |
| payment_processing | string Payment is paid but currently still processing |
| einvoice_sent | string E-invoice delivery time. Null when not yet sent |
| resource_url | string API url to get this entity |
| download_url | string Url to download this invoice in PDF format |
| requires_authentication | boolean If the related order requires authentication |
Array of objects Relations |
Response samples
- 200
[- {
- "identificator": 0,
- "invoice_number": 0,
- "type": "string",
- "identificator_public": "string",
- "pay_url": "string",
- "description": "string",
- "created": "string",
- "due": "string",
- "total_sum": "string",
- "total_sum_with_vat": "string",
- "einvoice_active": true,
- "total_paid_sum": "string",
- "total_due_sum": "string",
- "paid": true,
- "payment_processing": "string",
- "einvoice_sent": "string",
- "resource_url": "string",
- "download_url": "string",
- "requires_authentication": true,
- "_links": [
- {
- "domain_order": "string"
}
]
}
]Get cloudserver orders
Authorizations:
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
}
]Request/order new virtual machine
Authorizations:
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "datacenter": "string",
- "package": "string",
- "os": "string",
- "billing_period": 0,
- "ssh_public_key": "string"
}Response samples
- 201
[- {
- "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"
}
]Get single cloudserver order
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
}
]Get all domains
Returns list of all domains that user owns or is delegated to manage. Possible x-order-by values are expires and name.
Authorizations:
query Parameters
| 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 are expired or expire within 30 days. |
header Parameters
| 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 Enum: "expires" "name" Order by field name |
| x-order-dir | string Enum: "asc" "desc" Order direction |
Responses
Response Schema: application/json
| identificator | string identificator |
| name | string Domain name |
| delegated | string Username of the domain owner if delegated |
| expires | string When does this domain expire |
| expired | boolean Expiration status |
| dnssec | boolean Dnssec |
| dnssec_supported | boolean Whether the domain supports 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 |
| nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Array of objects Relations |
Response samples
- 200
[- {
- "identificator": "string",
- "name": "string",
- "delegated": "string",
- "expires": "string",
- "expired": true,
- "dnssec": true,
- "dnssec_supported": true,
- "autorenew": true,
- "renew_order": "string",
- "renewal_notifications": true,
- "has_pending_trade": null,
- "has_pending_dnssec": true,
- "reactivate": true,
- "auth_key_enabled": true,
- "nameservers_custom": true,
- "_links": [
- {
- "nameserver": "string",
- "contact": "string",
- "webhosting": null
}
]
}
]Get domain
Returns a single domain that user owns or is delegated to manage
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| identificator | string identificator |
| name | string Domain name |
| delegated | string Username of the domain owner if delegated |
| expires | string When does this domain expire |
| expired | boolean Expiration status |
| dnssec | boolean Dnssec |
| dnssec_supported | boolean Whether the domain supports 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 |
| nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Array of objects Relations |
Response samples
- 200
[- {
- "identificator": "string",
- "name": "string",
- "delegated": "string",
- "expires": "string",
- "expired": true,
- "dnssec": true,
- "dnssec_supported": true,
- "autorenew": true,
- "renew_order": "string",
- "renewal_notifications": true,
- "has_pending_trade": null,
- "has_pending_dnssec": true,
- "reactivate": true,
- "auth_key_enabled": true,
- "nameservers_custom": true,
- "_links": [
- {
- "nameserver": "string",
- "contact": "string",
- "webhosting": null
}
]
}
]Update domain
Updates the domain. Only nameservers_custom and renewal_notifications can be changed.
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| renewal_notifications | boolean Are renewal reminders turned on |
| nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Responses
Response Schema: application/json
| identificator | string identificator |
| name | string Domain name |
| delegated | string Username of the domain owner if delegated |
| expires | string When does this domain expire |
| expired | boolean Expiration status |
| dnssec | boolean Dnssec |
| dnssec_supported | boolean Whether the domain supports 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 |
| nameservers_custom | boolean If domain uses custom nameservers, only false allowed |
Array of objects Relations |
Request samples
- Payload
{- "renewal_notifications": true,
- "nameservers_custom": true
}Response samples
- 200
[- {
- "identificator": "string",
- "name": "string",
- "delegated": "string",
- "expires": "string",
- "expired": true,
- "dnssec": true,
- "dnssec_supported": true,
- "autorenew": true,
- "renew_order": "string",
- "renewal_notifications": true,
- "has_pending_trade": null,
- "has_pending_dnssec": true,
- "reactivate": true,
- "auth_key_enabled": true,
- "nameservers_custom": true,
- "_links": [
- {
- "nameserver": "string",
- "contact": "string",
- "webhosting": null
}
]
}
]Get domain options
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
object | |
object | |
object |
Response samples
- 200
{- "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
}
}
}Get all domain's preferences
Returns all domain preferences
Authorizations:
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| renewal_notifications | boolean Are renewal reminders turned on |
Response samples
- 200
[- {
- "resource_url": "string",
- "renewal_notifications": true
}
]Update domain preferences
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| renewal_notifications | boolean Are renewal reminders turned on |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| renewal_notifications | boolean Are renewal reminders turned on |
Request samples
- Payload
{- "renewal_notifications": true
}Response samples
- 200
[- {
- "resource_url": "string",
- "renewal_notifications": true
}
]Get all domain nameservers
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| hostname | string Hostname |
| ip | Array of strings IP address |
Response samples
- 200
[- {
- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
]Create domain nameservers
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Request Body schema: application/json
| hostname | string Hostname |
| ip | Array of strings IP address |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| hostname | string Hostname |
| ip | Array of strings IP address |
Request samples
- Payload
[- {
- "hostname": "string",
- "ip": [
- "string"
]
}
]Response samples
- 201
[- {
- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
]Get single domain nameserver
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| hostname | string Hostname |
| ip | Array of strings IP address |
Response samples
- 200
[- {
- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}
]Update domain nameserver
Authorizations:
path Parameters
| service_name required | string Unique name of service |
| hostname required | string Hostname (main or subdomain) |
Request Body schema: application/json
| hostname | string Hostname |
| ip | Array of strings IP address |
Responses
Response Schema: application/json
| resource_url | string API url to get this entity |
| hostname | string Hostname |
| ip | Array of strings IP address |
Request samples
- Payload
{- "hostname": "string",
- "ip": [
- "string"
]
}Response samples
- 200
{- "resource_url": "string",
- "hostname": "string",
- "ip": [
- "string"
]
}Get domain orders
Authorizations:
query Parameters
| in_progress | boolean Filter only unfinished. |
header Parameters
| x-pager-page | integer Page number. Default is 1. |
| x-pager-limit | integer Items per page. Default is 10. Maximum is 100. |
Responses
Response Schema: application/json
| identificator | integer identificator |
| datetime_ordered | string <ISO 8601 date> Date and time the order was created on |
| invoice_hash | string Nullable Invoice public hash, |
| invoice_number | string Nullable Invoice number, |
| paid | boolean Order payment status |
| status | string Enum: "none" "started" "finished" "cancelled" Order processing status |
| errors | integer Nullable Number of failed rows, |
| authorization_required | boolean Whether order processing requires authorization |
| authorization_hash | string Nullable Authorization hash, |
| authorized | boolean Authorization status, always true when authorization is not required |
| authenticated | boolean Authentication status, always true when authorization is not required |
Array of objects (OrderRow) Order rows | |
| vat_rate | string VAT rate |
| total_price | number Total price without tax |
| total_price_with_tax | number Total price with tax |
Array of objects Relations |
Response samples
- 200
[- {
- "identificator": 0,
- "datetime_ordered": "string",
- "invoice_hash": "string",
- "invoice_number": "string",
- "paid": true,
- "status": "none",
- "errors": 0,
- "authorization_required": true,
- "authorization_hash": "string",
- "authorized": true,
- "authenticated": true,
- "rows": [
- {
- "identificator": 0,
- "domain": "string",
- "period": 0,
- "type": "create",
- "status": "none",
- "error": "string",
- "error_params": {
- "property1": "string",
- "property2": "string"
}, - "row_price": 0,
- "total_price": 0,
- "total_price_with_tax": 0
}
], - "vat_rate": "string",
- "total_price": 0,
- "total_price_with_tax": 0,
- "_links": [
- {
- "invoice": "string"
}
]
}
]Get domain order by identificator
Authorizations:
path Parameters
| 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. |
query Parameters
| in_progress | boolean Filter only unfinished. |
Responses
Response Schema: application/json
| identificator | integer identificator |
| datetime_ordered | string <ISO 8601 date> Date and time the order was created on |
| invoice_hash | string Nullable Invoice public hash, |
| invoice_number | string Nullable Invoice number, |
| paid | boolean Order payment status |
| status | string Enum: "none" "started" "finished" "cancelled" Order processing status |
| errors | integer Nullable Number of failed rows, |
| authorization_required | boolean Whether order processing requires authorization |
| authorization_hash | string Nullable Authorization hash, |
| authorized | boolean Authorization status, always true when authorization is not required |
| authenticated | boolean Authentication status, always true when authorization is not required |
Array of objects (OrderRow) Order rows | |
| vat_rate | string VAT rate |
| total_price | number Total price without tax |
| total_price_with_tax | number Total price with tax |
Array of objects Relations |
Response samples
- 200
[- {
- "identificator": 0,
- "datetime_ordered": "string",
- "invoice_hash": "string",
- "invoice_number": "string",
- "paid": true,
- "status": "none",
- "errors": 0,
- "authorization_required": true,
- "authorization_hash": "string",
- "authorized": true,
- "authenticated": true,
- "rows": [
- {
- "identificator": 0,
- "domain": "string",
- "period": 0,
- "type": "create",
- "status": "none",
- "error": "string",
- "error_params": {
- "property1": "string",
- "property2": "string"
}, - "row_price": 0,
- "total_price": 0,
- "total_price_with_tax": 0
}
], - "vat_rate": "string",
- "total_price": 0,
- "total_price_with_tax": 0,
- "_links": [
- {
- "invoice": "string"
}
]
}
]Cancel domain order
Authorizations:
path Parameters
| 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. |
Responses
Renew or reactivate a domain
Authorizations:
Request Body schema: application/json
| domain | string Domain name |
| period | integer Renew/reactivate period from Domain Options request |
Responses
Response Schema: application/json
| identificator | integer identificator |
| datetime_ordered | string <ISO 8601 date> Date and time the order was created on |
| invoice_hash | string Nullable Invoice public hash, |
| invoice_number | string Nullable Invoice number, |
| paid | boolean Order payment status |
| status | string Enum: "none" "started" "finished" "cancelled" Order processing status |
| errors | integer Nullable Number of failed rows, |
| authorization_required | boolean Whether order processing requires authorization |
| authorization_hash | string Nullable Authorization hash, |
| authorized | boolean Authorization status, always true when authorization is not required |
| authenticated | boolean Authentication status, always true when authorization is not required |
Array of objects (OrderRow) Order rows | |
| vat_rate | string VAT rate |
| total_price | number Total price without tax |
| total_price_with_tax | number Total price with tax |
Array of objects Relations |
Request samples
- Payload
[- {
- "domain": "string",
- "period": 0
}
]Response samples
- 201
[- {
- "identificator": 0,
- "datetime_ordered": "string",
- "invoice_hash": "string",
- "invoice_number": "string",
- "paid": true,
- "status": "none",
- "errors": 0,
- "authorization_required": true,
- "authorization_hash": "string",
- "authorized": true,
- "authenticated": true,
- "rows": [
- {
- "identificator": 0,
- "domain": "string",
- "period": 0,
- "type": "create",
- "status": "none",
- "error": "string",
- "error_params": {
- "property1": "string",
- "property2": "string"
}, - "row_price": 0,
- "total_price": 0,
- "total_price_with_tax": 0
}
], - "vat_rate": "string",
- "total_price": 0,
- "total_price_with_tax": 0,
- "_links": [
- {
- "invoice": "string"
}
]
}
]Get all domain contacts
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
}
]Create domain contact
NB! fillable and required fields depend on TLD and on data sent (eg. person/company)
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "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"
}Response samples
- 201
[- {
- "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"
}
]Get single domain contact
Authorizations:
path Parameters
| 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. |
Responses
Response Schema: application/json
| 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 |
Response samples
- 200
[- {
- "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"
}
]Update domain contact
NB! fillable and required fields depend on TLD and on data sent (eg. person/company)
Authorizations:
path Parameters
| 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. |
Request Body schema: application/json
| 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 |
Responses
Response Schema: application/json
| 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 |
Request samples
- Payload
{- "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"
}Response samples
- 200
[- {
- "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"
}
]Delete domain contact
Authorizations:
path Parameters
| 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. |
Responses
Add default tech contact
Authorizations:
path Parameters
| service_name required | string Unique name of service |
Responses
Response Schema: application/json
| 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 |
Response samples
- 201
[- {
- "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"
}
]