Remote environments API - GET a remote environment configuration

Gets the properties of the specified remote environment configuration.

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/{id}
  • SaaS https://{your-environment-id}{id}


Parameter Type Description In Required
id string path required

Response format

The RemoteEnvironmentConfig object

Element Type Description
id string

The ID of the entity.

displayName string

The display name of the entity

uri string

URI that already contains tenant information

token string

API-Token to use for forwarding REST requests to remote environment

networkScope string

Scope of the target environment, if not set external is used. EXTERNAL: Target lives within other network (Only possible value for SAAS cluster) INTERNAL: Target lives within same network CLUSTER: Target lives within the same cluster


In this example, the request inquires about the properties of the Production North remote environment, which has the ID b597955c-4706-40f6-b188-212faba25e1f.

The API token is passed in the Authorization header.


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

Request URL

Response body

  "id": "b597955c-4706-40f6-b188-212faba25e1f",
  "displayName": "Production North",
  "uri": "",
  "token": null,
  "networkScope": "EXTERNAL"

Response code