Retrieves a list of environments for baseUrl and apiKey

POST 
https://api.spectrocloud.com/v1/clouds/coxedge/environments

Authorization: ApiKey

name: ApiKeytype: apiKeydescription: API key authorization where API key can be generated from Palette console under Profile > My API Keysin: header

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"
    }
  ]
}

• curl
• python
• go
• nodejs
• java

• CURL

curl -L -X POST 'https://api.spectrocloud.com/v1/clouds/coxedge/environments' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'ApiKey: <API_KEY_VALUE>' \
--data-raw '{
  "credentials": {
    "apiBaseUrl": "string",
    "apiKey": "string"
  },
  "organizationId": "string"
}'

Request Collapse all

Base URL

https://api.spectrocloud.com

Auth

Security Scheme

ApiKeyAuthorization

ApiKey

Parameters

ProjectUid — header

Body required

{
  "credentials": {
    "apiBaseUrl": "string",
    "apiKey": "string"
  },
  "organizationId": "string"
}