1. Docs
  2. API Reference
  3. Export an Environment's configuration as JSON

Export an Environment's configuration as JSON

GET/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/{envSlug}/export

Returns the Environment's configuration (resolved by :envSlug) as a versioned JSON document: format_version, source_env, access_model, hierarchy_schema, and the env's permissions, roles with their permission keys, hierarchy nodes (ref-linked), OAuth client configs, and webhook configs. Secrets are deliberately omitted — OAuth client secrets and webhook signing secrets are not included. The export is read-only and does not modify the Environment; returns 404 when the slug does not exist.

Authentication

Bearer TokenAuthorization

JWT access token. Never send alongside X-API-Key: a request carrying both is refused.

Requires capability applications.manageDeveloper Console

Create, edit, and delete Applications and Environments. Granted through an administrator role in the Admin Workspace; a valid token without it is refused with 403.

Path Parameters

envSlugstring Required

Responses

application/json

  • dataEnvironmentExportDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

application/json

  • errorApiErrorBodyDto*

Errors

When the request can't be completed, the response body includes a stable error code you can branch on.

403account.capability_requiredForbidden
When it happens

The signed-in user's administrator roles do not grant the capability this endpoint requires.

Remediation

Ask an account administrator to grant a role carrying the capability named in the Authentication section, then retry.

Returned object

EnvironmentExportDtoView all properties on this resource
Request
curl -X GET "https://auth.canopy-io.com/portal/v1/accounts/{accountSlug}/applications/{appSlug}/environments/value/export" \
  -H "Authorization: Bearer $CANOPY_TOKEN"
Response
{
  "data": {
    "format_version": 1,
    "source_env": {},
    "access_model": "flat",
    "organizations_enabled": false,
    "hierarchy_schema": {},
    "permissions": [
      null
    ],
    "roles": [
      null
    ],
    "nodes": [
      null
    ],
    "oauth_clients": [
      null
    ],
    "webhooks": [
      null
    ]
  }
}
 Related endpoints
GETList Environments in an Application
POSTCreate a new Environment in an Application
GETGet a single Environment by slug
PATCHRename or re-slug an Environment
DELETEDelete an Environment
GETGet an Environment's sign-in settings
PATCHChange an Environment's sign-in settings
POSTReplace an Environment's configuration from a JSON payload (destructive)
GETGet the Environment's access model
PUTSwitch the Environment's access model
PUTSwitch the Environment's organizations container on or off
GETGet hierarchy schema for the active Environment
PATCHUpdate hierarchy schema for the active Environment
GETList hierarchy node types with existing nodes
POSTRevert this Environment from hierarchy to flat
 Was this page helpful?

Tell us how we can improve this guide.

Canopy