v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB
applications

Update application

Updates an application's configuration and triggers a new deployment. Changes to runtime settings, environment variables, or scaling parameters will be applied on the next deployment.

put/applications/{applicationName}

Request body

nodeGenerationstring

Infrastructure generation this application is deployed on (mk3.0 or mk3.1). Read-only.

statusstring

Application status computed from events

Example request

{
  "events": [
    {
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "metadata": {
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "name": "my-resource"
  },
  "spec": {
    "enabled": true,
    "envs": [
      {
        "name": "MY_ENV_VAR",
        "secret": true,
        "value": "my-value"
      }
    ],
    "image": "my-registry/my-app:latest",
    "memory": 2048,
    "port": 8080,
    "region": "us-pdx-1",
    "revision": {
      "canaryPercent": 10,
      "traffic": 100
    },
    "revisions": [
      {
        "envs": [
          {
            "name": "MY_ENV_VAR",
            "secret": true,
            "value": "my-value"
          }
        ],
        "memory": 2048,
        "port": 8080
      }
    ],
    "urls": [
      {
        "domain": "app.example.com",
        "subdomain": "www"
      }
    ]
  }
}

Response

successful operation

nodeGenerationstring

Infrastructure generation this application is deployed on (mk3.0 or mk3.1). Read-only.

statusstring

Application status computed from events

Example response

{
  "events": [
    {
      "message": "Deployment successful",
      "revision": "rev-abc123",
      "status": "DEPLOYED",
      "time": "2025-01-15T10:30:00Z",
      "type": "deployment"
    }
  ],
  "metadata": {
    "displayName": "My Resource",
    "externalId": "my-session-123",
    "name": "my-resource"
  },
  "spec": {
    "enabled": true,
    "envs": [
      {
        "name": "MY_ENV_VAR",
        "secret": true,
        "value": "my-value"
      }
    ],
    "image": "my-registry/my-app:latest",
    "memory": 2048,
    "port": 8080,
    "region": "us-pdx-1",
    "revision": {
      "canaryPercent": 10,
      "traffic": 100
    },
    "revisions": [
      {
        "envs": [
          {
            "name": "MY_ENV_VAR",
            "secret": true,
            "value": "my-value"
          }
        ],
        "memory": 2048,
        "port": 8080
      }
    ],
    "urls": [
      {
        "domain": "app.example.com",
        "subdomain": "www"
      }
    ]
  }
}