Skip to main content

Get systems

Contributors netapp-aoife

You can retrieve the on-premises system details such as the public identifier, name, and type of the system, the storage VM name, the cluster properties, and more. These details can be used in the input body field while executing other on-prem workflows.

HTTP method and endpoint

This REST API call uses the following method and endpoint.

HTTP method Path

GET

occm/api/onprem/working-environments
Curl example
curl --request GET \
--location "https://api.bluexp.netapp.com/occm/api/onprem/working-environments/<ONPREM_WORKING_ENV_ID>" \
--header "Content-Type: application/json" \
--header "x-agent-id: <AGENT_ID>"" \
--header "Authorization: Bearer <ACCESS_TOKEN>"
JSON output example

The JSON output example includes on-premises system details.

{
  "publicId": "OnPremWorkingEnvironment-xxxx",
  "tenantId": "Tenant-zzxx",
  "description": "",
  "name": "onpremwe",
  "discoverUserEmail": "user_email@domain.com",
  "location": "ON_PREM",
  "reservedSize": null,
  "status": null,
  "interClusterLifs": null,
  "cronJobSchedules": null,
  "svms": null,
  "snapshotPolicies": null,
  "replicationProperties": null,
  "clusterProperties": null,
  "ontapClusterProperties": null,
  "workingEnvironmentType": "ON_PREM",
  "cloudSyncProperties": null,
  "actionsRequired": null,
  "capacityFeatures": null,
  "aff": false,
  "cbsProperties": null,
  "complianceProperties": null,
  "monitoringProperties": null
}