Aller au contenu
AdiosDocumentation
Parcourir la documentation

API des espaces de travail

Les espaces de travail concernent les workloads avec code source. Les modèles de bases de données, de caches et de files d’attente ne peuvent pas être ouverts comme espaces de travail de code. Les opérations sur les fichiers et l’exécution peuvent charger le code source ou démarrer une infrastructure d’exécution.

Utiliser Authentification API pour les requêtes protégées. Les exemples utilisent vos propres ID de ressources et un jeton temporaire ; les exemples de réponses enregistrés sont synthétiques.

MéthodeCheminOpération
GET/v1/workspaceLister les espaces de travail
POST/v1/workspaceCréer un espace de travail
GET/v1/workspace/{id}Obtenir l’espace de travail
PUT/v1/workspace/{id}Mettre à jour l'espace de travail
DELETE/v1/workspace/{id}Supprimer l'espace de travail
GET/v1/workspace/{id}/treeLister les fichiers de l’espace de travail
GET/v1/workspace/{id}/fileLire le fichier de l’espace de travail
PUT/v1/workspace/{id}/fileÉcrire un fichier de l’espace de travail
DELETE/v1/workspace/{id}/fileSupprimer le fichier de l’espace de travail
POST/v1/workspace/{id}/file/moveDéplacer le fichier de l’espace de travail
POST/v1/workspace/{id}/commandsExécuter le lint de l’espace de travail
GET/v1/workspace/{id}/commands/{command_id}Obtenir le statut de commande de l'espace de travail
GET/v1/workspace/{id}/commands/{command_id}/logsObtenir les journaux des commandes de l'espace de travail
GET/v1/workspace/{id}/runObtenir l’état d’exécution de l’espace de travail
POST/v1/workspace/{id}/run/startDémarrer l'aperçu de l'espace de travail
POST/v1/workspace/{id}/run/stopArrêter l'aperçu de l'espace de travail
POST/v1/workspace/{id}/run/restartRedémarrer l'aperçu de l'espace de travail
GET/v1/workspace/{id}/git/statusObtenir l’état Git de l’espace de travail
GET/v1/workspace/{id}/git/logObtenir l’historique Git de l’espace de travail
GET/v1/workspace/{id}/git/branchesLister les branches Git de l’espace de travail
GET/v1/workspace/{id}/manifest/checkVérifier le manifeste de l'espace de travail
GET/v1/workspace/{id}/testsObtenir l’inventaire des tests de l’espace de travail

Lister les espaces de travail

GET /v1/workspace

Renvoie une liste paginée de Workspace

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
pagerequêtenonNuméro de page
per_pagerequêtenonÉléments par page

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Réponse : HTTP 200

Liste de Workspace

Champs de réponse

ChampTypeDescription
datatableau
data[].base_build_idchaîne
data[].base_source_artifact_idchaîneEnregistrement API de l’artefact source utilisé pour charger l’espace de travail
data[].branchchaîne
data[].created_atentier(horodatage Unix)
data[].deleted_atentier(horodatage Unix)
data[].metadataobjet
data[].namechaîne
data[].owner_idchaîne
data[].repository_urlchaîneURL du dépôt Git
data[].runtime_statuschaîneValeurs autorisées : idle, running, stopped, failed.
data[].source_manifestchaîneChemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail
data[].source_workdirchaîneRépertoire de travail du projet dans la racine du code source composé de l’espace de travail
data[].statuschaîneValeurs autorisées : active, archived, deleted.
data[].team_idchaîne
data[].updated_atentier(horodatage Unix)
data[].workload_idchaîne
data[].workspace_idchaîne
paginationobjet
pagination.pageentierNuméro de page actuel
pagination.per_pageentierNombre d’éléments par page
pagination.totalentierNombre total d’éléments

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Créer un espace de travail

POST /v1/workspace

Crée un nouvel objet Workspace

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Champs de la requête (le corps contient un exemple modifiable) :

ChampTypeRequisDescription
base_build_idchaînenon
base_source_artifact_idchaînenonEnregistrement API de l’artefact source utilisé pour charger l’espace de travail. Valeur par défaut : "".
branchchaînenonValeur par défaut : "".
metadataobjetnon
namechaîneoui
owner_idchaîneoui
repository_urlchaînenonURL du dépôt Git
runtime_statuschaînenonValeurs autorisées : idle, running, stopped, failed. Valeur par défaut : "idle".
source_manifestchaînenonChemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : "adios.yaml".
source_workdirchaînenonRépertoire de travail du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : ".".
statuschaîneouiValeurs autorisées : active, archived, deleted. Valeur par défaut : "active".
team_idchaîneoui
workload_idchaînenonValeur par défaut : "".

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 201

Espace de travail créé

Champs de réponse

ChampTypeDescription
base_build_idchaîne
base_source_artifact_idchaîneEnregistrement API de l’artefact source utilisé pour charger l’espace de travail
branchchaîne
created_atentier(horodatage Unix)
deleted_atentier(horodatage Unix)
metadataobjet
namechaîne
owner_idchaîne
repository_urlchaîneURL du dépôt Git
runtime_statuschaîneValeurs autorisées : idle, running, stopped, failed.
source_manifestchaîneChemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail
source_workdirchaîneRépertoire de travail du projet dans la racine du code source composé de l’espace de travail
statuschaîneValeurs autorisées : active, archived, deleted.
team_idchaîne
updated_atentier(horodatage Unix)
workload_idchaîne
workspace_idchaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Obtenir l’espace de travail

GET /v1/workspace/{id}

Renvoie un seul Workspace

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Espace de travail

Champs de réponse

ChampTypeDescription
base_build_idchaîne
base_source_artifact_idchaîneEnregistrement API de l’artefact source utilisé pour charger l’espace de travail
branchchaîne
created_atentier(horodatage Unix)
deleted_atentier(horodatage Unix)
metadataobjet
namechaîne
owner_idchaîne
repository_urlchaîneURL du dépôt Git
runtime_statuschaîneValeurs autorisées : idle, running, stopped, failed.
source_manifestchaîneChemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail
source_workdirchaîneRépertoire de travail du projet dans la racine du code source composé de l’espace de travail
statuschaîneValeurs autorisées : active, archived, deleted.
team_idchaîne
updated_atentier(horodatage Unix)
workload_idchaîne
workspace_idchaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Mettre à jour l'espace de travail

PUT /v1/workspace/{id}

Met à jour un objet Workspace existant

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Champs de la requête (le corps contient un exemple modifiable) :

ChampTypeRequisDescription
base_build_idchaînenon
base_source_artifact_idchaînenonEnregistrement API de l’artefact source utilisé pour charger l’espace de travail. Valeur par défaut : "".
branchchaînenonValeur par défaut : "".
metadataobjetnon
namechaîneoui
owner_idchaîneoui
repository_urlchaînenonURL du dépôt Git
runtime_statuschaînenonValeurs autorisées : idle, running, stopped, failed. Valeur par défaut : "idle".
source_manifestchaînenonChemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : "adios.yaml".
source_workdirchaînenonRépertoire de travail du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : ".".
statuschaîneouiValeurs autorisées : active, archived, deleted. Valeur par défaut : "active".
team_idchaîneoui
workload_idchaînenonValeur par défaut : "".

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 200

Espace de travail mis à jour

Champs de réponse

ChampTypeDescription
base_build_idchaîne
base_source_artifact_idchaîneEnregistrement API de l’artefact source utilisé pour charger l’espace de travail
branchchaîne
created_atentier(horodatage Unix)
deleted_atentier(horodatage Unix)
metadataobjet
namechaîne
owner_idchaîne
repository_urlchaîneURL du dépôt Git
runtime_statuschaîneValeurs autorisées : idle, running, stopped, failed.
source_manifestchaîneChemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail
source_workdirchaîneRépertoire de travail du projet dans la racine du code source composé de l’espace de travail
statuschaîneValeurs autorisées : active, archived, deleted.
team_idchaîne
updated_atentier(horodatage Unix)
workload_idchaîne
workspace_idchaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

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

Supprimer l'espace de travail

DELETE /v1/workspace/{id}

Supprime un objet Workspace

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Ressource supprimée.

Champs de réponse

ChampTypeDescription
messagechaîne

Exemple illustratif ; il ne s’agit pas d’une réponse réelle :

{
  "message": "Deleted successfully"
}

Lister les fichiers de l’espace de travail

GET /v1/workspace/{id}/tree

Lister les entrées d’un répertoire d’espace de travail lié au code source.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
pathrequêtenonRépertoire relatif à la racine de l'espace de travail.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Lire le fichier de l’espace de travail

GET /v1/workspace/{id}/file

Lire un fichier relatif à la racine de l'espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
pathrequêteouiChemin de fichier relatif à l'espace de travail requis.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Écrire un fichier de l’espace de travail

PUT /v1/workspace/{id}/file

Créer ou remplacer le contenu du fichier sélectionné.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
pathrequêteouiChemin de fichier relatif à l'espace de travail requis.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Supprimer le fichier de l’espace de travail

DELETE /v1/workspace/{id}/file

Supprimer le fichier d'espace de travail sélectionné.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.
pathrequêteouiChemin de fichier relatif à l'espace de travail requis.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Déplacer le fichier de l’espace de travail

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

Déplacer un fichier dans l'espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Exécuter le lint de l’espace de travail

POST /v1/workspace/{id}/commands

Exécutez la commande de lint configurée de l’espace de travail. kind prend en charge lint

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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

Remplacez YOUR_* du corps avant l’envoi. Le heredoc entre guillemets préserve le JSON littéral.

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Obtenir le statut de commande de l'espace de travail

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

Inspecter une commande d'espace de travail précédemment soumise.

Définissez workspace_id, command_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
command_idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Obtenir les journaux des commandes de l'espace de travail

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

Lire les journaux d’une commande de l’espace de travail.

Définissez workspace_id, command_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
command_idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Obtenir l’état d’exécution de l’espace de travail

GET /v1/workspace/{id}/run

Inspecter l’environnement d’exécution de l’aperçu de l’espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Démarrer l'aperçu de l'espace de travail

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

Démarrez l’environnement d’exécution de l’aperçu de l’espace de travail. Cela peut consommer des ressources payantes.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Arrêter l'aperçu de l'espace de travail

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

Arrêter l’environnement d’exécution de l’aperçu de l’espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Redémarrer l'aperçu de l'espace de travail

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

Redémarrer l’environnement d’exécution de l’aperçu de l’espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Cette requête modifie des données ou lance une action. Vérifiez la cible et le corps avant de l’envoyer.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Obtenir l’état Git de l’espace de travail

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

Inspecter la branche actuelle et les changements locaux.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Obtenir l’historique Git de l’espace de travail

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

Lire les commits récents de l'espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Lister les branches Git de l’espace de travail

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

Lister les branches disponibles dans l'espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Vérifier le manifeste de l'espace de travail

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

Valider le manifeste Adios de l’espace de travail.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.

Obtenir l’inventaire des tests de l’espace de travail

GET /v1/workspace/{id}/tests

Inspecter les tests détectés et la configuration des tests.

Définissez workspace_id en utilisant les ID de vos propres réponses API.

Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.

Paramètres

NomEmplacementRequisDescription
idcheminouiIdentifiant de ressource issu des résultats API de votre équipe.
X-Tenant-IDen-têteouiID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic.

Exemple de requête

Définissez ADIOS_API_URL=https://api.adios.dev. Pour les requêtes protégées, définissez ADIOS_ACCESS_TOKEN et ADIOS_TEAM_ID comme dans le démarrage rapide. Définissez les autres variables ADIOS_* à partir des résultats de vos propres ressources.

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"

Réponse : HTTP 200

Réponse réussie. Inspectez l’état renvoyé pour les opérations qui démarrent un travail asynchrone.

Aucun schéma complet du corps de réponse n’est publié pour cette opération personnalisée. Inspectez le contenu renvoyé et le statut ; aucun format de données n’est présumé ici.