DedicatedServer
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
Last updated
Was this helpful?