Retrieves a list of environments for baseUrl and apiKey

POST 
/v1/clouds/coxedge/environments

Retrieves a list of environments for baseUrl and apiKey

Request

Header Parameters

ProjectUid string

Scope the request to the specified project uid

application/json

Body

required

Request payload to get CoxEdge environments

credentials

object

CoxEdge credentials to get organizations

apiBaseUrlstring

CoxEdge baseUrl - for api calls

apiKeystring

CoxEdge ApiKey - secret for api calls

organizationIdstring

CoxEdge organizationId

Responses

200

List of CoxEdge environments

application/json

Schema

Schema

environments

object[]

required

Array [

idstring

CoxEdge environment id

isDeletedboolean

CoxEdge environment state

namestring

CoxEdge environment name

]

Example (from schema)

{
  "environments": [
    {
      "id": "string",
      "isDeleted": true,
      "name": "string"
    }
  ]
}

Loading...