Skip to main content

REST API

Programmatic access to Rescale. Submit jobs, manage files, control storage devices, administer workspaces, and run workflows.

API reference​

Every operation on one page, grouped by resource. Each endpoint carries a version badge (v2 or v3), so the two surfaces sit side by side under one section rather than in separate microsites.

Coverage:

  • Jobs, Runs, Tasks — create, submit, stop, share, tag, prioritize; inspect runs; snapshot files
  • Files, Folders, Storage Devices — upload, download, organize, attach, terminate, force-shutdown
  • Workflows, Workflow Runs, Workflow Sharing — build DAG-shaped jobs programmatically; submit, poll, stop
  • Budgets, Prices, Projects, Billing — usage controls, project mapping, CSV exports
  • Admin — members, groups, hardware policies, software restrictions, data access

Auto-generated from the OpenAPI spec. Try requests from the browser.

In this section​

Authentication​

How Rescale verifies your requests. Token format, headers, key lifetime, rotation.

Submit your first workflow​

A 10-minute tutorial: define a DAG, submit it, poll until it finishes.

FAQs​

Finding analysis codes and coretype codes, and the fields a job needs.

Elsewhere​

  • Developer overview — generating an API key, regional platform hosts, and your first call.
  • Workflow concepts — Workflow, Workflow run and Node. Under Workflows, because they are product concepts rather than API surface; the object schemas are in the reference above.
  • CLI and MCP server — the other two programmatic entry points.

Base URL​

All v2 requests target https://platform.rescale.com/api/v2/. All v3 requests target https://platform.rescale.com/api/v3/.

Regional deployments use the same paths at a different host: see regional platforms for the full list.

Keep the trailing slash on request paths. A path without it, such as /api/v2/jobs, returns a 301 redirect rather than the resource.

Versioning​

The API is versioned in the URL path. v2 and v3 are both supported, and the reference badges each operation with the version it belongs to. Additive changes, such as new fields or new endpoints, appear in the current version, so clients should ignore keys they do not recognize.

Request and response format​

Requests use JSON. File uploads use multipart/form-data.

List endpoints are paginated and wrap their results:

{
  "count": 6,
  "next": null,
  "previous": null,
  "results": []
}

Follow next until it is null to walk the full set. Prefer server-side filters, which appear as query strings such as GET /api/v2/jobs/?state=not_completed, over paging through everything.

IDs in URLs are opaque short strings, for example RcAFeb. You get them from the response of the resource you just created.

Errors​

Errors return the HTTP status code with a JSON body describing the failure:

{
  "detail": "Authentication credentials were not provided."
}
  • 401 Unauthorized — the API key is missing, malformed, or expired. API key is no longer active means it expired; User inactive or deleted means the owning user was deactivated.
  • 403 Forbidden — the key is valid, but the user lacks permission for that resource.
  • 404 Not Found — covers both nonexistent IDs and resources in workspaces your user cannot see.
  • 400 Bad Request — validation errors on creates and updates. The body carries per-field messages.
  • 5xx — server side. Retry with backoff.