Hello world

Contributors netapp-ranuk dmp-netapp

You can issue a curl command to get started using the Cloud Volumes ONTAP REST API and confirm its availability.

Note The example provided below is very simple. The workflow samples later in this guide use a more robust format. As a start, see Workflow processes.
Before you begin

You must do the following:

  • Determine the identifier to use for the x-agent-id request header as well as the related client ID. See Get required identifiers.

  • Acquire an access token for the Authorization request header. See Create user token.

curl example

The following curl command retrieves information about the BlueXP (formerly Cloud Manager) server.

curl --location --request GET 'https://cloudmanager.cloud.netapp.com/occm/api/occm/system/about' --header 'Content-Type: application/json' --header 'x-agent-id: <AGENT_ID>' --header 'Authorization: Bearer <ACCESS_TOKEN>'
  • Replace <AGENT_ID> with your agent ID.

  • Replace <ACCESS_TOKEN> with the bearer access token.

Output example

Information about the system is provided in the following format.

  "version": "string",
  "build": "string",
  "buildTimestamp": "integer",
  "systemId": "string",
  "environment": "string",
  "siteIdentifier": {
    "company": "string",
    "host": "string",
    "site": "string"
  "serverTimeZone": {
    "timeZoneName": "string",
    "formattedTimeZone": "string"
  "beta": "boolean",
  "releaseNumber": "integer",
  "simplicatorUrl": "string",
  "migrationPerformed": "boolean",
  "demoMode": "boolean",
  "usingDockerInfra": "boolean",
  "privateIp": "string"