Sign In

get

Description

Gets a dynamic server.

Code Examples

curl -X GET 'https://api.rivet.gg/games/{game_id}/environments/{environment_id}/servers/{server_id}'

Request Parameters

game_id

required path parameter

environment_id

required path parameter

server_id

required path parameter

The id of the server to destroy

Response Body

  • server
    object
    • server.id
      string
    • server.environment
      string
    • server.datacenter
      string
    • server.tags
      any value
    • server.runtime
      object
      • server.runtime.build
        string
      • server.runtime.arguments
        array of strings
      • server.runtime.environment
        union of empty object and string
    • server.network
      object
      • server.network.mode
        string
      • server.network.ports
        union of empty object and object
          • server.network.ports.protocol
            string
          • server.network.ports.internal_port
            number
          • server.network.ports.public_hostname
            string
          • server.network.ports.public_port
            number
          • server.network.ports.routing
            object
            • server.network.ports.routing.game_guard
              empty object
            • server.network.ports.routing.host
              empty object
    • server.resources
      object
      • server.resources.cpu
        number

        The number of CPU cores in millicores, or 1/1000 of a core. For example, 1/8 of a core would be 125 millicores, and 1 core would be 1000 millicores.

      • server.resources.memory
        number

        The amount of memory in megabytes

    • server.lifecycle
      object
      • server.lifecycle.kill_timeout
        number

        The duration to wait for in milliseconds before killing the server. This should be set to a safe default, and can be overridden during a DELETE request if needed.

    • server.created_at
      number
    • server.started_at
      number
    • server.destroyed_at
      number