Skip to main content
Version: 0.18.x

Status

GET 

/status

Status

Returns all information about the app and its current status.

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.

Request​

Responses​

Server is running, backend configuration is returned in body

Schema

    config

    object

    required

    The app configuration

    allow_remote_images booleanrequired
    batch_duration_millis int64required

    Default value: 100

    body_size_limit_bytes integerrequired

    Default value: 2097152

    echo booleanrequired
    enable_metrics booleanrequired

    Default value: true

    heartbeat_check_interval int64required

    Default value: 1

    launch_management_server booleanrequired

    Default value: true

    launch_openai_server booleanrequired

    Default value: true

    launch_sagemaker_server booleanrequired

    Default value: true

    launch_vertex_server booleanrequired

    Default value: true

    management_port int32required

    Default value: 3001

    max_batch_size integerrequired

    Default value: 8

    openai_port int32required

    Default value: 3003

    port int32required

    Default value: 3000

    repository_path stringrequired

    Default value: file:///path/to/home/artefacts

    vertex_port int32required

    Default value: 3002

    status

    object

    nullable

    dead_readers

    object

    required

    property name*

    ReaderInfo

    backend stringrequired
    consumer_group 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

    backend stringrequired
    consumer_group stringrequired
    model_name stringrequired
    model_type stringrequired
    pids int32[]required

    loading_readers

    object

    required

    property name*

    ReaderInfo

    backend stringrequired
    consumer_group stringrequired
    model_name stringrequired
    model_type stringrequired
    pids int32[]required
Loading...