Skip to main content

List Deployments

POST 
/deploy-svc/deployments

Retrieve a list of deployments.

Request​

Body

List Deploys Request

    object

Responses​

OK

Schema

    deployments

    object[]

  • Array [

    • autoScaling

    object

    cpuThreshold integer

    CPU usage threshold for scaling (as a percentage)

    maxReplicas integer

    Maximum number of replicas to run

    minReplicas integer

    Minimum number of replicas to run

    definitionId stringrequired

    DefinitionId is the id of the definition

    description string

    Description of what this deployment does

    details string

    Details provides additional information about the deployment's current state, including both success and failure conditions (e.g., "Deployment in progress", "Error pulling image").

    envars

    object

    Envars is a map of environment variables that will be passed down to service instances (see Registry Svc Instance) Also see the Registry Svc Definition for required envars.

    property name* string
    id stringrequired

    ID of the deployment (e.g., "depl_dbOdi5eLQK")

    name string

    Short name for easy reference (e.g., "user-service-v2")

    replicas integer

    Number of container instances to run

    resources

    object

    cpu string

    CPU limit, e.g., "500m" for 0.5 cores

    memory string

    Memory limit, e.g., "128Mi"

    vram string

    Optional: GPU VRAM requirement, e.g., "48GB"

    status string

    Possible values: [OK, Error, Pending, Failed, Deploying]

    strategy

    object

    maxSurge integer

    Max extra replicas during update

    maxUnavailable integer

    Max unavailable replicas during update

    type string

    Possible values: [RollingUpdate, Recreate]

    Deployment strategy type (RollingUpdate, Recreate, etc.)

    targetRegions

    object[]

    Target deployment regions or clusters

  • Array [

    • cluster string

    Cluster or node where service should be deployed (e.g., "us-west1", "local-docker")

    zone string

    Optional: Specific zone for the deployment

  • ]

  • ]

Loading...