Platform API

actor.list

Description

Lists all actors associated with the token used. Can be filtered by tags in the query string.

Code Examples

curl -X GET 'https://api.rivet.gg/actors'

Schema

Request Parameters

project
nullable string query parameter
environment
nullable string query parameter
endpoint_type
nullable string
- hostname
- path
tags_json
nullable string query parameter
include_destroyed
nullable boolean query parameter
cursor
nullable string query parameter

Response

actors
array of objects
A list of actors for the project associated with the token.
- actors[].id
  string
- actors[].region
  string
- actors[].tags
  unknown
- actors[].runtime
  object
  - actors[].runtime.build
    string
  - actors[].runtime.arguments
    nullable array of strings
  - actors[].runtime.environment
    nullable map
- actors[].network
  object
  - actors[].network.mode
    string
    bridge
    host
  - actors[].network.ports
    map
    actors[].network.ports[key].protocol
    string
    http
    https
    tcp
    tcp_tls
    udp
    actors[].network.ports[key].internal_port
    nullable integer
    actors[].network.ports[key].hostname
    nullable string
    actors[].network.ports[key].port
    nullable integer
    actors[].network.ports[key].path
    nullable string
    actors[].network.ports[key].url
    nullable string
    Fully formed connection URL including protocol, hostname, port, and path, if applicable.
    actors[].network.ports[key].routing
    object
    actors[].network.ports[key].routing.guard
    nullable empty object
    actors[].network.ports[key].routing.host
    nullable empty object
- actors[].resources
  object
  - actors[].resources.cpu
    integer
    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.
  - actors[].resources.memory
    integer
    The amount of memory in megabytes
- actors[].lifecycle
  object
  - actors[].lifecycle.kill_timeout
    nullable integer
    The duration to wait for in milliseconds before killing the actor. This should be set to a safe default, and can be overridden during a DELETE request if needed.
  - actors[].lifecycle.durable
    nullable boolean
    If true, the actor will try to reschedule itself automatically in the event of a crash or a datacenter failover. The actor will not reschedule if it exits successfully.
- actors[].created_at
  string
  RFC3339 timestamp
- actors[].started_at
  nullable string
  RFC3339 timestamp
- actors[].destroyed_at
  nullable string
  RFC3339 timestamp