Sign in

v1

latestOpenAPI 3.0.32026-07-22194221292.5 KB
jobs

Update batch job

Updates a batch job's configuration. Changes affect new executions; running executions continue with their original configuration.

put/jobs/{jobId}

Request body

status'DELETING' | 'TERMINATED' | 'FAILED' | 'DEACTIVATED' | 'DEACTIVATING' | 'UPLOADING' | 'BUILDING' | 'DEPLOYING' | 'DEPLOYED' | 'BUILT'

Deployment status of a resource deployed on Blaxel

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,
    "region": "us-was-1",
    "revision": {
      "active": "rev-abc123",
      "canaryPercent": 10,
      "traffic": 100
    },
    "runtime": {
      "diskPercent": 80,
      "envs": [
        {
          "name": "MY_ENV_VAR",
          "secret": true,
          "value": "my-value"
        }
      ],
      "generation": "mk3",
      "maxRetries": 3,
      "memory": 2048,
      "ports": [
        {
          "name": "http",
          "protocol": "HTTP",
          "target": 8080
        }
      ],
      "timeout": 3600
    },
    "triggers": [
      {
        "configuration": {
          "authenticationType": "blaxel",
          "callbackUrl": "https://myapp.com/webhook",
          "path": "/invoke",
          "retry": 3,
          "schedule": "0 * * * *",
          "timeout": 300
        },
        "enabled": true,
        "id": "trigger-1",
        "type": "http"
      }
    ],
    "volumes": [
      {
        "mountPath": "/mnt/data",
        "name": "scratch",
        "sizeMb": 102400,
        "type": "ephemeral"
      }
    ]
  }
}

Response

successful operation

status'DELETING' | 'TERMINATED' | 'FAILED' | 'DEACTIVATED' | 'DEACTIVATING' | 'UPLOADING' | 'BUILDING' | 'DEPLOYING' | 'DEPLOYED' | 'BUILT'

Deployment status of a resource deployed on Blaxel

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,
    "region": "us-was-1",
    "revision": {
      "active": "rev-abc123",
      "canaryPercent": 10,
      "traffic": 100
    },
    "runtime": {
      "diskPercent": 80,
      "envs": [
        {
          "name": "MY_ENV_VAR",
          "secret": true,
          "value": "my-value"
        }
      ],
      "generation": "mk3",
      "maxRetries": 3,
      "memory": 2048,
      "ports": [
        {
          "name": "http",
          "protocol": "HTTP",
          "target": 8080
        }
      ],
      "timeout": 3600
    },
    "triggers": [
      {
        "configuration": {
          "authenticationType": "blaxel",
          "callbackUrl": "https://myapp.com/webhook",
          "path": "/invoke",
          "retry": 3,
          "schedule": "0 * * * *",
          "timeout": 300
        },
        "enabled": true,
        "id": "trigger-1",
        "type": "http"
      }
    ],
    "volumes": [
      {
        "mountPath": "/mnt/data",
        "name": "scratch",
        "sizeMb": 102400,
        "type": "ephemeral"
      }
    ]
  }
}