Skip to main content
GET
Requires version 2.0.1 or later of the Archetype platform.

Overview

This endpoint returns one deployment by its dpl_ id. Use it to follow the deployment’s status: sessions can be opened on it only while it is ready.

Request

string
required
Deployment dpl_ id.

Response

Returns the deployment, with the same fields as Create Deployment returns.
string
required
The deployment’s dpl_ id.
string
required
The package deployed.
string
required
What the package is deployed as: batch or serving.
string
required
Where the deployment is in its lifecycle: deploying, ready, stopped, or failed.
string
Why the deployment failed; null otherwise.
object
The session settings stored for a serving deployment: max and idle_timeout_secs. null for a batch deployment. Change them with Update Deployment.

Important Notes

  • A 404 means the deployment does not exist, belongs to another organization, or is in a project you cannot see.