Zum Hauptinhalt springen
Back to Docs main
API docs by Redocly

Rescale REST API (2026.08)

Download OpenAPI specification:Download

Rescale Support: support@rescale.com

The Rescale REST API, consolidated. Covers the v2 surface (jobs, runs, files, storage devices, budgets, projects, workspace administration) alongside the v3 surface (folders, pending queue, cluster tasks, billing CSV, force-shutdown, and workflows).

Every operation carries a version badge — v2 or v3 — next to its name in the left panel. Endpoints from the two versions live side by side under one resource section, so you can find an endpoint by what it does rather than which version it belongs to.

Authentication

Requests carry an API token in the Authorization header. Create one under Preferences > API; the platform shows the value once, so copy it then. A token inherits the permissions of the user that created it.

TokenAuth

Use the format Token <api-token>.

Security Scheme Type: API Key
Header parameter name: Authorization

apiKeyAuth

API key authentication. Enter the full value including the prefix: Token <api-key> (e.g., Token abc123def456)

Security Scheme Type: API Key
Header parameter name: Authorization

bearerAuth

JWT access token (PS256, 30-minute lifetime)

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer
Bearer format: JWT

sessionAuth

Session cookie authentication. Requires CSRF token in X-CSRFToken header.

Security Scheme Type: API Key
Cookie parameter name: sessionid

Base URL

Requests target one of the production hosts below on /api/v2/ or /api/v3/:

Region Host
United States (commercial) https://platform.rescale.com
Europe https://eu.rescale.com
Japan https://platform.rescale.jp
Korea https://kr.rescale.com
ITAR https://itar.rescale.com
FedRAMP https://itar.rescale-gov.com

Keep the trailing slash on v2 paths. /api/v2/jobs/ is correct, /api/v2/jobs is not.

Versioning

The API is versioned in the URL path. v2 and v3 run side by side; v1 is legacy. Breaking changes ship as a new major version. Additive changes (new fields, new endpoints) appear in the current version without notice, so parse defensively and ignore fields you do not recognize.

Resources

Coretypes v2

This endpoint lists informations on all coretypes available in the Rescale API. The code property can be used in subsequent requests to submit jobs.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/coretypes/

Response samples

Content type
application/json
{
  • "count": 14,
  • "previous": null,
  • "results": [
    ],
  • "next": "https://platform.rescale.com/api/v2/coretypes?page=2"
}

Analyses v2

This endpoint lists all the software available to your user on Rescale.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/analyses/

Response samples

Content type
application/json
{
  • "count": 88,
  • "previous": null,
  • "results": [
    ],
  • "next": "https://platform.rescale.com/api/v2/analyses/?page=2"
}

Jobs

List All Jobs v2

By default this endpoint retrieves all the jobs owned by the authenticated user (you). To see shared jobs, use the f query parameter (see below).

Authorizations:
TokenAuth
query Parameters
job_status
string

Filter out the jobs based on the exact status.

state
string

Filters out the jobs based on complete and other non-complete status.

f
string

Filters out the jobs based on the visibility level (where f=0 is all jobs, f=1 is owned jobs [DEFAULT], and f=2 is shared jobs).

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/jobs/

# filtering
curl -H "Authorization: token <api-token>" https://platform.rescale.com/api/v2/jobs/ \
--get --data-urlencode "q=#tag or project:myproject"

Response samples

Content type
application/json
{
  • "count": 3,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

Create a Job v2

Creates and saves a job, DOES NOT start job, see submit below.

Authorizations:
TokenAuth
Request Body schema: application/json
required
archiveFilters
Array of any
billingPriorityValue
null
caseFile
null
expectedRuns
null
id
string
includeNominalRun
boolean
isLowPriority
boolean
isTemplateDryRun
boolean
Array of objects
jobvariables
Array of any
monteCarloIterations
null
name
string
optimizer
null
owner
string
paramFile
null
remoteVizConfig
null
resourceFilters
Array of any

Responses

Request samples

Content type
application/json
{
  • "archiveFilters": [ ],
  • "billingPriorityValue": null,
  • "caseFile": null,
  • "expectedRuns": null,
  • "id": "LeeKa",
  • "includeNominalRun": false,
  • "isLowPriority": false,
  • "isTemplateDryRun": false,
  • "jobanalyses": [
    ],
  • "jobvariables": [ ],
  • "monteCarloIterations": null,
  • "name": "Jobbo",
  • "optimizer": null,
  • "owner": "mark@rescale.com",
  • "paramFile": null,
  • "remoteVizConfig": null,
  • "resourceFilters": [ ]
}

Response samples

Content type
application/json
{
  • "archiveFilters": [ ],
  • "billingPriorityValue": null,
  • "caseFile": null,
  • "expectedRuns": null,
  • "id": "LeeKa",
  • "includeNominalRun": false,
  • "isLowPriority": false,
  • "isTemplateDryRun": false,
  • "jobanalyses": [
    ],
  • "jobvariables": [ ],
  • "monteCarloIterations": null,
  • "name": "Jobbo",
  • "optimizer": null,
  • "owner": "mark@rescale.com",
  • "paramFile": null,
  • "remoteVizConfig": null,
  • "resourceFilters": [ ]
}

Delete Multiple Jobs v2

You can delete multiple jobs at once by passing a list of job ids to the body of the HTTP request.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' -H 'Content-Type: application/json' https://platform.rescale.com/api/v2/jobs/ -X DELETE

Get a Specific Job v2

Retrieve the details of a saved job.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/jobs/aabbcc/

Response samples

Content type
application/json
{ }

Delete a Job v2

Note that jobs that are currently executing cannot be deleted. You will need to stop the job first.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' -H 'Content-Type: application/json' https://platform.rescale.com/api/v2/jobs/gVWWdb/ -X DELETE

List Job Output Files v2

List output files for a given job

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/jobs/aabbcc/files/

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

Submit a Saved Job v2

Submits a saved job to run. No data returned.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/jobs/LeeKa/submit/ -X POST

Update a Job v2

PATCH https://platform.rescale.com/api/v2/jobs/{job_id}

Authorizations:
TokenAuth
path Parameters
job_id
required
string
Request Body schema: application/json
required
id
string
isLowPriority
boolean
name
string

Responses

Request samples

Content type
application/json
{
  • "id": "LeeKa",
  • "isLowPriority": false,
  • "name": "Jobster"
}

Stop a Job v2

Submits a request to stop a running job. Poll the job/cluster status endpoints to monitor the exact time when the job is stopped.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' -H 'Content-Type: application/json' https://platform.rescale.com/api/v2/jobs/SsdkT/stop/ -X POST

Share a Job v2

Share a job with another user. If your user is associated with an organization, you will only be allowed to share your job with another user in your organization or an ISV support desk.

Authorizations:
TokenAuth
path Parameters
job_id
required
string
Request Body schema: application/json
required
recipient
string
supportDesk
null

Responses

Request samples

Content type
application/json
{
  • "recipient": "support@rescale.com",
  • "supportDesk": null
}

List Job status history v2

Property Type Description
status String A job status code
statusDate Date ISO8601 encoded date of when the job status changed
statusReason String (Optional) Extra context for the status. Eg, a failure reason
Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' -H 'Content-Type: application/json' https://platform.rescale.com/api/v2/jobs/cHDtgb/statuses/

Response samples

Content type
application/json
{
  • "count": 6,
  • "previous": null,
  • "results": [
    ],
  • "next": null
}

List Cluster Status History for a Job v2

Property Type Description
status String A cluster status code
statusDate Date ISO8601 encoded date of when the cluster status changed
statusReason String (Optional) Extra context for the status. Eg, a failure reason
Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' -H 'Content-Type: application/json' https://platform.rescale.com/api/v2/jobs/cHDtgb/cluster_statuses/

Response samples

Content type
application/json
{
  • "count": 6,
  • "previous": null,
  • "results": [
    ]
}

List Job extended logs v2

Gets extended logs for a job. Extended logs are the combination of the user logs seen on a job and the statuses of a job. The job statuses are reformatted to match the log format and sorted by date along with the logs.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' -H 'Content-Type: application/json' https://platform.rescale.com/api/v2/jobs/cHDtgb/extendedlogs/

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

List Custom Fields in Your Workspace v2

Get the current list of custom fields that apply to compute and workstation jobs in your workspace:

Authorizations:
TokenAuth
path Parameters
company_code
required
string
workspace_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' https://platform.rescale.com/api/v2/organizations/rescale/workspaces/03-066880176/custom-fields/

Response samples

Content type
application/json
{
  • "fields": {
    },
  • "isEnabled": true
}

Assign Custom Fields to a Job v2

Custom fields can be assigned to a single job, allowing users to create additional custom fields specific to that job. The shape of the request is documented below in the request properties section

Authorizations:
TokenAuth
path Parameters
job_id
required
string
Request Body schema: application/json
required
object
Array of objects
Array of objects
Array of objects

Responses

Request samples

Content type
application/json
{
  • "fields": {
    }
}

List Custom Fields on a Job v2

Custom fields that are defined on a job are included as part of the response to the "Get a Specific Job" endpoint above.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' https://platform.rescale.com/api/v2/jobs/cHDtgb/custom-fields/

Response samples

Content type
application/json
{
  • "job field (string, set)": {
    },
  • "workspace (numeric array, set)": {
    },
  • "job field (string, unset)": {
    },
  • "workspace (numeric array, unset)": {
    }
}

Submit Custom Fields on a Job v2

Attach values for custom fields on a saved job. Fields that are required must be submitted before the job is run and cannot be changed after. Optional fields may be added or amended at any time.

Authorizations:
TokenAuth
path Parameters
job_id
required
string
Request Body schema: application/json
required
object
object
user
string
value
string

Responses

Request samples

Content type
application/json
{
  • "Study": {
    }
}

Add a Tag to a Job v2

Add a new or existing tag to a job.

Authorizations:
TokenAuth
path Parameters
job_id
required
string
Request Body schema: application/json
required
name
string
normalizedName
string

Responses

Request samples

Content type
application/json
{
  • "name": "new - tag _ 1",
  • "normalizedName": "newtag1"
}

Get a list of Tags on a Job v2

Property Type Description
name String The displayed name of the tag
normalizedName String The name of the tag with spaces, dashes, and underscores removed
Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/jobs/{job_id}/tags/" -X GET

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Remove a Tag from a Job v2

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/jobs/{job_id}/tags/" -X DELETE -d '
{
    "name": "new - tag _ 1"
}
'

List Job Instances v2

List VM instances for a given job. Note that some of the fields are for internal use, and thus undocumented.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/jobs/{job_id}/instances/"

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

List All Jobs in a Project v2

This endpoint retrieves all the jobs visible to the authenticated user associated with the specified projectId

Authorizations:
TokenAuth
path Parameters
organization
required
string
projectId
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/organizations/{organization}/projects/{projectId}/jobs/

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

List Project Job is Assigned To v2

List the project ID of the project that a job is assigned to.

Authorizations:
TokenAuth
path Parameters
organization
required
string
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/organizations/{organization}/jobs/{job_id}/project-assignment/"

Response samples

Content type
application/json
{
  • "projectId": "duOxgb"
}

Update Project Job is Assigned To v2

Update the project ID of the project that a job is assigned to.

Authorizations:
TokenAuth
path Parameters
organization
required
string
job_id
required
string
Request Body schema: application/json
required
projectId
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "duOxgb"
}

Update Job Position in Priority Queue v2

Update the position of a job in the priority queue. The number passed in will be the new priority value for the job in the priority queue. The lowest value (highest priority) is 0.

Authorizations:
TokenAuth
path Parameters
organization
required
string
Request Body schema: application/json
required
externalId
string
object
isBarrier
boolean
datePrioritized
string <date-time>
priority
integer

Responses

Request samples

Content type
application/json
{
  • "externalId": "SngSn",
  • "job": {
    },
  • "isBarrier": false,
  • "datePrioritized": "2025-02-24T21:46:54.611890Z",
  • "priority": 0
}

Get Pending Job Priority Queue (Project) v3

View the Pending Job Priority Queue. This Queue is specific to a project. The lowest value (highest priority) is 0 and as the priority number increases, the lower in the priority queue the job is sitting (will be run later). This queue can be modified from the UI or by using the PATCH endpoint detailed below. The externalId of the project and job must be used for these endpoints.

Authorizations:
TokenAuth
path Parameters
organization
required
string
projectId
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v3/organizations/{organization}/projects/{projectId}/pending-queue/" -X GET

Response samples

Content type
application/json
{
  • "count": 2,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

Update Job Position in Pending Job Priority Queue (Project) v3

Update the position of a job in the Pending Job Priority Queue. This Queue is specific to a project. The entire project Queue can be seen in the UI or using the GET endpoint descirbed above. The externalId of the project and job must be used for this endpoint. The number passed in will be the new priority value for the job in the priority queue. The lowest value (highest priority) is 0.

Authorizations:
TokenAuth
path Parameters
organization
required
string
projectId
required
string
jobId
required
string
Request Body schema: application/json
required
externalId
string
object
isBarrier
boolean
datePrioritized
string <date-time>
priority
integer

Responses

Request samples

Content type
application/json
{
  • "externalId": "SngSn",
  • "job": {
    },
  • "isBarrier": false,
  • "datePrioritized": "2025-02-24T21:46:54.611890Z",
  • "priority": 0
}

Runs

List Runs for a Job v2

This call allows you to retrieve the first page of runs associated with job-id.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/jobs/XXXXXX/runs/

Response samples

Content type
application/json
{
  • "count": 121,
  • "next": "https://platform.rescale.com/api/v2/jobs/XXXXXX/runs/?page=2",
  • "previous": null,
  • "results": [
    ]
}

Get a Run v2

Property Type Description
dateCompleted String The ISO8601 encoded date of when the run finished.
dateInserted String The ISO8601 encoded date of when the run started.
displayOrder Integer Used for sorting a collection of runs into their canonical order.
id String The unique identifier of the run within a job.
isOptimal Boolean True if the optimizer or analysis code has designated this as a run of interest.
outputFileCount Integer The number of output files associated with this run
outputFileSize Integer The total size in bytes of all output files associated with this run
parent String The identifier of the parent run.
type Integer 1 = Optimization, 2 = Iteration, 3 = Case
variables List<Variable> See below
Authorizations:
TokenAuth
path Parameters
job_id
required
string
run_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/jobs/XXXXXX/runs/1/

Response samples

Content type
application/json
{
  • "dateCompleted": "2015-02-18T03:09:14.667000Z",
  • "dateStarted": "2015-02-18T03:08:49.117000Z",
  • "displayOrder": 1,
  • "id": "1",
  • "isOptimal": false,
  • "outputFileCount": 66,
  • "outputFileSize": 8018226,
  • "parent": null,
  • "type": 3,
  • "variables": [
    ]
}

Stop a Run v2

Stops an in-progress run. The workflow processes will be killed and any available output files will be uploaded to Rescale Cloud Storage.

Authorizations:
TokenAuth
path Parameters
job_id
required
string
run_id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

List Output Files v2

This call allows you to fetch the metadata regarding all the files associated with run-id. You can then use the file-id to download each individual file.

Authorizations:
TokenAuth
path Parameters
job_id
required
string
run_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/jobs/XXXXX/runs/1/files/

Response samples

Content type
application/json
{
  • "count": 63,
  • "previous": null,
  • "results": [
    ],
  • "next": "https://platform.rescale.com/api/v2/jobs/XXXXX/runs/1/files/?page=2"
}

List Directory Contents v2

Property Type Description
path String The relative path to a file in the run's working directory
resource String The API url that can be used to retrieve the file's contents
Authorizations:
TokenAuth
path Parameters
job_id
required
string
run_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/jobs/XXXXX/runs/1/directory-contents/

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]

Tail File Content v2

Field Default Required Description
lines None No The number of lines to retrieve from the specified file. If omitted, the raw binary contents of the file will be returned in the response.
Authorizations:
TokenAuth
path Parameters
job_id
required
string
run_id
required
string
path
required
string

Responses

Request samples 

curl -v -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/jobs/XXXXX/runs/1/tail/airFoil2D/0/U?lines=100

Response samples

Content type
application/json
{
  • "fileType": "/home/job_fNjea/work/airFoil2D/0/U: ASCII English text",
  • "lines": [
    ]
}

Files

List all Files v2

This call allows you to retrieve the first page of files owned by the current user.

Authorizations:
TokenAuth

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/files/

Response samples

Content type
application/json
{
  • "count": 365,
  • "previous": null,
  • "results": [
    ],
  • "next": "https://platform.rescale.com/api/v2/files/?page=2"
}

Delete a File v2

This call allows you to delete a file from Rescale.

Authorizations:
TokenAuth
path Parameters
file_id
required
string

Responses

Request samples 

curl -X DELETE -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/files/{file_id}/

Get Metadata of a File v2

Property Type Description
typeId Integer 1 = inpute file, 2 = template file, 3 = parameter file, 4 = script file, 5 = output file, 7 = design variable file, 8 = case file, 9 = optimizer file, 10 = temporary file
name String The name of the file.
dateUploaded String The ISO8601 encoded date of when the file is uploaded.
relativePath String For output files (typeId = 5), the relative path is the path relative to the root output folder(user/{user_id}/output/{job_id}/{run_id}/{relative_path}).
encodedEncryptionKey String The key used to encrypt the files.
downloadUrl String The download URL of the file.
sharedWith List<String> A list of users of the file shared with.
decryptedSize Integer The decrypted file size in byte.
owner String The owner of the file.
path String The absolute path of the file being stored.
isUploaded Boolean If the file is already uploaded.
viewInBrowser Boolean If the file can be viewed in browser.
id String The unique identifier of the file.
isDelelted Boolean If the file is already deleted.
md5 String The md5 hash of the file.
Authorizations:
TokenAuth
path Parameters
file_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/files/{file_id}/

Response samples

Content type
application/json
{
  • "typeId": 1,
  • "name": "Crash_input.pc.gz",
  • "dateUploaded": "2015-03-12T17:56:20.925043-07:00",
  • "relativePath": "Crash_input.pc.gz",
  • "encodedEncryptionKey": "LkkPk2L2mwuc4OibUs3kJe2RIQrzXbfdWXp9xJhoX0s=",
  • "downloadUrl": "https://platform.rescale.com/api/v2/files/WvNKdb/contents/",
  • "sharedWith": [ ],
  • "decryptedSize": 56425931,
  • "owner": "demouser@rescale.com",
  • "path": "user/user_OvdRk/Crash_input.pc.gz-0a87694a180172023d8a37f0c8aac965",
  • "isUploaded": true,
  • "viewInBrowser": false,
  • "id": "WvNKdb",
  • "isDeleted": false,
  • "md5": "a3bc423552cf5457b2fcf4fad87e451d",
  • "userTags": [
    ]
}

Update Metadata of a File v2

Same as Get Metadata of a File

Authorizations:
TokenAuth
path Parameters
file_id
required
string
Request Body schema: application/json
required
typeId
integer
name
string
dateUploaded
string <date-time>
relativePath
string
encodedEncryptionKey
string
downloadUrl
string <uri>
sharedWith
Array of any
decryptedSize
integer
owner
string
path
string
isUploaded
boolean
viewInBrowser
boolean
id
string
isDeleted
boolean
md5
string

Responses

Request samples

Content type
application/json
{
  • "typeId": 4,
  • "name": "new_script.txt",
  • "dateUploaded": "2015-03-17T00:24:39.531384Z",
  • "relativePath": "new_script.txt",
  • "encodedEncryptionKey": "83TFwNf5QxFaCOmluBQBnJ/L0yAC/2Z9MPs2pKZuUi4=",
  • "downloadUrl": "https://platform.rescale.com/api/files/dNEXtf/contents/",
  • "sharedWith": [ ],
  • "decryptedSize": 112,
  • "owner": "demouser@rescale.com",
  • "path": "user/user_OvdRk/testLines-9425c8a5-08a6-4249-939a-2f060a4d0f25.txt",
  • "isUploaded": true,
  • "viewInBrowser": true,
  • "id": "dNEXtf",
  • "isDeleted": false,
  • "md5": "4d479b49d26318068d3e23aa9d81e9ee"
}

Download a File v2

Important: Rescale Files API is designed to upload and download files no larger than 5 GB. For any file larger than that, we offer the Rescale CLI, Rescale Transfer Manager and Enhanced Uploads via our Platform Web. These tools also benefit from parallel downloads and could make transfers faster.

Authorizations:
TokenAuth
path Parameters
file_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
-o 'download_file.txt' https://platform.rescale.com/api/v2/files/{file_id}/contents/

Get Plaintext Content of a File v2

Important: Rescale Files API is designed to upload and download files no larger than 5 GB. For any file larger than that, we offer the Rescale CLI, Rescale Transfer Manager and Enhanced Uploads via our Platform Web. These tools also benefit from parallel downloads and could make transfers faster.

Authorizations:
TokenAuth
path Parameters
file_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v2/files/{file_id}/lines/

Response samples

Content type
application/json
{
  • "lines": [
    ]
}

Add a Tag to a File v2

Add a new or existing tag to a file.

Authorizations:
TokenAuth
path Parameters
file_id
required
string
Request Body schema: application/json
required
name
string
normalizedName
string

Responses

Request samples

Content type
application/json
{
  • "name": "new - tag _ 1",
  • "normalizedName": "newtag1"
}

Get a list of Tags on a File v2

Property Type Description
name String The displayed name of the tag
normalizedName String The name of the tag with spaces, dashes, and underscores removed
Authorizations:
TokenAuth
path Parameters
file_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/files/{file_id}/tags/" -X GET

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Remove a Tag from a File v2

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/files/{file_id}/tags/" -X DELETE -d '
{
    "name": "new - tag _ 1"
}
'

Tasks

Poll a Running Task v2

Authorizations:
TokenAuth
path Parameters
token
required
string

Responses

Storage Devices

List All Storage Devices v2

This endpoint retrieves all the storage devices visible to the authenticated user, whether they are owned by, or shared with, that user.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/

Response samples

Content type
application/json
{
  • "count": 3,
  • "previous": null,
  • "results": [
    ],
  • "next": null
}

Get a Specific Storage Device v2

Retrieve the details of a saved storage device.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/rCTMk/

Response samples

Content type
application/json
{
  • "dateInserted": "2018-12-11T15:12:11.154340-08:00",
  • "name": "Sample Storage Three",
  • "autoextend": false,
  • "region": {
    },
  • "hardware": {
    },
  • "owner": "support@rescale.com",
  • "secondAlert": 90,
  • "urls": {},
  • "storageSize": 1024,
  • "absoluteMountPoint": "~/storage_rCTMk",
  • "availableSpace": 0,
  • "id": "rCTMk",
  • "firstAlert": 60,
  • "sshConnection": null
}

Update a Storage Device v2

Updates editable details for a saved storage device.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>"  -H "Content-Type:application/json" "https://platform.rescale.com/api/v2/storage-devices/GnHtk/" -X PATCH -d '
{
    "name": "Storagey McStorageFace"
}
'

List Storage Device Statuses v2

This endpoint returns an ordered list of available storage device statuses. The first returned status is always the storage device's latest (current) status.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/rCTMk/statuses/

Response samples

Content type
application/json
{
  • "count": 3,
  • "previous": null,
  • "results": [
    ],
  • "next": null
}

List Storage Device Files v2

List files and directories for a given storage device.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string
path
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/rCTMk/files/

Response samples

Content type
application/json
{
  • "count": 4,
  • "nextUrl": null,
  • "results": [
    ]
}

List Available Regions v2

This endpoint returns a list of regions available to create a storage device.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/available-regions/

Response samples

Content type
application/json
[
  • {
    }
]

Submit a Storage Device v2

Submits and starts a saved storage device.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/GnHtk/submit/ -X POST

Terminate a Storage Device v2

Sends a request to backup files and terminate a started storage device.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/storage-devices/GnHtk/shutdown/ -X POST

Attach a Storage Device to a Job v2

Attaches a started storage device to a saved job. Optionally, stages files/directories from the storage device to the job's work directory.

Authorizations:
TokenAuth
path Parameters
job_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>"  -H "Content-Type:application/json" "https://platform.rescale.com/api/v2/jobs/LeeKa/storage-devices/" -X POST -d '
{
    "storageDevice": { "id": "GnHtk" }
}
'

List All Storage Devices in a Project v2

This endpoint retrieves all the storage-devices visible to the authenticated user associated with the specified projectId

Authorizations:
TokenAuth
path Parameters
organization
required
string
projectId
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/organizations/{organization}/projects/{projectId}/storage-devices/"

Response samples

Content type
application/json
{
  • "count": 1,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

List Project Storage Device is Assigned To v2

List the project ID of the project that a storage device is assigned to.

Authorizations:
TokenAuth
path Parameters
organization
required
string
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v2/organizations/{organization}/storage-devices/{storage_device_id}/project-assignment/"

Response samples

Content type
application/json
{
  • "projectId": "duOxgb"
}

Update Project Storage Device is Assigned To v2

Update the project ID of the project that a storage device is assigned to.

Authorizations:
TokenAuth
path Parameters
organization
required
string
job_id
required
string
Request Body schema: application/json
required
projectId
string

Responses

Request samples

Content type
application/json
{
  • "projectId": "duOxgb"
}

Create a Storage Device v3

Creates and saves the storage device and its details.

Authorizations:
TokenAuth
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Forcefully Terminate a Storage Device v3

Sends a request to forcefully shutdown a started storage device: files will NOT be backed up and any jobs attached to the storage device may not complete successfully. Any data on the storage device will be lost and unrecoverable. Use with caution.

Authorizations:
TokenAuth
path Parameters
storage_device_id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v3/storage-devices/GnHtk/force-shutdown/ -X POST

Prices

List All Compute Prices v2

This endpoint retrieves all the compute prices available to the user. A valid API token is required to make a successful request.

Authorizations:
TokenAuth

Responses

Request samples 

import requests

requests.get(
  'https://platform.rescale.com/api/v2/billing/computeprices/',
  headers={'Authorization': 'Token <api-token>'}
)

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Projects

List projects available to your user v2

This endpoint lists all projects available to the current user. The available projects are those associated with the groups you are a member of, which in turn is configured by your organization or workspace administrator. A valid API token is required to make a successful request.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/users/me/projects/

Response samples

Content type
application/json
{
  • "count": 2,
  • "next": null,
  • "previous": null,
  • "results": [
    ]
}

List projects available to a workspace v2

This endpoint lists all projects available to the designated workspace. The response includes which groups are assigned to the project (if any), whether the project is the default in the workspace, the number of jobs and storage devices related to the project, and whether auto-share behavior is enabled for users in the project.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' https://platform.rescale.com/api/v2/organizations/rescale/workspaces/00-046880176/projects/

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create a project v2

Add a new project in the given workspace, and return a description of the new project.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string
Request Body schema: application/json
required
autoShareJobs
boolean
groups
Array of any
id
string
jobCount
integer
storageDeviceCount
integer
name
string
maxConcurrentCores
integer
isDefault
boolean
workspaceId
string

Responses

Request samples

Content type
application/json
{
  • "autoShareJobs": false,
  • "groups": [ ],
  • "id": "pkaaa",
  • "jobCount": 0,
  • "storageDeviceCount": 0,
  • "name": "New project",
  • "maxConcurrentCores": 42,
  • "isDefault": false,
  • "workspaceId": "00-046880176"
}

Get a specific project v2

Retrieve information about the given project, including which groups are assigned to the project, if any, whether the project is the default in the workspace, the number of jobs and storage devices related to the project, and whether auto-share behavior is enabled for users in the project.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string
project_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' https://platform.rescale.com/api/v2/organizations/rescale/workspaces/00-046880176/projects/pCTMk/

Response samples

Content type
application/json
{
  • "autoShareJobs": false,
  • "groups": [
    ],
  • "id": "pCTMk",
  • "jobCount": 1,
  • "storageDeviceCount": 0,
  • "name": "Test project",
  • "maxConcurrentCores": 42,
  • "isDefault": true,
  • "workspaceId": "00-046880176"
}

Update a project v2

Change the settings for a given project, and return a description of the updated project.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string
project_id
required
string
Request Body schema: application/json
required
autoShareJobs
boolean
groups
Array of any
id
string
jobCount
integer
storageDeviceCount
integer
name
string
maxConcurrentCores
null
isDefault
boolean
workspaceId
string

Responses

Request samples

Content type
application/json
{
  • "autoShareJobs": false,
  • "groups": [ ],
  • "id": "pkaaa",
  • "jobCount": 0,
  • "storageDeviceCount": 0,
  • "name": "Updated project name",
  • "maxConcurrentCores": null,
  • "isDefault": false,
  • "workspaceId": "00-046880176"
}

Delete a project v2

Remove a project in the workspace.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string
project_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' https://platform.rescale.com/api/v2/organizations/rescale/workspaces/00-046880176/projects/pCTMk/ -X DELETE

Assign a group to a project v2

Associate the given group and project, allowing group members to create jobs under the project.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string
project_id
required
string
Request Body schema: application/json
required
groupId
string
groupName
string
projectId
string
priorityQueueManagement
boolean

Responses

Request samples

Content type
application/json
{
  • "groupId": "pkaaa",
  • "groupName": "A group",
  • "projectId": "pCTMk",
  • "priorityQueueManagement": false
}

Remove a group from a project v2

Remove the association between a group and a project. Users in the group will no longer be able to submit jobs to the project, unless they are members of another group that still has an association.

Authorizations:
TokenAuth
path Parameters
organization_code
required
string
workspace_id
required
string
project_id
required
string
group_id
required
string

Responses

Request samples 

curl -H 'Authorization: Token <api-token>' https://platform.rescale.com/api/v2/organizations/rescale/workspaces/00-046880176/projects/pCTMk/groups/pkaaa/ -X DELETE

Data Access

List All Jobs Metadata v2

Beta API endpoints may change without notice, and this document may not reflect their current behavior.

Authorizations:
TokenAuth
query Parameters
fields
string

Comma-separated list of fields to include in response.

createdBefore
string

Filter for resources created before this timestamp.

createdAfter
string

Filter for resources created after this timestamp.

limit
integer

Limits the number of records returned.

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/data/jobs/

Response samples

Content type
application/json
{
  • "count": 9,
  • "next": "https://platform.rescale.com/api/v2/data/jobs/?createdAfter=2024-11-13&createdBefore=2024-11-15&limit=2&offset=2",
  • "previous": null,
  • "results": [
    ]
}

List Jobs metadata Fields v2

Beta API endpoints may change without notice, and this document may not reflect their current behavior.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/data/jobs/fields

Response samples

Content type
application/json
{
  • "fields": [
    ]
}

Members

List All Workspace Members v2

This endpoint retrieves all users in the specified workspace.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/organizations/<organization-code>/workspaces/<workspace-id>/members/

Response samples

Content type
application/json
[
  • {
    }
]

Invite Members to a Workspace v2

Creates a record and sends an invite to the specified member emails to join the organization.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
Request Body schema: application/json
required
Array
email
string
fullName
string
dateInvited
string <date-time>
status
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Groups

List Groups v2

This endpoint retrieves all groups in the specified workspace.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" https://platform.rescale.com/api/v2/organizations/<organization-code>/workspaces/<workspace-id>/groups/

Response samples

Content type
application/json
[
  • {
    }
]

Create Group v2

Creates a group with the specified name.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
Request Body schema: application/json
required
id
string
name
string
memberCount
integer
hardwareFilter
null

Responses

Request samples

Content type
application/json
{
  • "id": "iaKbt",
  • "name": "Structural Team",
  • "memberCount": 0,
  • "hardwareFilter": null
}

Add Members v2

Adds a member to the specified group.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
group-id
required
string
Request Body schema: application/json
required
email
string
groupId
string
groupName
string
isGroupAdmin
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "ada@example.com",
  • "groupId": "iaKbt",
  • "groupName": "Structural Team",
  • "isGroupAdmin": false
}

Remove Members v2

Removes the member with the specified email from the specified group.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
group-id
required
string
member-email
required
string

Responses

Assign Hardware Filter v2

Assigns a hardware filter to the specified group.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
group-id
required
string
Request Body schema: application/json
required
id
string
name
string
memberCount
integer
object

Responses

Request samples

Content type
application/json
{
  • "id": "iaKbt",
  • "name": "Structural Team",
  • "memberCount": 3,
  • "hardwareFilter": {
    }
}

Hardware Filters

List Hardware Filters v2

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Response samples

Content type
application/json
{ }

Create Hardware Filter v2

Creates a hardware filter that can be applied to any group in the workspace.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Software Restrictions

View All Available Software v2

Returns a list of all available software analyses and their versions.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

View Software Restrictions v2

Returns a list of all analysis versions allowed for this workspace.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Response samples

Content type
application/json
{
  • "hasRestrictions": true,
  • "analysisVersions": [
    ]
}

Update Software Restrictions v2

Update the set of software analyses and versions available to the workspace.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string
Request Body schema: application/json
required
hasRestrictions
boolean
Array of objects

Responses

Request samples

Content type
application/json
{
  • "hasRestrictions": true,
  • "analysisVersions": [
    ]
}

Billing

View Workspace Billing Summary v2

Returns a summary of workspace charges for the specified period.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Response samples

Content type
application/json
{
  • "jobs": 12900,
  • "hardwareCharge": 23573.02,
  • "softwareCharge": 0,
  • "storageCharge": 500.25,
  • "transferCharge": 0,
  • "connectionsCharge": 0,
  • "deposits": 0,
  • "appliedCredit": 0,
  • "appliedDeposit": -24070.78,
  • "totalCharge": 2.49,
  • "hardwareUsage": 540882,
  • "storageUsage": 0,
  • "transferUsage": 0,
  • "id": "04-0468913198",
  • "label": "Acme Co.",
  • "activeUsers": 3,
  • "csvUrl": "/organizations/acme/workspaces/04-0468913198/billing/csv/?startYear=2020&startMonth=9&endYear=2020&endMonth=9"
}

View Organization Billing CSV Summary v3

This endpoint returns a csv summary of an organization charges for the specified period.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v3/organizations/<organization-code>/billing/csv/"

View Workspace Billing CSV Summary v3

This endpoint returns a csv summary of an member charges in an organization for the specified period.

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
workspace-id
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v3/organizations/<organization-code>/workspaces/<workspace-id>/billing/csv/"

View Members Billing CSV Summary v3

GET https://platform.rescale.com/api/v3/organizations/<organization-code>/workspaces/<workspace-id>/billing/members/<email>/csv/

Authorizations:
TokenAuth
path Parameters
organization-code
required
string
email
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v3/organizations/<organization-code>/billing/members/<email>/csv/"

View Project Billing CSV Summary v3

GET https://platform.rescale.com/api/v3/organizations/{organization}/workspaces/{workspace}/billing/projects/{projectId}/csv/

Authorizations:
TokenAuth
path Parameters
organization
required
string
projectId
required
string

Responses

Request samples 

curl -H "Authorization: Token <api-token>" -H "Content-Type: application/json" "https://platform.rescale.com/api/v3/organizations/{organization}/workspaces/{workspace}/billing/projects/{projectId}/csv/"

Folders

List root folders v3

This call allows you to retrieve the root folders for your user. The folder MyJobs contains all of your job folders, one for each of your active jobs. The folder MyLibrary is the root folder of your library files and folders.

Authorizations:
TokenAuth

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v3/users/me/folders/

Response samples

Content type
application/json
{
  • "MyJobs": "pCTMz",
  • "MyLibrary": "BdTMk"
}

Create a folder v3

This call allows you to create a new folder using the id of the parent folder to denote where you want to the folder created. Note that this operation is only possible within your MyLibrary directory. Job folders within your MyJobs directory are immutable.

Authorizations:
TokenAuth
path Parameters
parent_folder_id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Delete a folder v3

This call allows you to delete a folder and all of its contents: its files, its child folders and their descendants.

Authorizations:
TokenAuth
path Parameters
folder_id
required
string

Responses

Request samples 

curl -X DELETE -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v3/folders/{folder_id}/

Get folder ancestry v3

This call allows you to view the ancestry of a folder: its parent folder(s) all the way up to the root folder.

Authorizations:
TokenAuth
path Parameters
folder_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v3/folders/{folder_id}/

Response samples

Content type
application/json
{
  • "id": "thpAo",
  • "name": "level_3_folder",
  • "dateInserted": "2023-08-07T18:47:39.946002Z",
  • "type": "LibraryFolder",
  • "ancestry": [
    ],
  • "job": null
}

Get folder contents v3

This call allows you to view the metadata and contents of a folder, including child folders and files. However, to view the contents of its child folders, a separate request must be made.

Authorizations:
TokenAuth
path Parameters
folder_id
required
string

Responses

Request samples 

curl -X GET -H 'Authorization: Token \<token\>'
https://platform.rescale.com/api/v3/folders/{folder_id}/contents/

Response samples

Content type
application/json
{ }

Download a file to Cloud Filesystem v3

Beta API endpoints may change without notice, and this document may not reflect their current behavior.

Authorizations:
TokenAuth
Request Body schema: application/json
required
Array
fileId
string
success
boolean
operationId
string
error
null
status
integer

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Check the status of a file download to Cloud Filesystem v3

Beta API endpoints may change without notice, and this document may not reflect their current behavior.

Authorizations:
TokenAuth

Responses

Request samples 

curl -H 'Authorization: Token \<token\>' -H "Content-Type: application/json"
https://platform.rescale.com/api/v3/folders/copy-to-device/status/?operation_ids=<opId1>&operation_ids=<opId2>

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Budgets

List All Budgets v3

This endpoint retrieves all the budgets available to the user. A valid API token is required to make a successful request.

Authorizations:
TokenAuth

Responses

Request samples 

import requests

requests.get(
  'https://platform.rescale.com/api/v3/budgets/',
  headers={'Authorization': 'Token <api-token>'}
)

Response samples

Content type
application/json
[
  • {
    }
]

Create A New Budget v3

This endpoint creates a new budget for the user. A valid API token is required to make a successful request.

Authorizations:
TokenAuth
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"Successfully created Budget qOewo: API test"

Update A Budget v3

This endpoint updates an existing budget for the user. A valid API token is required to make a successful request.

Authorizations:
TokenAuth
Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"Successfully updated Budget kaaaa: new fun name"

Delete A Budget v3

This endpoint deletes an existing budget for the user. A valid API token is required to make a successful request.

Authorizations:
TokenAuth

Responses

Request samples 

import requests

requests.delete(
  'https://platform.rescale.com/api/v3/budgets/',
  headers={'Authorization': 'Token <api-token>'},
  body={"id": "kaaaa","name": "new fun name"}
)

Response samples

Content type
application/json
"Successfully deleted Budget kaaaa: new fun name"

Workflows

List workflows v3

Authorizations:
TokenAuth
query Parameters
search
string

Search workflows by name

user
string
Enum: "owned" "shared" "user_all"

Filter by ownership

ordering
string
Enum: "name" "-name" "date_inserted" "-date_inserted"

Sort order for results. Prefix with - for descending. Values are snake_case (query parameters are not camelCase-converted).

page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 1000 ]
Default: 10

Number of results per page (default 10, max 1000)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Create a workflow v3

Authorizations:
TokenAuth
Request Body schema: application/json
required
name
required
string <= 200 characters

Workflow name

description
string
Default: ""

Workflow description

required
object (WorkflowMarkup)

The workflow definition blob

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "",
  • "workflow": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "dateInserted": "2019-08-24T14:15:22Z",
  • "sharedWith": [
    ],
  • "workflow": {
    },
  • "latestVersion": 0
}

Retrieve a workflow v3

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "dateInserted": "2019-08-24T14:15:22Z",
  • "sharedWith": [
    ],
  • "workflow": {
    },
  • "latestVersion": 0
}

Update a workflow v3

Update workflow metadata and/or workflow blob. If a workflow blob is included, a new version is created with an incremented version number.

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

Request Body schema: application/json
required
name
string <= 200 characters

Workflow name

description
string

Workflow description

object (WorkflowMarkup)

Updated workflow definition blob. Creates a new version.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "workflow": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "owner": {
    },
  • "dateInserted": "2019-08-24T14:15:22Z",
  • "sharedWith": [
    ],
  • "workflow": {
    },
  • "latestVersion": 0
}

Delete a workflow v3

Deletes the workflow. Fails if the workflow is currently running.

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}

Submit a workflow for execution v3

Submit the workflow's latest version for execution. Validates provided parameters against the workflow's parameter definitions.

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

Request Body schema: application/json
required
workflowRunName
required
string <= 200 characters

Name for this workflow run

object
Default: {}

Key-value map of parameter values. Keys must match parameter names defined in the workflow. All required parameters must be provided. Each value is validated against the parameter's type and multiple fields in the workflow definition:

  • string or shared_storage: a plain string
  • file: a FileReference object ({ id, name })
  • multiple: true: an array of the corresponding type

Responses

Request samples

Content type
application/json
{
  • "workflowRunName": "Simulation Run 2026-02-18",
  • "parameters": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "workflowId": "string",
  • "workflowName": "string",
  • "workflowRunName": "string",
  • "owner": {
    },
  • "versionNumber": 0,
  • "dateInserted": "2019-08-24T14:15:22Z",
  • "dateVersionInserted": "2019-08-24T14:15:22Z",
  • "latestStatus": {
    },
  • "statuses": [
    ],
  • "workflow": {
    }
}

Workflow Sharing

List users with access to a workflow v3

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

query Parameters
page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 1000 ]
Default: 10

Number of results per page (default 10, max 1000)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Share a workflow with a user v3

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

Request Body schema: application/json
required
email
string <email>

Email address of the user to share with

account
string

Workspace external ID

group
string

Group external ID

supportDesk
string

Support desk code

message
string <= 1000 characters

Optional message included in the share notification

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "account": "string",
  • "group": "string",
  • "supportDesk": "string",
  • "message": "string"
}

Response samples

Content type
application/json
Example
{
  • "recipient": {
    },
  • "supportDesk": {
    },
  • "type": "user",
  • "fullName": "string",
  • "email": "user@example.com",
  • "workspace": {
    }
}

Revoke a user's access to a workflow v3

Authorizations:
TokenAuth
path Parameters
workflowId
required
string

Obfuscated workflow ID

Request Body schema: application/json
required
email
string <email>

Email address of the user to share with

account
string

Workspace external ID

group
string

Group external ID

supportDesk
string

Support desk code

message
string <= 1000 characters

Optional message included in the share notification

Responses

Request samples

Content type
application/json
{
  • "email": "user@example.com",
  • "account": "string",
  • "group": "string",
  • "supportDesk": "string",
  • "message": "string"
}

Response samples

Content type
application/json
{
  • "detail": "string"
}

Workflow Runs

List workflow runs v3

Authorizations:
TokenAuth
query Parameters
workflow_id
string

Filter by workflow ID (obfuscated)

ordering
string
Enum: "workflow_run_name" "-workflow_run_name" "date_inserted" "-date_inserted" "latest_status" "-latest_status"

Sort order for results. Prefix with - for descending. Values are snake_case (query parameters are not camelCase-converted).

page
integer >= 1
Default: 1

Page number for pagination

page_size
integer [ 1 .. 1000 ]
Default: 10

Number of results per page (default 10, max 1000)

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Retrieve a workflow run v3

Authorizations:
TokenAuth
path Parameters
workflowRunId
required
string

Obfuscated workflow run ID

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "workflowId": "string",
  • "workflowName": "string",
  • "workflowRunName": "string",
  • "owner": {
    },
  • "versionNumber": 0,
  • "dateInserted": "2019-08-24T14:15:22Z",
  • "dateVersionInserted": "2019-08-24T14:15:22Z",
  • "latestStatus": {
    },
  • "statuses": [
    ],
  • "workflow": {
    }
}

Update a workflow run name v3

Authorizations:
TokenAuth
path Parameters
workflowRunId
required
string

Obfuscated workflow run ID

Request Body schema: application/json
required
workflowRunName
required
string <= 200 characters

New name for the workflow run

Responses

Request samples

Content type
application/json
{
  • "workflowRunName": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "workflowId": "string",
  • "workflowName": "string",
  • "workflowRunName": "string",
  • "owner": {
    },
  • "versionNumber": 0,
  • "dateInserted": "2019-08-24T14:15:22Z",
  • "dateVersionInserted": "2019-08-24T14:15:22Z",
  • "latestStatus": {
    },
  • "statuses": [
    ],
  • "workflow": {
    }
}

Stop a running workflow v3

Stop a workflow run that is in queued or running state. Stops all running nodes (jobs, workstations, storage devices).

Authorizations:
TokenAuth
path Parameters
workflowRunId
required
string

Obfuscated workflow run ID

Responses

Response samples

Content type
application/json
{
  • "detail": "string"
}