All API operations

Every operation in the Rescale REST API, 111 in total, with a link into the API reference for the full request and response detail.

This page exists to be searched. If you know roughly what you want to do but not which endpoint does it, search from the header or use your browser's find-in-page here, then follow the link through to the reference.

The Version column shows which API version an operation belongs to. Both are supported, and operations are grouped by the resource they act on rather than by version.

Resources

Method	Path	Operation	Version
GET	/api/v2/analyses/	Analyses	v2
GET	/api/v2/coretypes/	Coretypes	v2

Jobs

Method	Path	Operation	Version
DELETE	/api/v2/jobs/	Delete Multiple Jobs	v2
GET	/api/v2/jobs/	List All Jobs	v2
POST	/api/v2/jobs/	Create a Job	v2
PUT	/api/v2/jobs/{job_id}	Update a Job	v2
DELETE	/api/v2/jobs/{job_id}/	Delete a Job	v2
GET	/api/v2/jobs/{job_id}/	Get a Specific Job	v2
GET	/api/v2/jobs/{job_id}/cluster_statuses/	List Cluster Status History for a Job	v2
GET	/api/v2/jobs/{job_id}/custom-fields/	List Custom Fields on a Job	v2
POST	/api/v2/jobs/{job_id}/custom-fields/	Submit Custom Fields on a Job	v2
POST	/api/v2/jobs/{job_id}/custom-fields/assigned/	Assign Custom Fields to a Job	v2
GET	/api/v2/jobs/{job_id}/extendedlogs/	List Job extended logs	v2
GET	/api/v2/jobs/{job_id}/files/	List Job Output Files	v2
GET	/api/v2/jobs/{job_id}/instances/	List Job Instances	v2
POST	/api/v2/jobs/{job_id}/share/	Share a Job	v2
GET	/api/v2/jobs/{job_id}/statuses/	List Job status history	v2
POST	/api/v2/jobs/{job_id}/stop/	Stop a Job	v2
POST	/api/v2/jobs/{job_id}/submit/	Submit a Saved Job	v2
DELETE	/api/v2/jobs/{job_id}/tags/	Remove a Tag from a Job	v2
GET	/api/v2/jobs/{job_id}/tags/	Get a list of Tags on a Job	v2
POST	/api/v2/jobs/{job_id}/tags/	Add a Tag to a Job	v2
GET	/api/v2/organizations/{company_code}/workspaces/{workspace_id}/custom-fields/	List Custom Fields in Your Workspace	v2
GET	/api/v2/organizations/{organization}/jobs/{job_id}/project-assignment/	List Project Job is Assigned To	v2
POST	/api/v2/organizations/{organization}/jobs/{job_id}/project-assignment/	Update Project Job is Assigned To	v2
POST	/api/v2/organizations/{organization}/project-assignment/	Update Job Position in Priority Queue	v2
GET	/api/v2/organizations/{organization}/projects/{projectId}/jobs/	List All Jobs in a Project	v2
GET	/api/v3/organizations/{organization}/projects/{projectId}/pending-queue/	Get Pending Job Priority Queue (Project)	v3
PATCH	/api/v3/organizations/{organization}/projects/{projectId}/pending-queue/{jobId}/	Update Job Position in Pending Job Priority Queue (Project)	v3

Runs

Method	Path	Operation	Version
GET	/api/v2/jobs/{job_id}/runs/	List Runs for a Job	v2
GET	/api/v2/jobs/{job_id}/runs/{run_id}/	Get a Run	v2
GET	/api/v2/jobs/{job_id}/runs/{run_id}/directory-contents/	List Directory Contents	v2
GET	/api/v2/jobs/{job_id}/runs/{run_id}/files/	List Output Files	v2
POST	/api/v2/jobs/{job_id}/runs/{run_id}/stop/	Stop a Run	v2
GET	/api/v2/jobs/{job_id}/runs/{run_id}/tail/{path}/	Tail File Content	v2

Files

Method	Path	Operation	Version
GET	/api/v2/files/	List all Files	v2
DELETE	/api/v2/files/{file_id}/	Delete a File	v2
GET	/api/v2/files/{file_id}/	Get Metadata of a File	v2
PATCH	/api/v2/files/{file_id}/	Update Metadata of a File	v2
GET	/api/v2/files/{file_id}/contents/	Download a File	v2
GET	/api/v2/files/{file_id}/lines/	Get Plaintext Content of a File	v2
GET	/api/v2/files/{file_id}/tags/	Get a list of Tags on a File	v2
POST	/api/v2/files/{file_id}/tags/	Add a Tag to a File	v2
DELETE	/api/v2/files/{job_id}/tags/	Remove a Tag from a File	v2

Tasks

Method	Path	Operation	Version
GET	/api/v2/tasks/{token}/	Poll a Running Task	v2

Storage Devices

Method	Path	Operation	Version
POST	/api/v2/jobs/{job_id}/storage-devices/	Attach a Storage Device to a Job	v2
GET	/api/v2/organizations/{organization}/projects/{projectId}/storage-devices/	List All Storage Devices in a Project	v2
POST	/api/v2/organizations/{organization}/storage-devices/{job_id}/project-assignment/	Update Project Storage Device is Assigned To	v2
GET	/api/v2/organizations/{organization}/storage-devices/{storage_device_id}/project-assignment/	List Project Storage Device is Assigned To	v2
GET	/api/v2/storage-devices/	List All Storage Devices	v2
GET	/api/v2/storage-devices/{storage_device_id}/	Get a Specific Storage Device	v2
PATCH	/api/v2/storage-devices/{storage_device_id}/	Update a Storage Device	v2
GET	/api/v2/storage-devices/{storage_device_id}/files/{path}	List Storage Device Files	v2
POST	/api/v2/storage-devices/{storage_device_id}/shutdown/	Terminate a Storage Device	v2
GET	/api/v2/storage-devices/{storage_device_id}/statuses/	List Storage Device Statuses	v2
POST	/api/v2/storage-devices/{storage_device_id}/submit/	Submit a Storage Device	v2
GET	/api/v2/storage-devices/available-regions/	List Available Regions	v2
POST	/api/v3/storage-devices/	Create a Storage Device	v3
POST	/api/v3/storage-devices/{storage_device_id}/force-shutdown/	Forcefully Terminate a Storage Device	v3

Prices

Method	Path	Operation	Version
GET	/api/v2/billing/computeprices/	List All Compute Prices	v2

Projects

Method	Path	Operation	Version
GET	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/	List projects available to a workspace	v2
POST	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/	Create a project	v2
DELETE	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/{project_id}/	Delete a project	v2
GET	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/{project_id}/	Get a specific project	v2
PATCH	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/{project_id}/	Update a project	v2
POST	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/{project_id}/groups/	Assign a group to a project	v2
DELETE	/api/v2/organizations/{organization_code}/workspaces/{workspace_id}/projects/{project_id}/groups/{group_id}/	Remove a group from a project	v2
GET	/api/v2/users/me/projects/	List projects available to your user	v2

Data Access

Method	Path	Operation	Version
GET	/api/v2/data/jobs	List All Jobs Metadata	v2
GET	/api/v2/data/jobs/fields	List Jobs metadata Fields	v2

Members

Method	Path	Operation	Version
POST	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/invites/	Invite Members to a Workspace	v2
GET	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/members/	List All Workspace Members	v2

Groups

Method	Path	Operation	Version
GET	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/groups/	List Groups	v2
POST	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/groups/	Create Group	v2
PATCH	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/groups/{group-id}/	Assign Hardware Filter	v2
POST	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/groups/{group-id}/members/	Add Members	v2
DELETE	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/groups/{group-id}/members/{member-email}/	Remove Members	v2

Hardware Filters

Method	Path	Operation	Version
GET	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/hardware-filters/	List Hardware Filters	v2
POST	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/hardware-filters/	Create Hardware Filter	v2

Software Restrictions

Method	Path	Operation	Version
GET	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/analysis-versions/	View Software Restrictions	v2
PATCH	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/analysis-versions/	Update Software Restrictions	v2
GET	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/available-analyses/	View All Available Software	v2

Billing

Method	Path	Operation	Version
GET	/api/v2/organizations/{organization-code}/workspaces/{workspace-id}/billing/	View Workspace Billing Summary	v2
GET	/api/v3/organizations/{organization-code}/billing/csv/	View Organization Billing CSV Summary	v3
GET	/api/v3/organizations/{organization-code}/billing/members/{email}/csv/	View Members Billing CSV Summary	v3
GET	/api/v3/organizations/{organization-code}/workspaces/{workspace-id}/billing/csv/	View Workspace Billing CSV Summary	v3
GET	/api/v3/organizations/{organization}/billing/projects/{projectId}/csv/	View Project Billing CSV Summary	v3

Folders

Method	Path	Operation	Version
GET	/api/v3/folders/{folder_id}	Get folder ancestry	v3
DELETE	/api/v3/folders/{folder_id}/	Delete a folder	v3
GET	/api/v3/folders/{folder_id}/contents/	Get folder contents	v3
POST	/api/v3/folders/{parent_folder_id}/	Create a folder	v3
POST	/api/v3/folders/copy-to-device/	Download a file to Cloud Filesystem	v3
GET	/api/v3/folders/copy-to-device/status/	Check the status of a file download to Cloud Filesystem	v3
GET	/api/v3/users/me/folders/	List root folders	v3

Budgets

Method	Path	Operation	Version
DELETE	/api/v3/budgets/	Delete A Budget	v3
GET	/api/v3/budgets/	List All Budgets	v3
PATCH	/api/v3/budgets/	Update A Budget	v3
POST	/api/v3/budgets/	Create A New Budget	v3

Workflows

Method	Path	Operation	Version
GET	/api/v3/workflows/	List workflows	v3
POST	/api/v3/workflows/	Create a workflow	v3
DELETE	/api/v3/workflows/{workflowId}/	Delete a workflow	v3
GET	/api/v3/workflows/{workflowId}/	Retrieve a workflow	v3
PATCH	/api/v3/workflows/{workflowId}/	Update a workflow	v3
POST	/api/v3/workflows/{workflowId}/submit/	Submit a workflow for execution	v3

Workflow Sharing

Method	Path	Operation	Version
DELETE	/api/v3/workflows/{workflowId}/allowed-users/	Revoke a user's access to a workflow	v3
GET	/api/v3/workflows/{workflowId}/allowed-users/	List users with access to a workflow	v3
POST	/api/v3/workflows/{workflowId}/allowed-users/	Share a workflow with a user	v3

Workflow Runs

Method	Path	Operation	Version
GET	/api/v3/workflow-runs/	List workflow runs	v3
GET	/api/v3/workflow-runs/{workflowRunId}/	Retrieve a workflow run	v3
PATCH	/api/v3/workflow-runs/{workflowRunId}/	Update a workflow run name	v3
POST	/api/v3/workflow-runs/{workflowRunId}/stop/	Stop a running workflow	v3