Remote environments API - GET all environments

Lists all remote environment configurations.

The request produces an application/json payload.

This request is an Early Adopter release and may be changed in non-compatible way.

  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/remoteEnvironments
  • SaaS https://{your-environment-id}


The request doesn't provide any configurable parameters.

Response format

The RemoteEnvironmentConfigListDto object

Element Type Description
values RemoteEnvironmentConfigStubDto[]

The RemoteEnvironmentConfigStubDto object

Element Type Description
networkScope string
uri string
description string
name string
id string


In this example, the request asks for a list of all the remote environment configurations in the mySampleEnv environment.

The API token is passed in the Authorization header.

The result is truncated to two entries.


curl -X GET \ \
  -H 'Accept: application/json; charset=utf-8' \
  -H 'Authorization: Api-token abcdefjhij1234567890'

Request URL

Response body

  "values": [
      "id": "b597955c-4706-40f6-b188-212faba25e1f",
      "name": "Production North",
      "uri": "",
      "networkScope": "EXTERNAL"
      "id": "4f3b0f62-6ec0-407d-be50-5109a8516edf",
      "name": "Production South",
      "uri": "",
      "networkScope": "EXTERNAL"

Response code