General
OpenAPI documentation for the i3D.net API.
Last updated
OpenAPI documentation for the i3D.net API.
Last updated
The Id of the cross connect
The Id of the uplink
Start unix timestamp
End unix timestamp
Start unix timestamp
End unix timestamp
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
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
Unix timestamp. Filter from time, default value is -1 day
Unix timestamp. Filter to time, default value is now
Order ID
No content
The Id of the jobs you are soliciting for
The Id of the solicitation you are uploading files for
No content
Attachment ID
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
Fields return in response, only fields available in model can be filter out
Example header and default range: RANGED-DATA:start=0,results=25
ID of the colocated service to fetch invoices for
Example header and default range: RANGED-DATA:start=0,results=25
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
Start unix timestamp
End unix timestamp
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
ID of the colocated server to fetch traffic for
ID of the uplink to fetch traffic for
ID of the colocated server that the alert belongs to
ID of the alert to delete
No content
ID of the colocated server that the cancellation should applied to
No content
ID of the cancelled colocated server that should be reverted
No content
The ID of the cross connect
Example header and default range: RANGED-DATA:start=0,results=25
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
ID of the cross connect to fetch traffic for
ID of the uplink to fetch traffic for
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
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
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
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
ID of API key
Example header and default range: RANGED-DATA:start=0,results=25
Example /v3/colocation/access?status=revoked
Example header and default range: RANGED-DATA:start=0,results=25
The ID of the access
The ID of the document to delete
No content
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
Windows only: Fetch the root password within the first 24 hours after installation.
The server identifier
Must be a valid date string. E.g. YYYY-MM-DD.
Must be a valid date string. E.g. YYYY-MM-DD.
6 digit One-Time Password
No content
ID of a reseller type
Name of a reseller type
ID of the category
ID of a category
No content
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.
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
No content
Order ID
Order quantity
A hash, as provided in the newsletter unsubscribe url
A key, as provided in the newsletter unsubscribe url
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
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
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
Ticket ID
Reply title
Reply content
The IDs of attachments that have been uploaded through POST /v3/tickets/attachment
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:
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:
The bandwidth billing method for this service:
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)
The ID of the colocation service
The name of the colocation service
The data center details
The rack details in which the server is installed
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:
The bandwidth billing method for this service:
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?
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
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
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
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:
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:
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
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:
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:
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
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:
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:
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
ID of the server
Server ID
Network Interface ID or graphUrl
Port rate limit
No content
ID of the server
Server ID
Network Interface ID or graphUrl
Port Speed
No content
ID of the server
Server ID
Network Interface ID or graphUrl
Port admin state
No content
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
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
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.
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.
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.
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
Email address which is not confirmed yet
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.
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
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
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
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
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
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
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
ID of the document
Type of the document
Number of document
Expiration date of document
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
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
The ID of the access
ID of the document
Type of the document
Number of document
Expiration date of document
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
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
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
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
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.8Server operating system.
A 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.
trueA Flex Metal tag
The tag name
my-tagA list of resources that use this tag
A Flex Metal tag
The tag name
my-tagA list of resources that use this tag