Skip to main content
GET
/
api
/
models
/
{model}
/
deployments
List a model's deployments
curl --request GET \
  --url https://api.example.com/api/models/{model}/deployments \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "deployment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "domain": "<string>",
      "owner": "<string>",
      "model": {
        "model_name": "<string>",
        "model_version": "<string>",
        "model_alias": "<string>"
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "resolved_model_version": "<string>",
      "dag_id": "<string>",
      "dag_s3_uri": "<string>",
      "schedule": "<string>",
      "last_run": {
        "run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "airflow_run_id": "<string>",
        "rows_scored": 123,
        "started_at": "2023-11-07T05:31:56Z",
        "finished_at": "2023-11-07T05:31:56Z"
      },
      "service_url": "<string>",
      "replica_count": 123,
      "ready_replicas": 123,
      "allowed_roles": [
        "<string>"
      ],
      "error_message": "<string>",
      "stopped_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.nx1cloud.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

model
string
required

Query Parameters

type
enum<string> | null
Available options:
batch,
online
status
enum<string> | null
Available options:
pending,
deploying,
active,
failed,
stopped,
archived
domain
string | null
owner
string | null
limit
integer
default:50
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

items
DeploymentResponse · object[]
required
total
integer
required
limit
integer
required
offset
integer
required