Pular para o conteúdo
AdiosDocumentação
Explorar a documentação

API de espaços de trabalho

Espaços de trabalho são destinados a workloads de código ligados ao código-fonte. Modelos de banco de dados, cache e fila não podem ser abertos como espaços de trabalho de código. Operações de arquivos e execução podem carregar o código-fonte ou iniciar infraestrutura de execução.

Usar Autenticação da API para pedidos protegidos. Exemplos usam seus próprios IDs de recursos e um token temporário; exemplos de resposta salvos são sintéticos.

MétodoCaminhoOperação
GET/v1/workspaceListar espaços de trabalho
POST/v1/workspaceCriar espaço de trabalho
GET/v1/workspace/{id}Obter espaço de trabalho
PUT/v1/workspace/{id}Atualizar espaço de trabalho
DELETE/v1/workspace/{id}Excluir espaço de trabalho
GET/v1/workspace/{id}/treeListar arquivos do espaço de trabalho
GET/v1/workspace/{id}/fileLer arquivo do espaço de trabalho
PUT/v1/workspace/{id}/fileGravar arquivo do espaço de trabalho
DELETE/v1/workspace/{id}/fileExcluir arquivo do espaço de trabalho
POST/v1/workspace/{id}/file/moveMover arquivo do espaço de trabalho
POST/v1/workspace/{id}/commandsExecutar lint do espaço de trabalho
GET/v1/workspace/{id}/commands/{command_id}Obter o estado do comando do espaço de trabalho
GET/v1/workspace/{id}/commands/{command_id}/logsObter logs de comando do espaço de trabalho
GET/v1/workspace/{id}/runObter o status de execução do espaço de trabalho
POST/v1/workspace/{id}/run/startIniciar prévia do espaço de trabalho
POST/v1/workspace/{id}/run/stopParar prévia do espaço de trabalho
POST/v1/workspace/{id}/run/restartReiniciar prévia do espaço de trabalho
GET/v1/workspace/{id}/git/statusObter o estado do Git no espaço de trabalho
GET/v1/workspace/{id}/git/logObter o histórico do Git no espaço de trabalho
GET/v1/workspace/{id}/git/branchesListar branches Git do espaço de trabalho
GET/v1/workspace/{id}/manifest/checkVerificar o manifesto de espaço de trabalho
GET/v1/workspace/{id}/testsObter o inventário de testes de espaço de trabalho

Listar espaços de trabalho

GET /v1/workspace

Retorna uma lista paginada de Workspace

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
pageconsultanãoNúmero da página
per_pageconsultanãoItens por página

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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

Resposta: HTTP 200

Lista de Workspace

Campos de resposta

CampoTipoDescrição
dataarray
data[].base_build_idstring
data[].base_source_artifact_idstringRegistro de artefato de código-fonte da API usado para carregar o espaço de trabalho
data[].branchstring
data[].created_atinteiro(Timestamp Unix)
data[].deleted_atinteiro(Timestamp Unix)
data[].metadataobjeto
data[].namestring
data[].owner_idstring
data[].repository_urlstringURL do repositório Git
data[].runtime_statusstringValores permitidos: idle, running, stopped, failed.
data[].source_manifeststringCaminho do manifesto adios do projeto dentro da raiz composta do código-fonte do espaço de trabalho
data[].source_workdirstringDiretório de trabalho do projeto dentro da raiz composta do código-fonte do espaço de trabalho
data[].statusstringValores permitidos: active, archived, deleted.
data[].team_idstring
data[].updated_atinteiro(Timestamp Unix)
data[].workload_idstring
data[].workspace_idstring
paginationobjeto
pagination.pageinteiroNúmero da página atual
pagination.per_pageinteiroNúmero de itens por página
pagination.totalinteiroNúmero total de itens

Exemplo ilustrativo; não é uma resposta real:

{
  "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
  }
}

Criar espaço de trabalho

POST /v1/workspace

Cria um novo objeto Workspace

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

CampoTipoObrigatórioDescrição
base_build_idstringnão
base_source_artifact_idstringnãoRegistro de artefato de código-fonte da API usado para carregar o espaço de trabalho. Padrão: "".
branchstringnãoPadrão: "".
metadataobjetonão
namestringsim
owner_idstringsim
repository_urlstringnãoURL do repositório Git
runtime_statusstringnãoValores permitidos: idle, running, stopped, failed. Padrão: "idle".
source_manifeststringnãoCaminho do manifesto adios do projeto dentro da raiz composta do código-fonte do espaço de trabalho. Padrão: "adios.yaml".
source_workdirstringnãoDiretório de trabalho do projeto dentro da raiz composta do código-fonte do espaço de trabalho. Padrão: ".".
statusstringsimValores permitidos: active, archived, deleted. Padrão: "active".
team_idstringsim
workload_idstringnãoPadrão: "".

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 201

Espaço de trabalho criado

Campos de resposta

CampoTipoDescrição
base_build_idstring
base_source_artifact_idstringRegistro de artefato de código-fonte da API usado para carregar o espaço de trabalho
branchstring
created_atinteiro(Timestamp Unix)
deleted_atinteiro(Timestamp Unix)
metadataobjeto
namestring
owner_idstring
repository_urlstringURL do repositório Git
runtime_statusstringValores permitidos: idle, running, stopped, failed.
source_manifeststringCaminho do manifesto adios do projeto dentro da raiz composta do código-fonte do espaço de trabalho
source_workdirstringDiretório de trabalho do projeto dentro da raiz composta do código-fonte do espaço de trabalho
statusstringValores permitidos: active, archived, deleted.
team_idstring
updated_atinteiro(Timestamp Unix)
workload_idstring
workspace_idstring

Exemplo ilustrativo; não é uma resposta real:

{
  "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"
}

Obter espaço de trabalho

GET /v1/workspace/{id}

Retorna um objeto Workspace

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Espaço de trabalho

Campos de resposta

CampoTipoDescrição
base_build_idstring
base_source_artifact_idstringRegistro de artefato de código-fonte da API usado para carregar o espaço de trabalho
branchstring
created_atinteiro(Timestamp Unix)
deleted_atinteiro(Timestamp Unix)
metadataobjeto
namestring
owner_idstring
repository_urlstringURL do repositório Git
runtime_statusstringValores permitidos: idle, running, stopped, failed.
source_manifeststringCaminho do manifesto adios do projeto dentro da raiz composta do código-fonte do espaço de trabalho
source_workdirstringDiretório de trabalho do projeto dentro da raiz composta do código-fonte do espaço de trabalho
statusstringValores permitidos: active, archived, deleted.
team_idstring
updated_atinteiro(Timestamp Unix)
workload_idstring
workspace_idstring

Exemplo ilustrativo; não é uma resposta real:

{
  "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"
}

Atualizar espaço de trabalho

PUT /v1/workspace/{id}

Atualiza um objeto Workspace existente

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Campos da requisição (o corpo contém um exemplo editável):

CampoTipoObrigatórioDescrição
base_build_idstringnão
base_source_artifact_idstringnãoRegistro de artefato de código-fonte da API usado para carregar o espaço de trabalho. Padrão: "".
branchstringnãoPadrão: "".
metadataobjetonão
namestringsim
owner_idstringsim
repository_urlstringnãoURL do repositório Git
runtime_statusstringnãoValores permitidos: idle, running, stopped, failed. Padrão: "idle".
source_manifeststringnãoCaminho do manifesto adios do projeto dentro da raiz composta do código-fonte do espaço de trabalho. Padrão: "adios.yaml".
source_workdirstringnãoDiretório de trabalho do projeto dentro da raiz composta do código-fonte do espaço de trabalho. Padrão: ".".
statusstringsimValores permitidos: active, archived, deleted. Padrão: "active".
team_idstringsim
workload_idstringnãoPadrão: "".

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Workspace atualizado

Campos de resposta

CampoTipoDescrição
base_build_idstring
base_source_artifact_idstringRegistro de artefato de código-fonte da API usado para carregar o espaço de trabalho
branchstring
created_atinteiro(Timestamp Unix)
deleted_atinteiro(Timestamp Unix)
metadataobjeto
namestring
owner_idstring
repository_urlstringURL do repositório Git
runtime_statusstringValores permitidos: idle, running, stopped, failed.
source_manifeststringCaminho do manifesto adios do projeto dentro da raiz composta do código-fonte do espaço de trabalho
source_workdirstringDiretório de trabalho do projeto dentro da raiz composta do código-fonte do espaço de trabalho
statusstringValores permitidos: active, archived, deleted.
team_idstring
updated_atinteiro(Timestamp Unix)
workload_idstring
workspace_idstring

Exemplo ilustrativo; não é uma resposta real:

{
  "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"
}

Excluir espaço de trabalho

DELETE /v1/workspace/{id}

Exclui um objeto Workspace

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

O recurso foi apagado.

Campos de resposta

CampoTipoDescrição
messagestring

Exemplo ilustrativo; não é uma resposta real:

{
  "message": "Deleted successfully"
}

Listar arquivos do espaço de trabalho

GET /v1/workspace/{id}/tree

Liste as entradas de um diretório do espaço de trabalho ligado ao código-fonte.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
pathconsultanãoPasta relativa à raiz do espaço de trabalho.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Ler arquivo do espaço de trabalho

GET /v1/workspace/{id}/file

Leia um arquivo relativo à raiz do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
pathconsultasimCaminho obrigatório do arquivo, relativo ao espaço de trabalho.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Gravar arquivo do espaço de trabalho

PUT /v1/workspace/{id}/file

Crie ou substitua o conteúdo do arquivo selecionado.

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
pathconsultasimCaminho obrigatório do arquivo, relativo ao espaço de trabalho.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Excluir arquivo do espaço de trabalho

DELETE /v1/workspace/{id}/file

Exclua o arquivo selecionado do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.
pathconsultasimCaminho obrigatório do arquivo, relativo ao espaço de trabalho.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Mover arquivo do espaço de trabalho

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

Mova um arquivo dentro do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Executar lint do espaço de trabalho

POST /v1/workspace/{id}/commands

Execute o comando de lint configurado no espaço de trabalho. kind aceita lint

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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

Substitua YOUR_* no corpo antes de enviar. O heredoc com delimitador entre aspas mantém o JSON literal.

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter o estado do comando do espaço de trabalho

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

Inspecione um comando enviado anteriormente ao espaço de trabalho.

Defina workspace_id, command_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
command_idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter logs de comando do espaço de trabalho

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

Leia logs para um comando de espaço de trabalho.

Defina workspace_id, command_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
command_idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter o status de execução do espaço de trabalho

GET /v1/workspace/{id}/run

Inspecione o ambiente de execução da prévia do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Iniciar prévia do espaço de trabalho

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

Inicie o ambiente de execução da prévia do espaço de trabalho. Isso pode consumir recursos pagos.

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Parar prévia do espaço de trabalho

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

Pare o ambiente de execução da prévia do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Reiniciar prévia do espaço de trabalho

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

Reinicie o ambiente de execução da prévia do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Esta requisição altera dados ou inicia uma ação. Confira o destino e o corpo antes de enviá-la.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter o estado do Git no espaço de trabalho

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

Inspecione a branch atual e as alterações locais.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter o histórico do Git no espaço de trabalho

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

Leia commits de espaço de trabalho recentes.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Listar branches Git do espaço de trabalho

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

Liste as branches disponíveis no espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Verificar o manifesto de espaço de trabalho

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

Valide o manifesto Adios do espaço de trabalho.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.

Obter o inventário de testes de espaço de trabalho

GET /v1/workspace/{id}/tests

Inspecione os testes detectados e a configuração de testes.

Defina workspace_id usando IDs das suas próprias respostas da API.

Autenticação: token bearer e o cabeçalho de equipe mostrado abaixo.

Parâmetros

NomeLocalizaçãoObrigatórioDescrição
idcaminhosimIdentificador de recurso dos resultados da API da sua equipe.
X-Tenant-IDcabeçalhosimID da equipe ativa. Deve corresponder ao tenant vinculado a um token de diagnóstico.

Exemplo de requisição

Defina ADIOS_API_URL=https://api.adios.dev. Para requisições protegidas, defina ADIOS_ACCESS_TOKEN e ADIOS_TEAM_ID como na início rápido. Defina quaisquer variáveis adicionais ADIOS_* variáveis dos seus próprios resultados de recursos.

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"

Resposta: HTTP 200

Resposta bem sucedida. Inspecione o estado retornado para operações que iniciam trabalho assíncrono.

Um esquema completo de corpo-resposta não é publicado para esta operação personalizada. Inspecione o conteúdo e o status retornados; nenhuma carga útil é assumida aqui.