General
OpenAPI documentation for the i3D.net API.
The Id of the cross connect
The Id of the uplink
Start unix timestamp
End unix timestamp
OK
Unit of data frequency, possible interval options are as follows
- day
Invalid credentials
unprocessable entity
Internal Server Error
Start unix timestamp
End unix timestamp
OK
Unit of data frequency (hour by default)
Error Colocation not found
Internal Server Error
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Unit of data frequency, which is always null in this endpoint. This property is there
for consistency across all telemetry endpoints. It's null because the data is not aggregated
Bad Request
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the colocation service
The name of the colocation service
Current month kilo watts per hour
Bad Request
Invalid credentials
Internal Server Error
Use GET /v3/telemetry/pdu/{pduId} instead
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
Example header and default range: RANGED-DATA:start=0,results=25
OK
The time at which the last update occurred
The value of amps at that time
The value of volts at that time
The value of kwh at that time
The value of power meter at that time
Bad Request
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the colocation
The name of the colocation
Allowed bandwidth of the host
Used bandwidth of the host
Invalid credentials
Internal Server Error
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
OK
Unit of data frequency, which is always null in this endpoint. This property is there
for consistency across all telemetry endpoints. It's null because the data is not aggregated
Bad Request
Invalid credentials
Internal Server Error
OK
Your user ID
Your user name
First name
Last name
User gender
Phone number
0: Guest, 10: Regular logged in user, 20: Game Hosting management access
Whether or not user email is validated
Whether or not user is trial account
The expiration date of the trial account
Request IP address
The GeoLocation country (ISO 3166) of the request IP address
The GeoLocation country code (ISO 3166 Alpha-2) of the request IP address
If you are not logged in
Internal Server Error
User name
Password
Remember me
OK
Indicates whether a 2FA One-Time Password token is required to complete the login.
Unix timestamp indicating when the window for 2FA authentication closes, 0 if not applicable.
If 2FA is active on your account, you must supply the one-time-password before this unix timestamp expires.
Invalid credentials
Already logged in
Too many login requests performed
Internal Server Error
Provide 2FA One-Time Password after a successful login (if requiresOtp is true in SessionAuthReq, as returned by /session/login)
6 digit One-Time Password
No Content
Invalid OTP
Unexpected OTP call
Internal Server Error
No content
VAT percentage
OK
No content
Invalid credentials
Internal Server Error
No content
ID of a reseller type
Name of a reseller type
ID of the category
ID of a category
OK
No content
Invalid credentials
Invalid categoryName
Internal Server Error
No content
Category name, one of /calc/categories
OK
ApplicationInstanceConfiguration ID
ApplicationInstanceConfiguration tag
Location ID, as provided by /locations
ApplicationInstanceConfiguration price in cents
ApplicationInstanceConfiguration setup price in cents
ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;
TB price for dedicated servers, in cents
TB price for colocation, in cents
Whether this configuration is adjustable
Whether items in this configuration can be downgraded
Whether this configuration can be setup instantly and automatically (low wait time)
Invalid credentials
If an unknown category has been provided
Internal Server Error
Category name, one of /calc/categories
OK
ApplicationInstanceConfiguration group ID
ApplicationInstanceConfiguration group name
ApplicationInstanceConfiguration group code
ApplicationInstanceConfiguration group type (a human readable unique identifier)
Whether items in this configuration group are adjustable
ApplicationInstanceConfiguration group divider (for visual differentiation between related groups)
FLAG_HASQUANTITY 1 FLAG_HASPRICE 2 FLAG_ALLOW_EMPTY_SELECTION 4 FLAG_INCLUDE_ON_INVOICE_IF_EMPTY 8 FLAG_NOTE_ACTIVE 16 FLAG_APPLY_PERIOD_DISCOUNT 32 FLAG_EXCLUDE_FROM_UPGRADES 64
Whether items in this configuration group can be downgraded
ApplicationInstanceConfiguration group display order
If > 0, this group will only relevant / shown if the dependency group and/or item is selected.
If dependencyGroupId > 0, this group will only relevant / shown if (one of) these dependencyItemIds are selected.
Optional notes for a group, for displaying purposes.
Default item in a group
Invalid credentials
If an unknown category has been provided
Internal Server Error
OK
Category IDs
Location ID
Name of the country of this location
Name of the country of this location
Region ID
Name of the region this location is situated in (regions are smaller than continents, but may be a whole continent).
Name of the continent of this location
Name of the city of this location
Dedicated server bandwidth price per TB for this location, in cents
Dedicated server bandwidth overuse price per TB for this location, in cents
Colocation bandwidth price per TB for this location, in cents
Colocation bandwidth overuse price per TB for this location, in cents
Invalid credentials
Internal Server Error
OK
Order ID
True if an order has been added to the cart.
Whether this order is instantly deliverable (normally speaking)
Invalid credentials
Internal Server Error
Configuration tag to create an order from.
Coupon tag to apply to the order.
Whether you want to immediately make the order available for checkout.
OK
Order ID
Whether the order has been added to your cart.
Order creation unix timestamp
Order last modification unix timestamp
Order quantity multiplier
Order title
Order shop category ID
Order shop category name
The tag of the configuration this order is based upon.
The name of the configuration this order is based upon.
ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;
Whether this configuration can be setup instantly and automatically (low wait time)
Order price in cents
Order setup price in cents
Order VAT in cents
Order VAT percentage
Invalid credentials
Unprocessable Entity
Internal Server Error
Customer's user ID
Customer's first name
Customer's last name
Customer's company name (optional)
Customer's email address
Customer's phone number
Remarks contain specific question(s) regarding the quote
OK
No content
Invalid credentials
If your cart is completely empty
If you have an error in the submitted values
Internal Server Error
No content
Order ID
OK
Order ID
Whether the order has been added to your cart.
Order creation unix timestamp
Order last modification unix timestamp
Order quantity multiplier
Order title
Order shop category ID
Order shop category name
The tag of the configuration this order is based upon.
The name of the configuration this order is based upon.
ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;
Whether this configuration can be setup instantly and automatically (low wait time)
Order price in cents
Order setup price in cents
Order VAT in cents
Order VAT percentage
Invalid credentials
If the order was not found
Internal Server Error
Order ID
Order quantity
OK
Order ID
Whether the order has been added to your cart.
Order creation unix timestamp
Order last modification unix timestamp
Order quantity multiplier
Order title
Order shop category ID
Order shop category name
The tag of the configuration this order is based upon.
The name of the configuration this order is based upon.
ApplicationInstanceConfiguration flags IMMUTABLE 1; INSTANT_CONFIG 2; ALLOW_DOWNGRADE 4; IS_DEAL 8; ON_DEAL_PAGE 16; COLO_NO_CONN 32; PRIVATE_CONFIG 64;
Whether this configuration can be setup instantly and automatically (low wait time)
Order price in cents
Order setup price in cents
Order VAT in cents
Order VAT percentage
Invalid credentials
If the order was not found
If you have an error in the submitted order values
Internal Server Error
Set an order in the cart to "checkout" (which means it will show up on the checkout page). Updating the order is still allowed after finalization
Order ID
No Content
Invalid credentials
If the order was not found
Internal Server Error
No content
OK
ID of the job
Title in url format
Job title
Image to display as the header for the job details page
Image to use on the over view page for this job
Job introductory text
Job description text
Unix timestamp of the (final) intake date
Internal Server Error
The Id of the jobs you are requesting
OK
ID of the job
Title in url format
Job title
Image to display as the header for the job details page
Image to use on the over view page for this job
Job introductory text
Job description text
Unix timestamp of the (final) intake date
Invalid jobId
Internal Server Error
The Id of the jobs you are soliciting for
The Id of the solicitation you are uploading files for
OK
No content
Bad Request
Invalid credentials
Invalid jobId or solicitId
Request Entity Too Large
Internal Server Error
No content
OK
The ip address for which you wish to fetch the data
The ip address for which you wish to fetch the data
The xForwardFor for which you wish to fetch the data
The xForwardHost for which you wish to fetch the data
The user agent for which you wish to fetch the data
Invalid credentials
Internal Server Error
Sign up for the newsletter. This will send a confirmation email with a validation url to follow.
Customer's email address
Customer's preferred language
No Content
Unprocessable Entity
No content
A hash, as provided in the newsletter unsubscribe url
A key, as provided in the newsletter unsubscribe url
No Content
Unprocessable Entity
No content
Customer's first name
Customer's last name
Customer's company name (optional)
Customer's email address
Customer's phone number
Rack space volume of interest
Location of interest
Quote remarks (the actual question and additional details)
No Content
Invalid credentials
Unprocessable Entity
Internal Server Error
No content
Example header and default range: RANGED-DATA:start=0,results=25
OK
Ticket ID
Ticket hash
Ticket read hash
Ticket title
Ticket category name
Ticket priority name
Ticket creation unix timestamp
Ticket last update unix timestamp
Time at which the client last replied to the ticket
Time at which the client last read the ticket
Ticket status
Number of replies in ticket
Invalid credentials
Internal Server Error
Ticket title
Ticket content
Ticket category name, must be one of GET /v3/tickets/categories
Ticket department name
Ticket's "Carbon Copy" email addresses in CSV format
Ticket's destination email addresses in CSV format
The IDs of attachments that have been uploaded through POST /v3/tickets/attachment
OK
Ticket ID
Ticket hash
Ticket read hash
Ticket title
Ticket category name
Ticket priority name
Ticket creation unix timestamp
Ticket last update unix timestamp
Time at which the client last replied to the ticket
Time at which the client last read the ticket
Ticket status
Number of replies in ticket
Invalid credentials
Unprocessable Entity
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Ticket ID
Ticket hash
Ticket read hash
Ticket title
Ticket category name
Ticket priority name
Ticket creation unix timestamp
Ticket last update unix timestamp
Time at which the client last replied to the ticket
Time at which the client last read the ticket
Ticket status
Number of replies in ticket
Invalid credentials
Internal Server Error
Ticket ID
OK
Ticket ID
Ticket hash
Ticket read hash
Ticket title
Ticket category name
Ticket priority name
Ticket creation unix timestamp
Ticket last update unix timestamp
Time at which the client last replied to the ticket
Time at which the client last read the ticket
Ticket status
Number of replies in ticket
Invalid credentials
Not Found
Internal Server Error
Ticket ID
Attachment ID
OK
Invalid credentials
Not Found
Internal Server Error
Contact first name
Contact last name
Customer's company name (optional)
Contact email address
Contact phone number
Ticket title
Ticket content
Ticket category name, must be one of GET /v3/tickets/categories
OK
Ticket ID
Ticket hash
Ticket read hash
Ticket title
Ticket category name
Ticket priority name
Ticket creation unix timestamp
Ticket last update unix timestamp
Time at which the client last replied to the ticket
Time at which the client last read the ticket
Ticket status
Number of replies in ticket
Invalid credentials
Unprocessable Entity
Internal Server Error
Ticket ID
Reply title
Reply content
The IDs of attachments that have been uploaded through POST /v3/tickets/attachment
OK
Ticket ID
Ticket hash
Ticket read hash
Ticket title
Ticket category name
Ticket priority name
Ticket creation unix timestamp
Ticket last update unix timestamp
Time at which the client last replied to the ticket
Time at which the client last read the ticket
Ticket status
Number of replies in ticket
Bad Request
Invalid credentials
Unprocessable Entity
Internal Server Error
The attachment that is uploaded through your multipart/form-data request.
OK
The ID of the attachment that was uploaded through your multipart/form-data request.
Bad Request
Invalid credentials
Unprocessable Entity
Internal Server Error
Attachment ID
No Content
Invalid credentials
When the attachment was not found
Unprocessable Entity
Internal Server Error
No content
Label expressions can be used to apply more specific search parameters and can be written in standard SQL query language.
E.g. region_id=123 or multiple filters: region_id=123 and fleet_id=456 or host_id=46256 The provided filter query needs to be url encoded. E.g.
region_id%3D123 or multiple filters: region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256 The total would look like:
/dedicatedServer?labels=region_id%3D123%20and%20fleet_id%3D456%20or%20host_id%3D46256
If you want to filter on a non-numeric label such as region_name, you have to wrap the value in double quotes: region_name="Rotterdam"
Warning: the labels query parameter is ignored when passing a PAGE-TOKEN and the original labels string will be used for that request instead.
For more information about labels check details
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of this host
The ID of the user who owns this server
The ID of the physical machine
The name of the physical machine
The type of the server:
- 1: Bare metal server
- 2: Flex metal server
- 3: Virtual machine
The name of the project for the host
The name of the server defined by client
Client statement for the host
The host name
0 if this is a bare metal server, 1 if it's a VM. Use serverType instead
Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state
Operating system ID, must be one of GET /v3/operatingsystem
Legacy location ID (not used for ODP)
Datacenter location ID. Points to one of GET /v3/cloud/dcLocation
The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of
GET /v3/cloud/instanceType for a virtual machine
The fleet ID, if this host has been assigned to a fleet
If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.
The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve
Unix timestamp when fleet assigned to the host
The name of the rack the host is located
The date at which this host became active
The date at which this host will expire
The date at which this host was cancelled
The date at which the contract ends (if applicable)
The contract period in months
The service extend period in months
The cancellation period in months
Purchase order, if one has been supplied via our billing department
The payment term in days (how many days are invoices generated before dateEnd)
The price of this host per month in cents (see currencyId for currency)
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency of the pricePerMonth field:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The server manufacturer brand name
The model of the server
Number of CPUs in this host
Percentage of cpu used across all cores
The amount of memory that is used by the host (in megabytes)
The amount of memory that is available on the host (in megabytes)
The amount of free memory that is available on the host (in megabytes)
If the host is reserved for a fleet isReserve set to 1
The service tag of the host
If the host is available for game hosting platform isODP set to 1
ID of Flex Metal order if this is a flex metal server
Status of server auto install if it was started by one. (created / installing / finished / failed)
Whether the host is running or not
The uptime of the host. Read-only. Only provided if the server checked-in recently
Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration
Whether the host has free incoming traffic or not
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Invalid credentials
Internal Server Error
Fields return in response, only fields available in model can be filter out
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of this host
The ID of the physical machine
The name of the physical machine
The type of the server:
- 1: Bare metal server
- 2: Flex metal server
- 3: Virtual machine
The name of the project for the host
The name of the server defined by client
Client statement for the host
The host name
0 if this is a bare metal server, 1 if it's a VM. Use serverType instead
Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state
Operating system ID, must be one of GET /v3/operatingsystem
Legacy location ID (not used for ODP)
Datacenter location ID. Points to one of GET /v3/cloud/dcLocation
The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of
GET /v3/cloud/instanceType for a virtual machine
The fleet ID, if this host has been assigned to a fleet
If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.
The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve
Unix timestamp when fleet assigned to the host
The name of the rack the host is located
The date at which this host became active
The date at which this host will expire
The date at which this host was cancelled
The date at which the contract ends (if applicable)
The contract period in months
The service extend period in months
The cancellation period in months
Purchase order, if one has been supplied via our billing department
The payment term in days (how many days are invoices generated before dateEnd)
The price of this host per month in cents (see currencyId for currency)
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency of the pricePerMonth field:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The server manufacturer brand name
The model of the server
If the host is reserved for a fleet isReserve set to 1
The service tag of the host
If the host is available for game hosting platform isODP set to 1
ID of Flex Metal order if this is a flex metal server
Status of server auto install if it was started by one. (created / installing / finished / failed)
Whether the host is running or not
The uptime of the host. Read-only. Only provided if the server checked-in recently
Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration
Whether the host has free incoming traffic or not
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Invalid credentials
Internal Server Error
OK
The ID of this host
The ID of the user who owns this server
The ID of the physical machine
The name of the physical machine
The type of the server:
- 1: Bare metal server
- 2: Flex metal server
- 3: Virtual machine
The name of the project for the host
The name of the server defined by client
Client statement for the host
The host name
0 if this is a bare metal server, 1 if it's a VM. Use serverType instead
Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state
Operating system ID, must be one of GET /v3/operatingsystem
Legacy location ID (not used for ODP)
Datacenter location ID. Points to one of GET /v3/cloud/dcLocation
The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of
GET /v3/cloud/instanceType for a virtual machine
The fleet ID, if this host has been assigned to a fleet
If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.
The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve
Unix timestamp when fleet assigned to the host
The name of the rack the host is located
The date at which this host became active
The date at which this host will expire
The date at which this host was cancelled
The date at which the contract ends (if applicable)
The contract period in months
The service extend period in months
The cancellation period in months
Purchase order, if one has been supplied via our billing department
The payment term in days (how many days are invoices generated before dateEnd)
The price of this host per month in cents (see currencyId for currency)
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency of the pricePerMonth field:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The server manufacturer brand name
The model of the server
Number of CPUs in this host
Percentage of cpu used across all cores
The amount of memory that is used by the host (in megabytes)
The amount of memory that is available on the host (in megabytes)
The amount of free memory that is available on the host (in megabytes)
If the host is reserved for a fleet isReserve set to 1
The service tag of the host
If the host is available for game hosting platform isODP set to 1
ID of Flex Metal order if this is a flex metal server
Status of server auto install if it was started by one. (created / installing / finished / failed)
Whether the host is running or not
The uptime of the host. Read-only. Only provided if the server checked-in recently
Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration
Whether the host has free incoming traffic or not
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Invalid credentials
Internal Server Error
Can add, edit or delete dedicated server labels. To delete label need to provide key with null value.
The ID of this host
The ID of the user who owns this server
The ID of the physical machine
The name of the physical machine
The type of the server:
- 1: Bare metal server
- 2: Flex metal server
- 3: Virtual machine
The name of the project for the host
The name of the server defined by client
Client statement for the host
The host name
0 if this is a bare metal server, 1 if it's a VM. Use serverType instead
Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state
Operating system ID, must be one of GET /v3/operatingsystem
Legacy location ID (not used for ODP)
Datacenter location ID. Points to one of GET /v3/cloud/dcLocation
The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of
GET /v3/cloud/instanceType for a virtual machine
The fleet ID, if this host has been assigned to a fleet
If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.
The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve
Unix timestamp when fleet assigned to the host
The name of the rack the host is located
The date at which this host became active
The date at which this host will expire
The date at which this host was cancelled
The date at which the contract ends (if applicable)
The contract period in months
The service extend period in months
The cancellation period in months
Purchase order, if one has been supplied via our billing department
The payment term in days (how many days are invoices generated before dateEnd)
The price of this host per month in cents (see currencyId for currency)
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency of the pricePerMonth field:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The server manufacturer brand name
The model of the server
Number of CPUs in this host
Percentage of cpu used across all cores
The amount of memory that is used by the host (in megabytes)
The amount of memory that is available on the host (in megabytes)
The amount of free memory that is available on the host (in megabytes)
If the host is reserved for a fleet isReserve set to 1
The service tag of the host
If the host is available for game hosting platform isODP set to 1
ID of Flex Metal order if this is a flex metal server
Status of server auto install if it was started by one. (created / installing / finished / failed)
Whether the host is running or not
The uptime of the host. Read-only. Only provided if the server checked-in recently
Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration
Whether the host has free incoming traffic or not
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
OK
The ID of this host
The ID of the user who owns this server
The ID of the physical machine
The name of the physical machine
The type of the server:
- 1: Bare metal server
- 2: Flex metal server
- 3: Virtual machine
The name of the project for the host
The name of the server defined by client
Client statement for the host
The host name
0 if this is a bare metal server, 1 if it's a VM. Use serverType instead
Host category. Normally "Dedicated Game Servers" or "Dedicated Servers", but can be "Broken" if the server is in a degraded state
Operating system ID, must be one of GET /v3/operatingsystem
Legacy location ID (not used for ODP)
Datacenter location ID. Points to one of GET /v3/cloud/dcLocation
The instance type of this server, which is one of GET /v3/host/instanceType for a bare metal, or one of
GET /v3/cloud/instanceType for a virtual machine
The fleet ID, if this host has been assigned to a fleet
If 0, the host has not been assigned to a fleet, otherwise, the fleet is assigned to this host and the host can serve application instances for that fleet.
The ID of a new fleet that is to be assigned to this host after performing a bulkReserve operation at POST /v3/fleet/host/bulkReserve
Unix timestamp when fleet assigned to the host
The name of the rack the host is located
The date at which this host became active
The date at which this host will expire
The date at which this host was cancelled
The date at which the contract ends (if applicable)
The contract period in months
The service extend period in months
The cancellation period in months
Purchase order, if one has been supplied via our billing department
The payment term in days (how many days are invoices generated before dateEnd)
The price of this host per month in cents (see currencyId for currency)
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency of the pricePerMonth field:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The server manufacturer brand name
The model of the server
Number of CPUs in this host
Percentage of cpu used across all cores
The amount of memory that is used by the host (in megabytes)
The amount of memory that is available on the host (in megabytes)
The amount of free memory that is available on the host (in megabytes)
If the host is reserved for a fleet isReserve set to 1
The service tag of the host
If the host is available for game hosting platform isODP set to 1
ID of Flex Metal order if this is a flex metal server
Status of server auto install if it was started by one. (created / installing / finished / failed)
Whether the host is running or not
The uptime of the host. Read-only. Only provided if the server checked-in recently
Monthly traffic of all incoming and outgoing bandwidth in GB or Mbit depending on host configuration
Whether the host has free incoming traffic or not
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Invalid credentials
Not Found
Unprocessable Entity
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the colocation service
The name of the colocation service
Contract start date
The date until which the service is paid
Contract cancel date if contract is cancelled
Contract end date
The duration of the contract in months
The extended period of the contract in months
The cancellation period in months
The order-name to which the server belongs
The duration in which the invoice has to be paid after receiving.
The price of this colocated server per month in cents
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency in which the various 'price' fields are:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The total used traffic (Mbit or GB, incoming + outgoing)
The total used traffic (Mbit) for 95th percentile
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Contractual maximum usable amperage
The power price per kWh in cents
The current power meter(kWh)
Does the service have free incoming traffic?
Bad Request
Invalid credentials
Internal Server Error
OK
The ID of the colocation service
The name of the colocation service
Contract start date
The date until which the service is paid
Contract cancel date if contract is cancelled
Contract end date
The duration of the contract in months
The extended period of the contract in months
The cancellation period in months
The order-name to which the server belongs
The duration in which the invoice has to be paid after receiving.
The price of this colocated server per month in cents
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency in which the various 'price' fields are:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The total used traffic (Mbit or GB, incoming + outgoing)
The total used traffic (Mbit) for 95th percentile
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Contractual maximum usable amperage
The power price per kWh in cents
The current power meter(kWh)
Does the service have free incoming traffic?
Invalid credentials
Invalid colocationId
Internal Server Error
The ID of the colocation service
The name of the colocation service
Contract start date
The date until which the service is paid
Contract cancel date if contract is cancelled
Contract end date
The duration of the contract in months
The extended period of the contract in months
The cancellation period in months
The order-name to which the server belongs
The duration in which the invoice has to be paid after receiving.
The price of this colocated server per month in cents
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency in which the various 'price' fields are:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The total used traffic (Mbit or GB, incoming + outgoing)
The total used traffic (Mbit) for 95th percentile
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Contractual maximum usable amperage
The power price per kWh in cents
The current power meter(kWh)
Does the service have free incoming traffic?
OK
The ID of the colocation service
The name of the colocation service
Contract start date
The date until which the service is paid
Contract cancel date if contract is cancelled
Contract end date
The duration of the contract in months
The extended period of the contract in months
The cancellation period in months
The order-name to which the server belongs
The duration in which the invoice has to be paid after receiving.
The price of this colocated server per month in cents
The price of traffic overuse in cents (per TB) (see currencyId for currency)
The currency in which the various 'price' fields are:
- 0: EURO
- 1: USD
- 9: YEN
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
The contractual maximum bandwidth usage value. In GB if bandwidthBillingType equals 2, in mbit otherwise
The total used traffic (Mbit or GB, incoming + outgoing)
The total used traffic (Mbit) for 95th percentile
The outgoing traffic (Mbit or GB)
The incoming traffic (Mbit or GB)
Contractual maximum usable amperage
The power price per kWh in cents
The current power meter(kWh)
Does the service have free incoming traffic?
Invalid credentials
Invalid colocationId
Internal Server Error
ID of the colocated service to fetch invoices for
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the invoice
The date the invoice was created
The due date of the invoice
The number of the invoice
A unique hash for this invoice
The description of the invoice
The currency that is being used
The currency sign that is being used
The amount of the invoice with VAT in cents
The amount of the invoice without VAT in cents
The payment status
The timestamp that the invoice was paid, if paid
If this field is 1 it means that invoice is a credit invoice
The remaining amount of invoice
The total paid amount of invoice
Invalid credentials
Invalid colocation ID
Internal Server Error
ID of the colocated service to fetch PDUs for
OK
The id of feed
The feed name
The serial number
The last update time
The feed type
The number of outlets on this pdu
The number of phases that this pdu supports
The last registered counter value
The total power factor
The total amperage supported by pdu
The peak amperage
The total actual voltage
The total min voltage
Invalid credentials
Invalid colocation ID
Internal Server Error
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
Start unix timestamp
End unix timestamp
OK
Unit of data frequency, possible interval options are as follows
- day
Invalid credentials
Invalid colocation ID or uplink ID
Internal Server Error
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid colocation ID or uplink ID
Internal Server Error
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid colocation ID or uplink ID
Internal Server Error
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid colocation ID or uplink ID
Internal Server Error
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid colocation ID or uplink ID
Internal Server Error
ID of the colocated server to get the alerts for
OK
Colocation alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
Invalid credentials
Invalid colocation ID
Internal Server Error
ID of the colocated server to create an alert for
Colocation alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
OK
Colocation alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
Invalid credentials
Invalid colocation ID
Unprocessable Entity
Internal Server Error
ID of the colocated server that the alert belongs to
ID of the host alert to update
Colocation alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
OK
Colocation alert ID
At what percentage of bandwidth usage to trigger the alert
Will send an email notification when alert is triggered
WIll create a ticket notification when alert is triggered
UNIX timestamp of the last time the alert was triggered
UNIX timestamp of the time the alert was created
Invalid credentials
Invalid colocation ID or alert ID
Unprocessable Entity
Internal Server Error
ID of the colocated server that the alert belongs to
ID of the alert to delete
No Content
Invalid credentials
Invalid colocated server ID or alert ID
Internal Server Error
No content
ID of the colocated server that the cancellation should applied to
No Content
Invalid credentials
Invalid colocated server ID
Unprocessable Entity
Internal Server Error
No content
ID of the cancelled colocated server that should be reverted
No Content
Invalid credentials
Invalid colocated server ID
Unable to revert cancellation of colocated server
Internal Server Error
No content
Example header and default range: RANGED-DATA:start=0,results=25
OK
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
Invalid credentials
Internal Server Error
The ID of the cross connect
OK
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
Invalid credentials
Invalid cross connect ID
Internal Server Error
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
OK
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
Invalid credentials
Invalid crossConnectId
Internal Server Error
The ID of the cross connect
Example header and default range: RANGED-DATA:start=0,results=25
OK
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
Invalid credentials
Invalid cross connect ID
Internal Server Error
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
No Content
Invalid credentials
Invalid crossConnectId
unprocessable entity
Internal Server Error
No content
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
OK
Cross connect ID
Start date of the cross connect
End date of the cross connect
Cancelled date of the cross connect
End contract date of the cross connect
Contract period of the cross connect
Extend period of the cross connect
The cancellation period in months
Payment term of the cross connect
Purchase order of the cross connect
Monthly fee of the cross connect in cents
Setup fee of the cross connect in cents
The currency ID
- 0: EURO
- 1: USD
- 9: YEN
Colocated server ID
Host ID
Location ID of the Side A
Location name of the Side A
Location ID of the Side B
Location name of the Side B
Location details
Rack ID of the Side A
Rack Name of the Side A
Rack ID of the Side B
Rack Name of the Side B
Go live date
Internal ID of the service
Internal name of the patch
Customer name of the patch
Third party ID of the service
Vendor ID of the service
Type of cable
Cable speed
Connector of Side A
Connector of Side Z
Diverse from patch id
Notes of the customer
The type of connectivity service Following will be possible values:
- Connectivity: Transport
- Connectivity: IP connectivity
- Connectivity: Crossconnect
The outgoing traffic (Mbit or GB - defined by "bandwidthBillingType")
The incoming traffic (Mbit or GB - defined by "bandwidthBillingType")
The bandwidth billing method for this service:
- 1: unmetered connection
- 2: measured in TB per month
- 3: measured in mbit 95th percentile
Invalid credentials
Invalid crossConnectId
unprocessable entity
Internal Server Error
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid cross connect ID or uplink ID
Internal Server Error
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid cross connect ID or uplink ID
Internal Server Error
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid cross connect ID or uplink ID
Internal Server Error
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
Base64 encoded image string
Invalid credentials
Invalid cross connect ID or uplink ID
Internal Server Error
ID of the colocation-service to which IP address belongs to
IP address to set RDNS entry for
The hostname
The corresponding ip for the host
No Content
Invalid credentials
Invalid colocation-service ID or IP address
Internal Server Error
No content
ID of the server
Server ID
Network Interface ID or graphUrl
Port rate limit
No Content
Invalid credentials
Unprocessable Entity
Internal Server Error
No content
ID of the server
Server ID
Network Interface ID or graphUrl
Port Speed
No Content
Invalid credentials
Unprocessable Entity
Internal Server Error
No content
ID of the server
Server ID
Network Interface ID or graphUrl
Port admin state
No Content
Invalid credentials
Unprocessable Entity
Internal Server Error
No content
OK
The ID of this operating system
The name of this operating system
Unique key for operating system
The operating system group.
- Windows
- Linux / BSD
1 if you can use this operating system with ODP, 0 otherwise.
1 if you can use this operating system with Flex Metal, 0 otherwise.
1 if this operating system is an active operating system, 0 otherwise.
Invalid credentials
Internal Server Error
OK
The ID of the slack setting
The slack setting name
The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)
The slack setting channel name
The slack setting channel username
Invalid credentials
Internal Server Error
The ID of the slack setting
The slack setting name
The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)
The slack setting channel name
The slack setting channel username
OK
The ID of the slack setting
The slack setting name
The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)
The slack setting channel name
The slack setting channel username
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the slack setting
OK
The ID of the slack setting
The slack setting name
The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)
The slack setting channel name
The slack setting channel username
Invalid credentials
Invalid slackSettingId
Internal Server Error
The Id of the slack setting
The ID of the slack setting
The slack setting name
The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)
The slack setting channel name
The slack setting channel username
OK
The ID of the slack setting
The slack setting name
The slack setting web hook (https://hooks.slack.com/services/TXXXXXXXX/BXXXXXXXX/xxxxxxxxxxxxxxxxxxxxxxxx)
The slack setting channel name
The slack setting channel username
Invalid credentials
Invalid slackSettingId
Conflict
Unprocessable Entity
Internal Server Error
The filter to search for the description
The filter parameter can be used to apply a more specific search, the only element that can be filtered is 'description'.
The filter will be done on a part of the provided description (it should contain the searched element).
E.g. we need to filter for a string "this is an example"
Remember to urlencode the provided filter
The final call would look like:
/billing/invoice?filter=this%20is%20an%20example
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the invoice
The date the invoice was created
The due date of the invoice
The number of the invoice
A unique hash for this invoice
The description of the invoice
The currency that is being used
The currency sign that is being used
The amount of the invoice with VAT in cents
The amount of the invoice without VAT in cents
The payment status
The timestamp that the invoice was paid, if paid
If this field is 1 it means that invoice is a credit invoice
The remaining amount of invoice
The total paid amount of invoice
Invalid credentials
Internal Server Error
The filter to search for the description
The filter parameter can be used to apply a more specific search, the only element that can be filtered is 'description'.
The filter will be done on a part of the provided description (it should contain the searched element).
E.g. we need to filter for a string "this is an example"
Remember to urlencode the provided filter
The final call would look like:
/billing/invoice?filter=this%20is%20an%20example
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the invoice
The date the invoice was created
The due date of the invoice
The number of the invoice
A unique hash for this invoice
The description of the invoice
The currency that is being used
The currency sign that is being used
The amount of the invoice with VAT in cents
The amount of the invoice without VAT in cents
The payment status
The timestamp that the invoice was paid, if paid
If this field is 1 it means that invoice is a credit invoice
The remaining amount of invoice
The total paid amount of invoice
Invalid credentials
Internal Server Error
ID of the invoice to fetch details about
OK
The ID of the invoice
Invoice number
A unique hash for this invoice
Client number
The date the invoice was created
The due date of the invoice
Whether or not the invoice was paid
The timestamp that the invoice was paid, if paid
If this field is 1 it means that invoice is a credit invoice
The invoice must be paid in the given amount of time (days)
The name of the currency that is being used
The sign of the currency that is being used
Percentage of VAT applied
Amount of VAT to pay in cents
The amount of the invoice with VAT included in cents
The amount of the invoice without VAT in cents
Invalid credentials
Invalid invoice ID
Internal Server Error
Number of the invoice to fetch details about
OK
The ID of the invoice
Invoice number
A unique hash for this invoice
Client number
The date the invoice was created
The due date of the invoice
Whether or not the invoice was paid
The timestamp that the invoice was paid, if paid
If this field is 1 it means that invoice is a credit invoice
The invoice must be paid in the given amount of time (days)
The name of the currency that is being used
The sign of the currency that is being used
Percentage of VAT applied
Amount of VAT to pay in cents
The amount of the invoice with VAT included in cents
The amount of the invoice without VAT in cents
Invalid credentials
Invalid invoice number
Internal Server Error
The invoiceId(s) to prepare pay data for separated by comma (,)
Remember to urlencode the provided invoiceIds
The invoiceIds call would look like:
/v3/account/invoice/pay/prepare?invoiceIds=111111%2C22222%2C33333%2C44444
OK
The total amount of the selected invoices
The currency that is being used
The currency sign that is being used
The total selected invoices for pay
The total selected credit invoices for settle
The amount of the account credit
Invalid credentials
Unprocessable Entity
Internal Server Error
OK
URL where to send the user with post form data
The amount of the account credit
Total amount to pay
Invalid credentials
Internal Server Error
OK
Payment processing result message
Payment processing result status
The method of the payment
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the continent
The name of the continent
The ID of the country
The name of the country
The ID of the data center. Find all possible values from GET /cloud/dcLocation
The name of the data center. Find all possible values from GET /cloud/dcLocation
The host name of the ping server in this data center
List of ip address of ip version 4
List of ip address of ip version 6
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of the continent
The name of the continent
The ID of the country
The name of the country
The ID of the data center. Find all possible values from GET /cloud/dcLocation
The name of the data center. Find all possible values from GET /cloud/dcLocation
The region name of the ping server in this data center
Invalid credentials
Internal Server Error
OK
Invalid credentials
Internal Server Error
OK
Callback setting ID, can be used as callbackSettingId in other endpoints.
This is the url that the system will use when the callback is executed.
Description of the callback setting.
For sending additional meta information about the callback request.
Invalid credentials
Internal Server Error
Callback setting ID, can be used as callbackSettingId in other endpoints.
This is the url that the system will use when the callback is executed.
Description of the callback setting.
For sending additional meta information about the callback request.
OK
Callback setting ID, can be used as callbackSettingId in other endpoints.
This is the url that the system will use when the callback is executed.
Description of the callback setting.
For sending additional meta information about the callback request.
Invalid credentials
Unprocessable Entity
Internal Server Error
The Id of the callback setting
OK
Callback setting ID, can be used as callbackSettingId in other endpoints.
This is the url that the system will use when the callback is executed.
Description of the callback setting.
For sending additional meta information about the callback request.
Invalid credentials
Invalid callbackSettingId
Internal Server Error
The Id of the callback setting
Callback setting ID, can be used as callbackSettingId in other endpoints.
This is the url that the system will use when the callback is executed.
Description of the callback setting.
For sending additional meta information about the callback request.
OK
Callback setting ID, can be used as callbackSettingId in other endpoints.
This is the url that the system will use when the callback is executed.
Description of the callback setting.
For sending additional meta information about the callback request.
Invalid credentials
Invalid callbackSettingId
Unprocessable Entity
Internal Server Error
The Id of the callback setting
No Content
Invalid credentials
Invalid callbackSettingId
Internal Server Error
No content
The Http method that was used in the call. Possible values are {GET, POST, PUT and DELETE}
Example header: RANGED-DATA:start=0,results=25
OK
Invalid credentials
Invalid requestType
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
The country ID
The country code
The country name
The continent name
Invalid credentials
Internal Server Error
New Account Email Address
New Account Password
First name.
Last name.
Whether or not newsletter is subscribed to
Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.
Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.
Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.
OK
User ID
User Name
First name.
Last name.
Whether or not newsletter is subscribed to
Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.
Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.
Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.
Invalid credentials
Account already exists
Internal Server Error
Current Password
New Password
No Content
Invalid credentials
Too many login requests performed
Internal Server Error
No content
New Password
Reset Hash
No Content
Invalid credentials
User is already logged in
Internal Server Error
No content
UserId
Hash
OK
Type of e-mail that was validated, possible types can be main, billing or abuse
billingInvalid credentials
Invalid confirmation details
Unprocessable Entity
Internal Server Error
Email to resend the confirmation for
No Content
Invalid credentials
Invalid email
Unprocessable Entity
Internal Server Error
No content
OK
Account type: 1 - consumer, 2 - business. Can only be updated by submitting a support ticket.
Company name (for business accounts). Can only be updated by submitting a support ticket.
VAT number (for business accounts). Can only be updated by submitting a support ticket.
CoC number (only for Netherlands accounts). Can only be updated by submitting a support ticket.
First name.
Last name.
Address - street name.
House number
ZIP / Post code.
City.
Country code in ISO 3166-1 alpha-2 format.
Email address
Whether or not email address has been confirmed
Phone number. Either this or phoneNumberMobile is required
Mobile phone number. Either this or phoneNumber is required
Preferred language: 0 - english, 1 - dutch
Email address for abuse emails
Whether or not newsletter is subscribed to
Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.
Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.
Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.
Whether or not the user is allowed to order flexmetal servers.
Invalid credentials
Internal Server Error
Account type: 1 - consumer, 2 - business. Can only be updated by submitting a support ticket.
Company name (for business accounts). Can only be updated by submitting a support ticket.
VAT number (for business accounts). Can only be updated by submitting a support ticket.
CoC number (only for Netherlands accounts). Can only be updated by submitting a support ticket.
First name.
Last name.
Address - street name.
House number
ZIP / Post code.
City.
Country code in ISO 3166-1 alpha-2 format.
Email address
Whether or not email address has been confirmed
Phone number. Either this or phoneNumberMobile is required
Mobile phone number. Either this or phoneNumber is required
Preferred language: 0 - english, 1 - dutch
Email address for abuse emails
Whether or not newsletter is subscribed to
Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.
Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.
Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.
Whether or not the user is allowed to order flexmetal servers.
OK
Account type: 1 - consumer, 2 - business. Can only be updated by submitting a support ticket.
Company name (for business accounts). Can only be updated by submitting a support ticket.
VAT number (for business accounts). Can only be updated by submitting a support ticket.
CoC number (only for Netherlands accounts). Can only be updated by submitting a support ticket.
First name.
Last name.
Address - street name.
House number
ZIP / Post code.
City.
Country code in ISO 3166-1 alpha-2 format.
Email address
Whether or not email address has been confirmed
Phone number. Either this or phoneNumberMobile is required
Mobile phone number. Either this or phoneNumber is required
Preferred language: 0 - english, 1 - dutch
Email address for abuse emails
Whether or not newsletter is subscribed to
Whether or not Terms and Conditions are agreed to. Cannot be changed after agreeing.
Whether or not Acceptable Use Policy is agreed to. Cannot be changed after agreeing.
Whether or not Data Processing Agreement is agreed to. Cannot be changed after agreeing.
Whether or not the user is allowed to order flexmetal servers.
Invalid credentials
Conflict
Unprocessable Entity
Internal Server Error
OK
Billing first name.
Billing last name.
Billing address.
Billing street number.
Billing ZIP code.
Billing city.
Country code in ISO 3166-1 alpha-2 format.
Billing phone number. Either this or phoneNumberMobile is required.
Billing mobile phone number. Either this or phoneNumber is required.
Email address for billing emails
Whether or not to bundle invoices of the same category
Whether or not to send email confirmations via email
Preferred payment method
Invalid credentials
Internal Server Error
Billing first name.
Billing last name.
Billing address.
Billing street number.
Billing ZIP code.
Billing city.
Country code in ISO 3166-1 alpha-2 format.
Billing phone number. Either this or phoneNumberMobile is required.
Billing mobile phone number. Either this or phoneNumber is required.
Email address for billing emails
Whether or not to bundle invoices of the same category
Whether or not to send email confirmations via email
Preferred payment method
OK
Billing first name.
Billing last name.
Billing address.
Billing street number.
Billing ZIP code.
Billing city.
Country code in ISO 3166-1 alpha-2 format.
Billing phone number. Either this or phoneNumberMobile is required.
Billing mobile phone number. Either this or phoneNumber is required.
Email address for billing emails
Whether or not to bundle invoices of the same category
Whether or not to send email confirmations via email
Preferred payment method
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
Remote ip address
Title Of The action
A description about the action
Log creation date
Log creation time
The unix time at which the log was created
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
API key ID
API key access category
API key
API key note
Whether or not to assign ODP server IPs
Number of times that the API key was used
API key expiration time as UNIX timestamp
Invalid credentials
Internal Server Error
API key ID
API key access category
API key
API key note
Whether or not to assign ODP server IPs
Number of times that the API key was used
API key expiration time as UNIX timestamp
OK
API key ID
API key access category
API key
API key note
Whether or not to assign ODP server IPs
Number of times that the API key was used
API key expiration time as UNIX timestamp
Invalid credentials
Internal Server Error
ID of API key to update
API key ID
API key access category
API key
API key note
Whether or not to assign ODP server IPs
Number of times that the API key was used
API key expiration time as UNIX timestamp
OK
API key ID
API key access category
API key
API key note
Whether or not to assign ODP server IPs
Number of times that the API key was used
API key expiration time as UNIX timestamp
Invalid credentials
Unprocessable Entity
Internal Server Error
ID of API key
Example header and default range: RANGED-DATA:start=0,results=25
OK
Whitelist ID
Start IP of API key IP whitelist range
End IP of API key IP whitelist range
CIDR IP range of API key whitelist
IP whitelist range comments
Whether or not this IP whitelist range is active
Last time this IP whitelist range was updated
Invalid credentials
Invalid API key ID
Internal Server Error
ID of API key
Whitelist ID
Start IP of API key IP whitelist range
End IP of API key IP whitelist range
CIDR IP range of API key whitelist
IP whitelist range comments
Whether or not this IP whitelist range is active
Last time this IP whitelist range was updated
OK
Whitelist ID
Start IP of API key IP whitelist range
End IP of API key IP whitelist range
CIDR IP range of API key whitelist
IP whitelist range comments
Whether or not this IP whitelist range is active
Last time this IP whitelist range was updated
Invalid credentials
Invalid API key ID
Unprocessable Entity
Internal Server Error
ID of API key
Whitelisted IP range ID
Whitelist ID
Start IP of API key IP whitelist range
End IP of API key IP whitelist range
CIDR IP range of API key whitelist
IP whitelist range comments
Whether or not this IP whitelist range is active
Last time this IP whitelist range was updated
OK
Whitelist ID
Start IP of API key IP whitelist range
End IP of API key IP whitelist range
CIDR IP range of API key whitelist
IP whitelist range comments
Whether or not this IP whitelist range is active
Last time this IP whitelist range was updated
Invalid credentials
Invalid API key whitelist ID
Unprocessable Entity
Internal Server Error
ID of API key
Whitelisted IP range ID
No Content
Invalid credentials
Invalid API key whitelist ID
Internal Server Error
No content
Example header and default range: RANGED-DATA:start=0,results=25
OK
IP whitelist ID
First IP in range
Last IP in range
IP range with network suffix such as /24, /32, etc.
Description of whitelisted IP or range
Whether or not this whitelist entry is active
Unix timestamp of when the IP whitelisting was created
Invalid credentials
Internal Server Error
IP whitelist ID
First IP in range
Last IP in range
IP range with network suffix such as /24, /32, etc.
Description of whitelisted IP or range
Whether or not this whitelist entry is active
Unix timestamp of when the IP whitelisting was created
OK
IP whitelist ID
First IP in range
Last IP in range
IP range with network suffix such as /24, /32, etc.
Description of whitelisted IP or range
Whether or not this whitelist entry is active
Unix timestamp of when the IP whitelisting was created
Invalid credentials
Unprocessable Entity
Internal Server Error
Whitelisted IP range ID
IP whitelist ID
First IP in range
Last IP in range
IP range with network suffix such as /24, /32, etc.
Description of whitelisted IP or range
Whether or not this whitelist entry is active
Unix timestamp of when the IP whitelisting was created
OK
IP whitelist ID
First IP in range
Last IP in range
IP range with network suffix such as /24, /32, etc.
Description of whitelisted IP or range
Whether or not this whitelist entry is active
Unix timestamp of when the IP whitelisting was created
Invalid credentials
Invalid IP whitelist ID
Unprocessable Entity
Internal Server Error
OK
File ID
ID of the category of the file
File display name
Name of the file
File MIME type
File size in bytes
UNIX timestamp of when the file was uploaded
Invalid credentials
Internal Server Error
OK
ID of the document
Type of the document
Number of document
Expiration date of document
Invalid credentials
Internal Server Error
ID of the document
Type of the document
Number of document
Expiration date of document
OK
ID of the document
Type of the document
Number of document
Expiration date of document
Invalid credentials
Unprocessable Entity
Internal Server Error
Example /v3/colocation/access?status=revoked
Example header and default range: RANGED-DATA:start=0,results=25
OK
The ID of colocation access request
The ID of the user
The ID of data center
The date when the user was verified
The date when the user was added to the access list
The date when the user was removed from the access list
The e-mail address of the visitor
The mobile phone number of the visitor
The first name of the visitor
The last name of the visitor
The birth date of the user. The format is YYYY-MM-DD
The company name of the visitor
The city of the visitor
The country name of the visitor
Notes for admins
Was the user checked?
ID of user creator
Is this a new entry
temporaryAccess If this field is set to 1, then has the visitor a temporary access
The print ID from Syntegro system
Was the print made
If this field is set to 1, then this visitor can add a temporary access for other visitor
If this field is set to 1, then this visitor can request a permanent access for other visitor
The Syntegro employee code of visitor
The status of the visitor (granted, pending, denied, revoked, suspended)
Invalid credentials
Unprocessable Entity
Internal Server Error
The ID of colocation access request
The ID of the visitor
The e-mail address of the visitor
The mobile phone number of the visitor
The first name of the visitor
The last name of the visitor
The birth date of the visitor
The company name of visitor
If this field is set to 1, then the visitor has a temporary access
If this field is set to 1, then this visitor can add a temporary access for other visitor
If this field is set to 1, then this visitor can request a permanent access for other visitor
OK
The ID of colocation access request
The ID of the user
The ID of data center
The date when the user was verified
The date when the user was added to the access list
The date when the user was removed from the access list
The e-mail address of the visitor
The mobile phone number of the visitor
The first name of the visitor
The last name of the visitor
The birth date of the user. The format is YYYY-MM-DD
The company name of the visitor
The city of the visitor
The country name of the visitor
Notes for admins
Was the user checked?
ID of user creator
Is this a new entry
temporaryAccess If this field is set to 1, then has the visitor a temporary access
The print ID from Syntegro system
Was the print made
If this field is set to 1, then this visitor can add a temporary access for other visitor
If this field is set to 1, then this visitor can request a permanent access for other visitor
The Syntegro employee code of visitor
The status of the visitor (granted, pending, denied, revoked, suspended)
Invalid credentials
Internal Server Error
ID of the access
OK
The ID of colocation access request
The ID of the user
The ID of data center
The date when the user was verified
The date when the user was added to the access list
The date when the user was removed from the access list
The e-mail address of the visitor
The mobile phone number of the visitor
The first name of the visitor
The last name of the visitor
The birth date of the user. The format is YYYY-MM-DD
The company name of the visitor
The city of the visitor
The country name of the visitor
Notes for admins
Was the user checked?
ID of user creator
Is this a new entry
temporaryAccess If this field is set to 1, then has the visitor a temporary access
The print ID from Syntegro system
Was the print made
If this field is set to 1, then this visitor can add a temporary access for other visitor
If this field is set to 1, then this visitor can request a permanent access for other visitor
The Syntegro employee code of visitor
The status of the visitor (granted, pending, denied, revoked, suspended)
Invalid credentials
Invalid accessId
Internal Server Error
ID of the access
The ID of colocation access request
The ID of the visitor
The e-mail address of the visitor
The mobile phone number of the visitor
The first name of the visitor
The last name of the visitor
The birth date of the visitor
The company name of visitor
If this field is set to 1, then the visitor has a temporary access
If this field is set to 1, then this visitor can add a temporary access for other visitor
If this field is set to 1, then this visitor can request a permanent access for other visitor
OK
The ID of colocation access request
The ID of the user
The ID of data center
The date when the user was verified
The date when the user was added to the access list
The date when the user was removed from the access list
The e-mail address of the visitor
The mobile phone number of the visitor
The first name of the visitor
The last name of the visitor
The birth date of the user. The format is YYYY-MM-DD
The company name of the visitor
The city of the visitor
The country name of the visitor
Notes for admins
Was the user checked?
ID of user creator
Is this a new entry
temporaryAccess If this field is set to 1, then has the visitor a temporary access
The print ID from Syntegro system
Was the print made
If this field is set to 1, then this visitor can add a temporary access for other visitor
If this field is set to 1, then this visitor can request a permanent access for other visitor
The Syntegro employee code of visitor
The status of the visitor (granted, pending, denied, revoked, suspended)
Invalid credentials
Invalid accessId
Internal Server Error
The ID of the access
OK
ID of the document
Type of the document
Number of document
Expiration date of document
Invalid credentials
Internal Server Error
The ID of the access
ID of the document
Type of the document
Number of document
Expiration date of document
OK
ID of the document
Type of the document
Number of document
Expiration date of document
Invalid credentials
Unprocessable Entity
Internal Server Error
The ID of the access
The ID of the document to view
OK
ID of the document
Type of the document
Number of document
Expiration date of document
Invalid credentials
Invalid document id
Internal Server Error
The ID of the access
The ID of the document to update
ID of the document
Type of the document
Number of document
Expiration date of document
OK
ID of the document
Type of the document
Number of document
Expiration date of document
Invalid credentials
Invalid API key access ID
Unprocessable Entity
Internal Server Error
The ID of the access
The ID of the document to delete
No Content
Invalid credentials
Invalid document id
Internal Server Error
No content
OK
The ID of the service
The name of the service
The amount of service the customer has
Invalid credentials
Internal Server Error
OK
The status of all the systems
- 1: All systems operational
- 2: Multiple systems have performance issues
- 3: Multiple systems are offline
- 4: All systems are offline
Invalid credentials
Internal Server Error
The ID of the trigger for which to fetch the information
OK
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
Invalid credentials
Invalid ID
Internal Server Error
The ID of the trigger
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
OK
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
Invalid credentials
Invalid ID
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
Invalid credentials
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
OK
ID of the type
The name of the trigger
The description of the trigger
Invalid credentials
Internal Server Error
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
OK
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
Invalid credentials
Internal Server Error
The ID of the trigger
OK
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
Invalid credentials
Invalid ID
Internal Server Error
The ID of the trigger
OK
ID of the the trigger
The name of the trigger
The description of the trigger
The unix timestamp when the trigger has been created.
The unix timestamp when the trigger has been changed.
Status of the trigger
- 1 the trigger is enabled
- 0 the trigger is disabled
Invalid credentials
Invalid ID
Internal Server Error
OK
ID of the type
The description of the type
Invalid credentials
Internal Server Error
OK
ID of the type
The description of the type
Invalid credentials
Internal Server Error
OK
SSH key UUID as specified in RFC 4122
7561c39d-f4df-4c46-b3f1-2ac981271e29SSH key name
Public SSH key contents
SSH key createdAt
Invalid credentials
Internal Server Error
Note: Please always upload a public(!) key and preferably in OpenSSH format.
SSH key UUID as specified in RFC 4122
7561c39d-f4df-4c46-b3f1-2ac981271e29SSH key name
Public SSH key contents
SSH key createdAt
OK
SSH key UUID as specified in RFC 4122
7561c39d-f4df-4c46-b3f1-2ac981271e29SSH key name
Public SSH key contents
SSH key createdAt
Invalid credentials
Unprocessable Entity
Internal Server Error
OK
SSH key UUID as specified in RFC 4122
7561c39d-f4df-4c46-b3f1-2ac981271e29SSH key name
Public SSH key contents
SSH key createdAt
Invalid credentials
Entity not found
Internal Server Error
SSH key UUID
7561c39d-f4df-4c46-b3f1-2ac981271e29No Content
Invalid UUID
Invalid credentials
SSH key not found
Internal Server Error
No content
OK
Currency ID
Currency Name
Currency Sign
Exchange rate to Euro
Number of decimals
Invalid credentials
Internal Server Error
Filter by status [creating, provisioning, delivered, failed, releasing, released]
Filter by one or more server tags (only servers with all tags will be returned)
Example header and default range: RANGED-DATA:start=0,results=25
OK
Server UUID.
019256ab-1554-73a7-b091-f024b0a724eaServer host name.
host.example.comServer delivery status.
- created
- discovering
- discovered
- allocating
- allocated
- configuring_network
- network_configured
- provisioning
- provisioned
- delivered
- failed
- releasing
- released
deliveredStatus message.
OKServer tags.
my-tagServer creation timestamp.
1728030905Server delivery timestamp.
1728031748Server release timestamp.
Represents client contractId.
MY-CONTRACT-123Invalid credentials
Internal Server Error
Request object for creating a new Flex Metal server
Server name or hostname, depending on the chosen OS. E.g. Talos requires a hostname but regular Linux OSs work with either.
host.example.comServer location. Available locations can be obtained from /v3/flexMetal/location. Use the name field from the response.
Server instance type. Available instance types can be obtained from /v3/flexMetal/location/{locationId}}/instanceTypes. Use the name field from the response.
bm7.std.8A list of SSH keys. You can either supply SSH key UUIDs from stored objects in /v3/sshKey or provide public keys directly. SSH keys are installed for the root user.
ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHAyNTYAAAAIbmlzdHAyNTYAAABBBHo8IaPkQ6UnDZvi4F4RBSouRa6Gtysdg2EF+SIXheVF2SGBQ2uH7RfDjXRfvq4VpHJrKYs4kWfNoHQg8ZG6PH4= ecdsa-key-20240131Post install script. A shell script (e.g. bash) that will be executed after your OS is installed. Currently only supported for Linux based operating systems.
#!/bin/bash echo "Hello world!" > /root/blah.txtA list of tags. There is a maximum of 60 tags per server. Each tag must adhere to this pattern: ^[A-Za-z0-9_:-]{1,64}$
my-tagRepresents client contractId. Format is ^[A-Z0-9_-.]{0,240}$
MY-CONTRACT-123If true, the server will be created even if the location is at commited capacity. Default is false.
trueOK
Server UUID.
019256ab-1554-73a7-b091-f024b0a724eaServer host name.
host.example.comServer delivery status.
- created
- discovering
- discovered
- allocating
- allocated
- configuring_network
- network_configured
- provisioning
- provisioned
- delivered
- failed
- releasing
- released
deliveredStatus message.
OKServer tags.
my-tagServer creation timestamp.
1728030905Server delivery timestamp.
1728031748Server release timestamp.
Represents client contractId.
MY-CONTRACT-123Invalid request body
Invalid credentials
Unprocessable content
Internal Server Error
The server identifier
OK
Server UUID.
019256ab-1554-73a7-b091-f024b0a724eaServer host name.
host.example.comServer delivery status.
- created
- discovering
- discovered
- allocating
- allocated
- configuring_network
- network_configured
- provisioning
- provisioned
- delivered
- failed
- releasing
- released
deliveredStatus message.
OKServer tags.
my-tagServer creation timestamp.
1728030905Server delivery timestamp.
1728031748Server release timestamp.
Represents client contractId.
MY-CONTRACT-123Invalid credentials
Resource not found
Internal Server Error
The server identifier
OK
Server UUID.
019256ab-1554-73a7-b091-f024b0a724eaServer host name.
host.example.comServer delivery status.
- created
- discovering
- discovered
- allocating
- allocated
- configuring_network
- network_configured
- provisioning
- provisioned
- delivered
- failed
- releasing
- released
deliveredStatus message.
OKServer tags.
my-tagServer creation timestamp.
1728030905Server delivery timestamp.
1728031748Server release timestamp.
Represents client contractId.
MY-CONTRACT-123Invalid credentials
Resource not found
Internal Server Error
Windows only: Fetch the root password within the first 24 hours after installation.
The server identifier
OK
Server root password.
Invalid credentials
Resource not found
Internal Server Error
The server identifier
The tag to add to the server
OK
Server UUID.
019256ab-1554-73a7-b091-f024b0a724eaServer host name.
host.example.comServer delivery status.
- created
- discovering
- discovered
- allocating
- allocated
- configuring_network
- network_configured
- provisioning
- provisioned
- delivered
- failed
- releasing
- released
deliveredStatus message.
OKServer tags.
my-tagServer creation timestamp.
1728030905Server delivery timestamp.
1728031748Server release timestamp.
Represents client contractId.
MY-CONTRACT-123Invalid credentials
Resource not found
Internal Server Error
The server identifier
The tag to remove from the server
OK
Server UUID.
019256ab-1554-73a7-b091-f024b0a724eaServer host name.
host.example.comServer delivery status.
- created
- discovering
- discovered
- allocating
- allocated
- configuring_network
- network_configured
- provisioning
- provisioned
- delivered
- failed
- releasing
- released
deliveredStatus message.
OKServer tags.
my-tagServer creation timestamp.
1728030905Server delivery timestamp.
1728031748Server release timestamp.
Represents client contractId.
MY-CONTRACT-123Invalid credentials
Resource not found
Internal Server Error
Example header and default range: RANGED-DATA:start=0,results=25
List of tags
A Flex Metal tag
The tag name
my-tagInvalid credentials
Internal Server Error
A Flex Metal tag
The tag name
my-tagThe new tag
A Flex Metal tag
The tag name
my-tagInvalid credentials
Unprocessable content
Internal Server Error
A Flex Metal tag
The tag name
my-tagThe updated tag model
A Flex Metal tag
The tag name
my-tagInvalid credentials
Resource not found
New tag name already exists
Unprocessable content
Internal Server Error
Must be a valid date string. E.g. YYYY-MM-DD.
Must be a valid date string. E.g. YYYY-MM-DD.
OK
Usage tracking starts.
Usage tracking ends.
Total hours of usage.
Total minutes of usage.
Total bandwidth out.
Forbidden
Method Not Allowed
Unprocessable Content
Internal Server Error
OK
ID of the location
Name of the location
Short name of the location
Display name of the location
Country ID of the location
Country name of the Location
Country short name of the Location
Internal Server Error
For an overview of all locations, see /v3/flexMetal/location
OK
Id of instance type
LocationId of instance type
Name of instance type
Sockets of instance type
Cores of instance type
Memory of instance type
Memory type of instance type
Storage of instance type
Storage type of instance type
Generation name of instance type
Internal Server Error
Last updated
Was this helpful?