Deploy job manifest

curl -X POST https://api.islo.dev/jobs/name/deploy \
     -H "Authorization: Bearer <api_key>" \
     -H "Content-Type: application/json" \
     -d '{
  "manifest": {
    "job": {
      "name": "data_processor"
    },
    "run": {
      "tasks": [
        {
          "name": "fetch_data",
          "steps": [
            {}
          ]
        }
      ]
    }
  }
}'

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "version_number": 3,
  "content_hash": "a1b2c3d4e5f67890abcdef1234567890abcdef12",
  "deployed_at": "2024-01-15T09:30:00Z",
  "manifest": {
    "job": {
      "name": "data_processor",
      "version": "v1.2.0",
      "description": "Job to process incoming data streams and generate reports",
      "params": {}
    },
    "run": {
      "tasks": [
        {
          "name": "fetch_data",
          "steps": [
            {
              "name": "download_data",
              "workdir": "/fetch",
              "timeout": 300,
              "user": "fetcher",
              "exec": [
                "curl",
                "-o",
                "data.json",
                "https://data.example.com/api/latest"
              ],
              "snapshot": {
                "name": "post-download"
              },
              "pause": false,
              "resume": false,
              "delete": false,
              "upload": "/fetch/data.json",
              "download": "/fetch/data.json"
            }
          ],
          "sandbox": {
            "mode": "provision",
            "name": "fetch-sandbox",
            "image": "alpine:latest",
            "vcpus": 2,
            "memory_mb": 2048,
            "disk_gb": 10,
            "snapshot_name": "fetch-snapshot",
            "gateway_profile": "standard",
            "init": {
              "type": "minimal"
            },
            "internet_enabled": true,
            "workdir": "/fetch",
            "cache_key": "fetch-cache-v1",
            "env": {},
            "sources": [
              {
                "repo_url": "https://github.com/example/data-fetch.git",
                "branch": "develop",
                "target_path": "/fetch"
              }
            ],
            "setup_scripts": [
              {
                "script": "apk add --no-cache curl",
                "name": "setup_fetch"
              }
            ],
            "lifecycle": {
              "auto_resume": "never",
              "delete_after": 86400,
              "pause_after": 3600,
              "pause_after_idle": 1800
            }
          }
        }
      ],
      "fail_fast": true,
      "fanout": false,
      "concurrency": 1,
      "workdir": ".",
      "timeout": "30m",
      "region": "us-west-2",
      "teardown_on_complete": true,
      "resume_on_start": true,
      "sandbox": {
        "mode": "provision",
        "name": "default-sandbox",
        "image": "python:3.10-slim",
        "vcpus": 2,
        "memory_mb": 2048,
        "disk_gb": 10,
        "snapshot_name": "base-snapshot",
        "gateway_profile": "standard",
        "init": {
          "type": "minimal"
        },
        "internet_enabled": true,
        "workdir": "/app",
        "cache_key": "cache-v1",
        "env": {},
        "sources": [
          {
            "repo_url": "https://github.com/example/data-processor.git",
            "branch": "main",
            "target_path": "/app"
          }
        ],
        "setup_scripts": [
          {
            "script": "pip install -r requirements.txt",
            "name": "install_dependencies"
          }
        ],
        "lifecycle": {
          "auto_resume": "never",
          "delete_after": 86400,
          "pause_after": 3600,
          "pause_after_idle": 1800
        }
      }
    },
    "schedule": {
      "cron": "0 2 * * *",
      "timezone": "UTC",
      "enabled": true
    },
    "verification": {
      "enabled": false,
      "gate": {
        "compare_to": "previous_version",
        "min_pass_rate": 0.5
      }
    }
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

namestringRequired

Request

This endpoint expects an object.

manifestobjectRequired

Job manifest (authored as TOML or JSON, stored as JSON)

Response

Successful Response

idstringformat: "uuid"

version_numberinteger

content_hashstring

deployed_atdatetime

manifestobject

Full job.toml manifest (TOML or JSON authoring; stored as JSON).

Errors

401

Unauthorized Error

422

Unprocessable Entity Error

502

Bad Gateway Error

503

Service Unavailable Error