Data Types
This section defines common data structures returned by the API.
Service
Represents a generic service within the Xenyth Cloud.
| Field | Type | Description |
|---|---|---|
id | integer | The unique numeric ID of the service. |
name | string | A user-friendly name for the service. |
type | string | The service type. |
service_type | string? | Optional, the subtype of a service. |
price | number | An number containing pricing information. |
recurrence | string | The granularity of the price (rounded up to the next..). Can be one of hr, mn or yr |
payment_period_len | number | How many of the payment_period_type per renewal. Typically 1 |
payment_period_type | string | How often this service is renewed. Can be one of mn or yr |
details | object | An object containing service-specific details. |
status | string | The current status of the service. Can be one of active, suspended, nonrenewal, or terminated. |
created_on | epoch | Timestamp of when this service was created |
changed_on | epoch | Timestamp of when this service was modified |
renewed_date | epoch | Timestamp of when this service was last renewed |
terminated_on | epoch | Timestamp of when this service was terminated |
addons | array? | Present only on GET. List of addon services for this one. |
page | object? | Present only on GET. Relevant page data under page format. |
Service Page (page)
Service page data
| Field | Type | Description |
|---|---|---|
graphs | boolean | Does this service have stats? |
facts | dictionary | Dictionary of "facts" by display name |
actions | array | Array of dashboard actions available (Such as start, vnc, reboot) |
settings->panels | array | Array of dashboard settings panels available |
Service Page Fact (page->facts)
Service page data facts
| Field | Type | Description |
|---|---|---|
value | string | The content of the fact |
copyable | boolean? | Show the copy button for this fact |
hidden | boolean? | This fact is sensitive, hide it and allow toggle |
Service Types (stype)
The stype parameter is used to specify the type of service in API endpoints.
| Category | stype | Provider/Sub-type | Description |
|---|---|---|---|
| Cloud | cloud | ostkkvm | KVM-based cloud servers. |
ostksnapshot | Snapshots for cloud servers. | ||
ostkblockstorage | Block storage for cloud servers. | ||
cephs3 | S3-compatible object storage. | ||
fmnbaremetal | Bare metal servers. | ||
| SSH Key | sshkey | sshkey | Manages SSH keys for server access. |
| DNS | dns | dns | Manages DNS zones and records. |
| Other | other | iptransit | Manages IP transit services. |
iprange | Manages IP address ranges. | ||
colocation | Manages server colocation services. |