Version 2.0

List Live Deployments

GET/api/v2/models/liveDeployments

Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Lists direct live deployments for the specified Model, optionally filtered by branch. Only direct deployments (those tracking the latest model version on a branch) are returned.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:models-read.

Query parameters

modelRid

string

The Resource Identifier (RID) of the Model to list live deployments for.

branch

stringoptional

If provided, only return the live deployment associated with this branch.

preview

booleanoptional

Enables the use of preview functionality.

Response body

ListLiveDeploymentsResponse

object

Hide child attributes

data

list<LiveDeployment>optional

Show child attributes

Examples

Request

Copied!

curl \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/models/liveDeployments?modelRid=ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9&branch=master&preview=true"

Response

Copied!

{
  "data": [
    {
      "runtimeConfiguration": {
        "minReplicas": 1,
        "maxReplicas": 3,
        "cpu": 1,
        "memory": "256MiB",
        "threadCount": 32
      },
      "modelVersion": {
        "modelRid": "ri.models.main.model.f351c142-0e4c-4b12-adc2-6e1539737ae9",
        "modelVersionRid": "ri.models.main.model-version.adf94926-c3ac-41ea-beb2-4946699d08ee"
      },
      "rid": "ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9",
      "branch": "master",
      "status": {
        "state": "ACTIVE",
        "isReady": true
      }
    }
  ]
}

Error responses

Error Name
`ModelNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The given Model could not be found.
	Parameters	`modelRid`

See Errors for a general overview of errors in the platform.