Skip to main content

Retrieve working environments

Contributors

GET /account/{accountId}/providers/cloudmanager_cbs/api/v1/working-environment

Retrieves a list of working environments and their details. This API endpoint retrieves the name, region, status, type, cloud-provider, provider-accountId, ontap-version, and total-volumes-count information.

Token usage: BlueXP user token.

Parameters

Name Type In Required Description

partial

boolean

query

False

accountId

string

path

True

authorization

string

header

True

x-agent-id

string

header

True

Response

Status: 200, Default response
Name Type Required Description

working-environment

array[working-environment]

False

Example response
{
  "working-environment": [
    {
      "id": "string",
      "cluster-uuid": "string",
      "name": "string",
      "region": "string",
      "status": "string",
      "ontap-version": "string",
      "type": "string",
      "provider": "string",
      "provider-account-id": "string",
      "total-volumes-count": "string"
    }
  ]
}

Definitions

See Definitions

working-environment

Name Type Required Description

id

string

False

cluster-uuid

string

False

name

string

False

region

string

False

status

string

False

ontap-version

string

False

type

string

False

provider

string

False

provider-account-id

string

False

AWS account ID/ Azure subscription ID / Google Cloud project ID

total-volumes-count

string

False