List batch jobs

Returns all batch job definitions in the workspace. Each job can be triggered to run multiple parallel tasks with configurable concurrency and retry settings.

GET /jobs

List batch jobs

cURL

curl --request GET \
  --url https://api.blaxel.ai/v0/jobs \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "metadata": {
      "name": "my-resource",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdBy": "<string>",
      "updatedBy": "<string>",
      "displayName": "My Resource",
      "labels": {},
      "plan": "<string>",
      "url": "<string>",
      "workspace": "<string>"
    },
    "spec": {
      "enabled": true,
      "githubRunner": {
        "repositories": "[\"my-org/repo-a\", \"my-org/repo-b\"]"
      },
      "policies": [
        "<string>"
      ],
      "region": "us-was-1",
      "revision": {
        "active": "rev-abc123",
        "canary": "<string>",
        "canaryPercent": 10,
        "stickySessionTtl": 0,
        "traffic": 100
      },
      "runtime": {
        "diskPercent": 80,
        "envs": [
          {
            "name": "MY_ENV_VAR",
            "secret": true,
            "value": "my-value"
          }
        ],
        "generation": "mk3",
        "image": "<string>",
        "maxConcurrentTasks": 10,
        "maxRetries": 3,
        "memory": 2048,
        "ports": [
          {
            "target": 8080,
            "name": "http",
            "protocol": "HTTP"
          }
        ],
        "timeout": 3600
      },
      "triggers": [
        {
          "configuration": {
            "authenticationType": "blaxel",
            "callbackSecret": "<string>",
            "callbackUrl": "https://myapp.com/webhook",
            "path": "/invoke",
            "retry": 3,
            "schedule": "0 * * * *",
            "tasks": [
              {}
            ],
            "timeout": 300
          },
          "enabled": true,
          "id": "trigger-1",
          "type": "http"
        }
      ],
      "volumes": [
        {
          "mountPath": "/mnt/data",
          "name": "scratch",
          "sizeMb": 102400,
          "type": "ephemeral",
          "readOnly": false
        }
      ]
    },
    "events": [
      {
        "canaryRevision": "<string>",
        "message": "Deployment successful",
        "revision": "rev-abc123",
        "status": "DEPLOYED",
        "time": "2025-01-15T10:30:00Z",
        "type": "deployment"
      }
    ]
  }
]

Authorizations

OAuth2ApiKeyAuth

Authorization · string · header · required

OAuth2 authentication with JWT tokens

Response

200 - application/json

successful operation

metadata · object · required

Common metadata fields shared by all Blaxel resources including name, labels, timestamps, and ownership information

Show child attributes

spec · object · required

Configuration for a batch job including execution parameters, parallelism settings, and deployment region

Show child attributes

events · object[] · read-only

Events happening on a resource deployed on Blaxel

Show child attributes

status · enum<string> · read-only

Deployment status of a resource deployed on Blaxel

Available options: DELETING, TERMINATED, FAILED, DEACTIVATED, DEACTIVATING, UPLOADING, BUILDING, DEPLOYING, DEPLOYED, BUILT