Endpoint de gerenciamento de sandbox

Última atualização: 4 de abril de 2025
  • Tópicos:

Criado para:

  • Desenvolvedor

As sandboxes na Adobe Experience Platform fornecem ambientes de desenvolvimento isolados que permitem testar recursos, executar experimentos e fazer configurações personalizadas sem afetar o ambiente de produção. O ponto de extremidade /sandboxes na API Sandbox permite gerenciar sandboxes programaticamente no Experience Platform.

Introdução

O ponto de extremidade de API usado neste guia faz parte da Sandbox API. Antes de continuar, consulte o guia de introdução para obter links para a documentação relacionada, um guia para ler as chamadas de API de exemplo neste documento e informações importantes sobre os cabeçalhos necessários para fazer chamadas com êxito para qualquer API do Experience Platform.

Recuperar uma lista de sandboxes

Você pode listar todas as sandboxes pertencentes à sua organização (ativa ou não) fazendo uma solicitação GET para o ponto de extremidade /sandboxes.

Formato da API

GET /sandboxes?{QUERY_PARAMS}
ParâmetroDescrição
{QUERY_PARAMS}Parâmetros de consulta opcionais para filtrar os resultados. Consulte a seção sobre parâmetros de consulta para obter mais informações.

Solicitação

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

Resposta

Uma resposta bem-sucedida retorna uma lista de sandboxes pertencentes à sua organização, incluindo detalhes como name, title, state e 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}"
        },
        {
            "name": "dev-2",
            "title": "Development 2",
            "state": "creating",
            "type": "development",
            "region": "VA7",
            "isDefault": false,
            "eTag": 1,
            "createdDate": "2019-09-07 10:16:02",
            "lastModifiedDate": "2019-09-07 10:16:02",
            "createdBy": "{USER_ID}",
            "modifiedBy": "{USER_ID}"
        }
    ],
    "_page": {
        "limit": 4,
        "count": 4
    },
    "_links": {
        "next": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes/?limit={limit}&offset={offset}",
            "templated": true
        },
        "prev": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=0&limit=1",
            "templated": null
        },
        "page": {
            "href": "https://platform.adobe.io:443/data/foundation/sandbox-management/sandboxes?offset=1&limit=1",
            "templated": null
        }
    }
}
PropriedadeDescrição
nameO nome da sandbox. Essa propriedade é usada para fins de pesquisa em chamadas de API.
titleO nome de exibição da sandbox.
state

O estado de processamento atual da sandbox. O estado de uma sandbox pode ser qualquer um dos seguintes:

  • creating: a sandbox foi criada, mas ainda está sendo provisionada pelo sistema.
  • active: a sandbox foi criada e está ativa.
  • failed: devido a um erro, a sandbox não pôde ser provisionada pelo sistema e está desabilitada.
  • deleted: a sandbox foi desabilitada manualmente.
typeO tipo de sandbox. Os tipos atuais de sandbox compatíveis incluem development e production.
isDefaultUma propriedade booleana que indica se essa sandbox é a sandbox de produção padrão da organização.
eTagUm identificador para uma versão específica da sandbox. Usado para controlar a versão e a eficiência do armazenamento em cache, esse valor é atualizado sempre que uma alteração é feita na sandbox.

Pesquisar uma sandbox

Você pode pesquisar uma sandbox individual fazendo uma solicitação GET que inclui a propriedade name da sandbox no caminho da solicitação.

Formato da API

GET /sandboxes/{SANDBOX_NAME}
ParâmetroDescrição
{SANDBOX_NAME}A propriedade name da sandbox que você deseja pesquisar.

Solicitação

A solicitação a seguir recupera uma sandbox chamada "dev-2".

curl -X GET \
  https://platform.adobe.io/data/foundation/sandbox-management/sandboxes/dev-2 \
  -H 'Authorization: Bearer {ACCESS_TOKEN}' \
  -H 'x-api-key: {API_KEY}' \
  -H 'x-gw-ims-org-id: {ORG_ID}' \

Resposta

Uma resposta bem-sucedida retorna os detalhes da sandbox, incluindo suas name, title, state e type.

{
    "name": "dev-2",
    "title": "Development 2",
    "state": "creating",
    "type": "development",
    "region": "VA7",
    "isDefault": false,
    "eTag": 1,
    "createdDate": "2019-09-07 10:16:02",
    "lastModifiedDate": "2019-09-07 10:16:02",
    "createdBy": "{USER_ID}",
    "modifiedBy": "{USER_ID}"
}
PropriedadeDescrição
nameO nome da sandbox. Essa propriedade é usada para fins de pesquisa em chamadas de API.
titleO nome de exibição da sandbox.
state

O estado de processamento atual da sandbox. O estado de uma sandbox pode ser qualquer um dos seguintes:

  • criando: a sandbox foi criada, mas ainda está sendo provisionada pelo sistema.
  • ativo: a sandbox foi criada e está ativa.
  • falha: devido a um erro, a sandbox não pôde ser provisionada pelo sistema e está desabilitada.
  • excluído: a sandbox foi desabilitada manualmente.
typeO tipo de sandbox. Os tipos atuais de sandbox compatíveis incluem: development e production.
isDefaultUma propriedade booleana que indica se essa sandbox é a sandbox padrão da organização. Normalmente, essa é a sandbox de produção.
eTagUm identificador para uma versão específica da sandbox. Usado para controlar a versão e a eficiência do armazenamento em cache, esse valor é atualizado sempre que uma alteração é feita na sandbox.