Status

GET 
/status

Status

Returns all information about the app and its current status. More verbose than the /status endpoint on the inference endpoint and exposes more sensitive information about the deployment which only the admin should have access to.

The /status endpoint gives information about currently active models, and the config the app is running with. A 200 response indicates that the server is running. To check if the server is ready to receive requests, see the /healthz endpoint.

Responses

200

Server is running, backend configuration is returned in body

application/json

Schema

Schema

config

object

required

The app configuration

allow_remote_images booleanrequired

body_size_limit_bytes integerrequired

Default value: 2097152

echo booleanrequired

enable_metrics booleanrequired

Default value: true

heartbeat_check_interval int64required

Default value: 1

internal_port int32required

Default value: 3005

management_port int32required

Default value: 3001

openai_port int32required

Default value: 3003

port int32required

Default value: 3000

reader_message_timeout_ms int64required

Default value: 500

repository_path stringrequired

Default value: /path/to/home/artefacts

reserved_consumers stringrequired

Default value: primary

snowflake_port int32required

Default value: 3004

vertex_port int32required

Default value: 3002

status

object

nullable

dead_readers

object

required

property name*

ReaderInfo

consumer_groups string[]required

consumer_name stringrequired

device stringrequired

model_name stringrequired

model_type stringrequired

pids int32[]required

last_heartbeat

object

required

property name*

LastHeartbeat

heartbeat_timestamp int64required

heartbeat_wait_interval int64required

live_readers

object

required

property name*

ReaderInfo

consumer_groups string[]required

consumer_name stringrequired

device stringrequired

model_name stringrequired

model_type stringrequired

pids int32[]required

loading_readers

object

required

property name*

ReaderInfo

consumer_groups string[]required

consumer_name stringrequired

device stringrequired

model_name stringrequired

model_type stringrequired

pids int32[]required

reserved_consumers string[]required

Example (from schema)

{
  "config": {
    "allow_remote_images": false,
    "body_size_limit_bytes": 2097152,
    "echo": false,
    "enable_metrics": true,
    "heartbeat_check_interval": 1,
    "internal_port": 3005,
    "management_port": 3001,
    "openai_port": 3003,
    "port": 3000,
    "reader_message_timeout_ms": 500,
    "repository_path": "/path/to/home/artefacts",
    "reserved_consumers": "primary",
    "snowflake_port": 3004,
    "vertex_port": 3002
  },
  "status": {
    "dead_readers": {},
    "last_heartbeat": {},
    "live_readers": {},
    "loading_readers": {},
    "reserved_consumers": [
      "string"
    ]
  }
}

503

Server is not available

Loading...