DocumentationExperience PlatformGuide des sandbox

Point d’entrée des sandbox disponibles

Dernière mise à jour : 24 mai 2026

Créé pour :

  • Developer
NOTE
Contrairement aux autres points d’entrée fournis dans l’API Sandbox, ce point d’entrée est disponible pour tous les utilisateurs, y compris ceux ne disposant pas d’autorisations d’accès d’administration Sandbox.

Vous pouvez répertorier les sandbox disponibles pour l’utilisateur actuel en adressant une requête GET au point d’entrée des sandbox disponibles.

Format d’API

GET /{QUERY_PARAMS}
Paramètre
Description
{QUERY_PARAMS}
Paramètres de requête facultatifs en fonction desquels filtrer les résultats. Voir le document annexe pour obtenir une liste des paramètres disponibles.

Requête

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/?limit=3&offset=1 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}'

Réponse

Une réponse réussie renvoie une liste de sandbox disponibles pour l’utilisateur actuel, y compris des détails tels que name, title, state et type.

{
    "sandboxes": [
        {
            "name": "prod",
            "title": "Production",
            "state": "active",
            "type": "production",
            "region": "VA7",
            "isDefault": true,
            "eTag": 2,
            "createdDate": "2019-09-04 04:57:24",
            "lastModifiedDate": "2019-09-04 04:57:24",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "dev",
            "title": "Development",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        },
        {
            "name": "stage",
            "title": "Staging",
            "state": "active",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-03 22:27:48",
            "lastModifiedDate": "2019-09-03 22:27:48",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        }
    ],
    "_page": {
        "limit": 3,
        "count": 1
    },
    "_links": {
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/?limit={limit}&offset={offset}",
            "templated": true
        }
    }
}
Propriété
Description
name
Le nom du sandbox. Utilisé à des fins de recherche dans les appels API.
title
Le nom d’affichage du sandbox.
state

L’état de traitement actuel du sandbox. Un sandbox peut avoir l’un des états suivants :

  • creating : le sandbox a été créé, mais est toujours en cours d’approvisionnement par le système.
  • active : le sandbox est créé et actif.
  • failed : en raison d’une erreur, le sandbox n’a pas pu être configuré par le système et est désactivé.
  • deleted : le sandbox a été désactivé manuellement.
type
Le type de sandbox : « développement » ou « production ».
isDefault
Propriété booléenne indiquant si ce sandbox est le sandbox de production par défaut de l’organisation.
eTag
L’identifiant d’une version spécifique du sandbox. Utilisée pour le contrôle des versions et une mise en cache efficace, cette valeur est mise à jour chaque fois que le sandbox est modifié.
recommendation-more-help
experience-platform-help-sandboxes