Skip to content
AdiosDocumentation
Browse documentation

Workspaces API

Workspaces are for source-backed code workloads. Database, cache, and queue templates cannot be opened as code workspaces. File and runtime operations may hydrate source or start runtime infrastructure.

Use API authentication for protected requests. Examples use your own resource IDs and a temporary token; saved response examples are synthetic.

MethodPathOperation
GET/v1/workspaceList workspaces
POST/v1/workspaceCreate workspace
GET/v1/workspace/{id}Get workspace
PUT/v1/workspace/{id}Update workspace
DELETE/v1/workspace/{id}Delete workspace
GET/v1/workspace/{id}/treeList workspace files
GET/v1/workspace/{id}/fileRead workspace file
PUT/v1/workspace/{id}/fileWrite workspace file
DELETE/v1/workspace/{id}/fileDelete workspace file
POST/v1/workspace/{id}/file/moveMove workspace file
POST/v1/workspace/{id}/commandsRun workspace lint
GET/v1/workspace/{id}/commands/{command_id}Get workspace command status
GET/v1/workspace/{id}/commands/{command_id}/logsGet workspace command logs
GET/v1/workspace/{id}/runGet workspace runtime status
POST/v1/workspace/{id}/run/startStart workspace preview
POST/v1/workspace/{id}/run/stopStop workspace preview
POST/v1/workspace/{id}/run/restartRestart workspace preview
GET/v1/workspace/{id}/git/statusGet workspace Git status
GET/v1/workspace/{id}/git/logGet workspace Git history
GET/v1/workspace/{id}/git/branchesList workspace Git branches
GET/v1/workspace/{id}/manifest/checkCheck workspace manifest
GET/v1/workspace/{id}/testsGet workspace test inventory

List workspaces

GET /v1/workspace

Returns a paginated list of Workspace

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pagequerynoPage number
per_pagequerynoItems per page

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

List of Workspace

Response fields

FieldTypeDescription
dataarray
data[].base_build_idstring
data[].base_source_artifact_idstringAPI source artifact record used to hydrate the workspace
data[].branchstring
data[].created_atinteger(Unix timestamp)
data[].deleted_atinteger(Unix timestamp)
data[].metadataobject
data[].namestring
data[].owner_idstring
data[].repository_urlstringGit repository URL
data[].runtime_statusstringAllowed: idle, running, stopped, failed.
data[].source_manifeststringProject adios manifest path within the composed workspace source root
data[].source_workdirstringProject working directory within the composed workspace source root
data[].statusstringAllowed: active, archived, deleted.
data[].team_idstring
data[].updated_atinteger(Unix timestamp)
data[].workload_idstring
data[].workspace_idstring
paginationobject
pagination.pageintegerCurrent page number
pagination.per_pageintegerNumber of items per page
pagination.totalintegerTotal number of items

Illustrative example; not a live response:

{
  "data": [
    {
      "base_build_id": "example",
      "base_source_artifact_id": "",
      "branch": "",
      "created_at": 1791072000,
      "deleted_at": 0,
      "metadata": {},
      "name": "postman-example",
      "owner_id": "000000000000000000000000001",
      "repository_url": "example",
      "runtime_status": "idle",
      "source_manifest": "adios.yaml",
      "source_workdir": ".",
      "status": "active",
      "team_id": "000000000000000000000000001",
      "updated_at": 1791072000,
      "workload_id": "",
      "workspace_id": "000000000000000000000000001"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 1,
    "total": 1
  }
}

Create workspace

POST /v1/workspace

Creates a new Workspace

This request changes data or starts an action. Review the target and body before sending it.

Request fields (the body contains an editable example):

FieldTypeRequiredDescription
base_build_idstringno
base_source_artifact_idstringnoAPI source artifact record used to hydrate the workspace Default: "".
branchstringnoDefault: "".
metadataobjectno
namestringyes
owner_idstringyes
repository_urlstringnoGit repository URL
runtime_statusstringnoAllowed: idle, running, stopped, failed. Default: "idle".
source_manifeststringnoProject adios manifest path within the composed workspace source root Default: "adios.yaml".
source_workdirstringnoProject working directory within the composed workspace source root Default: ".".
statusstringyesAllowed: active, archived, deleted. Default: "active".
team_idstringyes
workload_idstringnoDefault: "".

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "owner_id": "YOUR_USER_ID",
  "name": "postman-workspace",
  "status": "active",
  "workload_id": "YOUR_WORKLOAD_ID"
}
JSON

Replace YOUR_* body placeholders before sending. The quoted heredoc keeps the JSON literal.

Response: HTTP 201

Workspace created

Response fields

FieldTypeDescription
base_build_idstring
base_source_artifact_idstringAPI source artifact record used to hydrate the workspace
branchstring
created_atinteger(Unix timestamp)
deleted_atinteger(Unix timestamp)
metadataobject
namestring
owner_idstring
repository_urlstringGit repository URL
runtime_statusstringAllowed: idle, running, stopped, failed.
source_manifeststringProject adios manifest path within the composed workspace source root
source_workdirstringProject working directory within the composed workspace source root
statusstringAllowed: active, archived, deleted.
team_idstring
updated_atinteger(Unix timestamp)
workload_idstring
workspace_idstring

Illustrative example; not a live response:

{
  "base_build_id": "example",
  "base_source_artifact_id": "",
  "branch": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "metadata": {},
  "name": "postman-example",
  "owner_id": "000000000000000000000000001",
  "repository_url": "example",
  "runtime_status": "idle",
  "source_manifest": "adios.yaml",
  "source_workdir": ".",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workload_id": "",
  "workspace_id": "000000000000000000000000001"
}

Get workspace

GET /v1/workspace/{id}

Returns a single Workspace

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Workspace

Response fields

FieldTypeDescription
base_build_idstring
base_source_artifact_idstringAPI source artifact record used to hydrate the workspace
branchstring
created_atinteger(Unix timestamp)
deleted_atinteger(Unix timestamp)
metadataobject
namestring
owner_idstring
repository_urlstringGit repository URL
runtime_statusstringAllowed: idle, running, stopped, failed.
source_manifeststringProject adios manifest path within the composed workspace source root
source_workdirstringProject working directory within the composed workspace source root
statusstringAllowed: active, archived, deleted.
team_idstring
updated_atinteger(Unix timestamp)
workload_idstring
workspace_idstring

Illustrative example; not a live response:

{
  "base_build_id": "example",
  "base_source_artifact_id": "",
  "branch": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "metadata": {},
  "name": "postman-example",
  "owner_id": "000000000000000000000000001",
  "repository_url": "example",
  "runtime_status": "idle",
  "source_manifest": "adios.yaml",
  "source_workdir": ".",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workload_id": "",
  "workspace_id": "000000000000000000000000001"
}

Update workspace

PUT /v1/workspace/{id}

Updates an existing Workspace

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Request fields (the body contains an editable example):

FieldTypeRequiredDescription
base_build_idstringno
base_source_artifact_idstringnoAPI source artifact record used to hydrate the workspace Default: "".
branchstringnoDefault: "".
metadataobjectno
namestringyes
owner_idstringyes
repository_urlstringnoGit repository URL
runtime_statusstringnoAllowed: idle, running, stopped, failed. Default: "idle".
source_manifeststringnoProject adios manifest path within the composed workspace source root Default: "adios.yaml".
source_workdirstringnoProject working directory within the composed workspace source root Default: ".".
statusstringyesAllowed: active, archived, deleted. Default: "active".
team_idstringyes
workload_idstringnoDefault: "".

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "team_id": "YOUR_TEAM_ID",
  "owner_id": "YOUR_USER_ID",
  "name": "postman-workspace",
  "status": "active",
  "workload_id": "YOUR_WORKLOAD_ID"
}
JSON

Replace YOUR_* body placeholders before sending. The quoted heredoc keeps the JSON literal.

Response: HTTP 200

Workspace updated

Response fields

FieldTypeDescription
base_build_idstring
base_source_artifact_idstringAPI source artifact record used to hydrate the workspace
branchstring
created_atinteger(Unix timestamp)
deleted_atinteger(Unix timestamp)
metadataobject
namestring
owner_idstring
repository_urlstringGit repository URL
runtime_statusstringAllowed: idle, running, stopped, failed.
source_manifeststringProject adios manifest path within the composed workspace source root
source_workdirstringProject working directory within the composed workspace source root
statusstringAllowed: active, archived, deleted.
team_idstring
updated_atinteger(Unix timestamp)
workload_idstring
workspace_idstring

Illustrative example; not a live response:

{
  "base_build_id": "example",
  "base_source_artifact_id": "",
  "branch": "",
  "created_at": 1791072000,
  "deleted_at": 0,
  "metadata": {},
  "name": "postman-example",
  "owner_id": "000000000000000000000000001",
  "repository_url": "example",
  "runtime_status": "idle",
  "source_manifest": "adios.yaml",
  "source_workdir": ".",
  "status": "active",
  "team_id": "000000000000000000000000001",
  "updated_at": 1791072000,
  "workload_id": "",
  "workspace_id": "000000000000000000000000001"
}

Delete workspace

DELETE /v1/workspace/{id}

Deletes a Workspace

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Resource deleted.

Response fields

FieldTypeDescription
messagestring

Illustrative example; not a live response:

{
  "message": "Deleted successfully"
}

List workspace files

GET /v1/workspace/{id}/tree

List entries in a source-backed workspace directory.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pathquerynoDirectory relative to the workspace root.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/tree?path=." \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Read workspace file

GET /v1/workspace/{id}/file

Read a file relative to the workspace root.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pathqueryyesRequired workspace-relative file path.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/file?path=${ADIOS_FILE_PATH}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Write workspace file

PUT /v1/workspace/{id}/file

Create or replace the contents of the selected file.

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pathqueryyesRequired workspace-relative file path.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request PUT "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/file?path=${ADIOS_FILE_PATH}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "content": "Hello from Postman!\n",
  "encoding": "utf8"
}
JSON

Replace YOUR_* body placeholders before sending. The quoted heredoc keeps the JSON literal.

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Delete workspace file

DELETE /v1/workspace/{id}/file

Delete the selected workspace file.

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.
pathqueryyesRequired workspace-relative file path.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request DELETE "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/file?path=${ADIOS_FILE_PATH}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Move workspace file

POST /v1/workspace/{id}/file/move

Move a file within the workspace.

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/file/move" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "from": "YOUR_FILE_PATH",
  "to": "YOUR_DESTINATION_PATH"
}
JSON

Replace YOUR_* body placeholders before sending. The quoted heredoc keeps the JSON literal.

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Run workspace lint

POST /v1/workspace/{id}/commands

Run the workspace's configured lint command. kind supports lint

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/commands" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID" \
  -H "Content-Type: application/json" \
  --data-binary @- <<'JSON'
{
  "kind": "lint"
}
JSON

Replace YOUR_* body placeholders before sending. The quoted heredoc keeps the JSON literal.

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Get workspace command status

GET /v1/workspace/{id}/commands/{command_id}

Inspect a previously submitted workspace command.

Set workspace_id, command_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
command_idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/commands/${ADIOS_COMMAND_ID}" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Get workspace command logs

GET /v1/workspace/{id}/commands/{command_id}/logs

Read logs for a workspace command.

Set workspace_id, command_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
command_idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/commands/${ADIOS_COMMAND_ID}/logs" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Get workspace runtime status

GET /v1/workspace/{id}/run

Inspect the workspace preview runtime.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/run" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Start workspace preview

POST /v1/workspace/{id}/run/start

Start the workspace preview runtime. This may consume paid resources.

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/run/start" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Stop workspace preview

POST /v1/workspace/{id}/run/stop

Stop the workspace preview runtime.

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/run/stop" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Restart workspace preview

POST /v1/workspace/{id}/run/restart

Restart the workspace preview runtime.

Set workspace_id using IDs from your own API responses.

This request changes data or starts an action. Review the target and body before sending it.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request POST "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/run/restart" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Get workspace Git status

GET /v1/workspace/{id}/git/status

Inspect the current branch and local changes.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/git/status" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Get workspace Git history

GET /v1/workspace/{id}/git/log

Read recent workspace commits.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/git/log" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

List workspace Git branches

GET /v1/workspace/{id}/git/branches

List branches available in the workspace.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/git/branches" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Check workspace manifest

GET /v1/workspace/{id}/manifest/check

Validate the workspace Adios manifest.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/manifest/check" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.

Get workspace test inventory

GET /v1/workspace/{id}/tests

Inspect detected tests and testing configuration.

Set workspace_id using IDs from your own API responses.

Authentication: bearer token and the team header shown below.

Parameters

NameLocationRequiredDescription
idpathyesResource identifier from your team's API results.
X-Tenant-IDheaderyesActive team ID. Must match the tenant bound to a diagnostic token.

Request example

Set ADIOS_API_URL=https://api.adios.dev. For protected requests, set ADIOS_ACCESS_TOKEN and ADIOS_TEAM_ID as in the quickstart. Set any additional ADIOS_* variables from your own resource results.

curl --fail-with-body --request GET "$ADIOS_API_URL/v1/workspace/${ADIOS_WORKSPACE_ID}/tests" \
  -H "Authorization: Bearer $ADIOS_ACCESS_TOKEN" \
  -H "X-Tenant-ID: $ADIOS_TEAM_ID"

Response: HTTP 200

Successful response. Inspect returned state for operations that start asynchronous work.

A complete response-body schema is not published for this custom operation. Inspect the returned content and status; no payload is assumed here.