Get instance configuration

edit

Get instance configuration by id.

Request

edit

GET /api/v1/platform/configuration/instances/{id}

Path parameters

edit
Name Type Required Description

id

string

Y

ID of the instance configuration

Query parameters

edit
Name Type Required Description

config_version

integer

N

Optionally retrieve the specified config version of the IC (otherwise retrieves the latest/only version)

show_deleted

boolean

N

If true, if the instance configuration has been marked for deletion it is still returned. Otherwise, instance configurations marked for deletion generate a 404

show_max_zones

boolean; default: false

N

If true, will populate the max_zones field of the instance configuration.

Responses

edit
200

(InstanceConfiguration)

An InstanceConfiguration

404

(BasicFailedReply)

Instance configuration specified by {id} cannot be found (code: 'configuration.instance_configuration_not_found')

Request example

edit
curl -XGET https://{{hostname}}/api/v1/platform/configuration/instances/{id} \
-H "Authorization: ApiKey $ECE_API_KEY"