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.
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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
page | requête | non | Numéro de page |
per_page | requête | non | É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
| Champ | Type | Description |
|---|---|---|
data | tableau | |
data[].base_build_id | chaîne | |
data[].base_source_artifact_id | chaîne | Enregistrement API de l’artefact source utilisé pour charger l’espace de travail |
data[].branch | chaîne | |
data[].created_at | entier | (horodatage Unix) |
data[].deleted_at | entier | (horodatage Unix) |
data[].metadata | objet | |
data[].name | chaîne | |
data[].owner_id | chaîne | |
data[].repository_url | chaîne | URL du dépôt Git |
data[].runtime_status | chaîne | Valeurs autorisées : idle, running, stopped, failed. |
data[].source_manifest | chaîne | Chemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail |
data[].source_workdir | chaîne | Répertoire de travail du projet dans la racine du code source composé de l’espace de travail |
data[].status | chaîne | Valeurs autorisées : active, archived, deleted. |
data[].team_id | chaîne | |
data[].updated_at | entier | (horodatage Unix) |
data[].workload_id | chaîne | |
data[].workspace_id | chaîne | |
pagination | objet | |
pagination.page | entier | Numéro de page actuel |
pagination.per_page | entier | Nombre d’éléments par page |
pagination.total | entier | Nombre 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) :
| Champ | Type | Requis | Description |
|---|---|---|---|
base_build_id | chaîne | non | |
base_source_artifact_id | chaîne | non | Enregistrement API de l’artefact source utilisé pour charger l’espace de travail. Valeur par défaut : "". |
branch | chaîne | non | Valeur par défaut : "". |
metadata | objet | non | |
name | chaîne | oui | |
owner_id | chaîne | oui | |
repository_url | chaîne | non | URL du dépôt Git |
runtime_status | chaîne | non | Valeurs autorisées : idle, running, stopped, failed. Valeur par défaut : "idle". |
source_manifest | chaîne | non | Chemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : "adios.yaml". |
source_workdir | chaîne | non | Répertoire de travail du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : ".". |
status | chaîne | oui | Valeurs autorisées : active, archived, deleted. Valeur par défaut : "active". |
team_id | chaîne | oui | |
workload_id | chaîne | non | Valeur par défaut : "". |
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
X-Tenant-ID | en-tête | oui | ID 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
| Champ | Type | Description |
|---|---|---|
base_build_id | chaîne | |
base_source_artifact_id | chaîne | Enregistrement API de l’artefact source utilisé pour charger l’espace de travail |
branch | chaîne | |
created_at | entier | (horodatage Unix) |
deleted_at | entier | (horodatage Unix) |
metadata | objet | |
name | chaîne | |
owner_id | chaîne | |
repository_url | chaîne | URL du dépôt Git |
runtime_status | chaîne | Valeurs autorisées : idle, running, stopped, failed. |
source_manifest | chaîne | Chemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail |
source_workdir | chaîne | Répertoire de travail du projet dans la racine du code source composé de l’espace de travail |
status | chaîne | Valeurs autorisées : active, archived, deleted. |
team_id | chaîne | |
updated_at | entier | (horodatage Unix) |
workload_id | chaîne | |
workspace_id | chaî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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Champ | Type | Description |
|---|---|---|
base_build_id | chaîne | |
base_source_artifact_id | chaîne | Enregistrement API de l’artefact source utilisé pour charger l’espace de travail |
branch | chaîne | |
created_at | entier | (horodatage Unix) |
deleted_at | entier | (horodatage Unix) |
metadata | objet | |
name | chaîne | |
owner_id | chaîne | |
repository_url | chaîne | URL du dépôt Git |
runtime_status | chaîne | Valeurs autorisées : idle, running, stopped, failed. |
source_manifest | chaîne | Chemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail |
source_workdir | chaîne | Répertoire de travail du projet dans la racine du code source composé de l’espace de travail |
status | chaîne | Valeurs autorisées : active, archived, deleted. |
team_id | chaîne | |
updated_at | entier | (horodatage Unix) |
workload_id | chaîne | |
workspace_id | chaî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) :
| Champ | Type | Requis | Description |
|---|---|---|---|
base_build_id | chaîne | non | |
base_source_artifact_id | chaîne | non | Enregistrement API de l’artefact source utilisé pour charger l’espace de travail. Valeur par défaut : "". |
branch | chaîne | non | Valeur par défaut : "". |
metadata | objet | non | |
name | chaîne | oui | |
owner_id | chaîne | oui | |
repository_url | chaîne | non | URL du dépôt Git |
runtime_status | chaîne | non | Valeurs autorisées : idle, running, stopped, failed. Valeur par défaut : "idle". |
source_manifest | chaîne | non | Chemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : "adios.yaml". |
source_workdir | chaîne | non | Répertoire de travail du projet dans la racine du code source composé de l’espace de travail. Valeur par défaut : ".". |
status | chaîne | oui | Valeurs autorisées : active, archived, deleted. Valeur par défaut : "active". |
team_id | chaîne | oui | |
workload_id | chaîne | non | Valeur par défaut : "". |
Authentification : jeton bearer et en-tête d’équipe présentés ci-dessous.
Paramètres
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Champ | Type | Description |
|---|---|---|
base_build_id | chaîne | |
base_source_artifact_id | chaîne | Enregistrement API de l’artefact source utilisé pour charger l’espace de travail |
branch | chaîne | |
created_at | entier | (horodatage Unix) |
deleted_at | entier | (horodatage Unix) |
metadata | objet | |
name | chaîne | |
owner_id | chaîne | |
repository_url | chaîne | URL du dépôt Git |
runtime_status | chaîne | Valeurs autorisées : idle, running, stopped, failed. |
source_manifest | chaîne | Chemin du manifeste Adios du projet dans la racine du code source composé de l’espace de travail |
source_workdir | chaîne | Répertoire de travail du projet dans la racine du code source composé de l’espace de travail |
status | chaîne | Valeurs autorisées : active, archived, deleted. |
team_id | chaîne | |
updated_at | entier | (horodatage Unix) |
workload_id | chaîne | |
workspace_id | chaî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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Champ | Type | Description |
|---|---|---|
message | chaî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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
path | requête | non | Ré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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
path | requête | oui | Chemin 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
path | requête | oui | Chemin 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID de l’équipe active. Doit correspondre au tenant lié au jeton de diagnostic. |
path | requête | oui | Chemin 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
command_id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
command_id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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
| Nom | Emplacement | Requis | Description |
|---|---|---|---|
id | chemin | oui | Identifiant de ressource issu des résultats API de votre équipe. |
X-Tenant-ID | en-tête | oui | ID 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.