Version 2.0

Start Live Deployment

POST/api/v2/models/liveDeployments/{liveDeploymentRid}/start

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.

Starts the live deployment. If the deployment is already starting or running, this operation has no effect.

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

Path parameters

liveDeploymentRid

string

The Resource Identifier (RID) of a Live Deployment.

Query parameters

preview

booleanoptional

Enables the use of preview functionality.

Examples

Request

Copied!

curl -X POST \
\t-H "Authorization: Bearer $TOKEN" \
	"https://$HOSTNAME/api/v2/models/liveDeployments/ri.foundry-ml-live.main.live-deployment.f351c142-0e4c-4b12-adc2-6e1539737ae9/start?preview=true"

Error responses

Error Name
`LiveDeploymentNotFound`	Error Code	`NOT_FOUND`
	Status Code	404
	Description	The specified live deployment was not found.
	Parameters	`liveDeploymentRid`
`StartLiveDeploymentPermissionDenied`	Error Code	`PERMISSION_DENIED`
	Status Code	403
	Description	Could not start the LiveDeployment.
	Parameters	`liveDeploymentRid`

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