Getting Started

To use ADM APIs, Citrix customer must have the following in each API request:

• Citrix CustomerID: Citrix-CustomerId in a request header.
• CCAuth Token: Secure HTTP requests sent to Citrix Cloud (CC) uses a custom Authorization header that contains a CC bearer token. Bearer tokens are required for actions that take place on behalf of a user.

Following are the steps to make request to ADM APIs from a client:

1. Set Authorization and Citrix-CustomerId headers.
2. Add a JSON Payload to the request, if any.
3. Send HTTP Request.
4. Handle any error responses.
5. Process the response displayed in JSON.

Customer ID

Customer ID is a mandatory parameter that must be passed in Citrix-CustomerId header. To get the customer ID:

1. Log in to the Citrix Cloud.
2. Select the Identity and Access Management option from the menu.
3. Click API Access tab. You can see the customer ID in the description above the Create Client button.

CC Auth Token

CC Auth token can be obtained through API Client ID and Secret. To get Client ID and Secret:

1. Log in to the Citrix Cloud.
2. Go to Identity and Access Management page.
3. In the API Access tab, locate Create Client button.
4. Provide the Client Name and click Create Client button. The Client ID and Secret is created.

Request and Response

The following is how a typical Request and Response looks like:

POST https://adm.cloud.com/massvc/masproductio/nitro/v2/config/device_group

Request

{
"device_group"
{
    "name": "API-Demo-Group",
    "device_family": "ns",
    "category":"default",
    "static_device_list_arr": ["10.106.150.184","10.106.154.192"]
}
}

Parameters

• name - This parameter is the name of new instance group.
• device_family - Instance family.
• category - Category.Default or Upgrade
• static_device_list_arr - Array of instance IPs.

Response -201 Created

{
"device_group":
[
  {
          "id": "7fa4938c-1373-44d0-8c5c-c44d87313fc2",
          "criteria_condn": "",
          "criteria_value": "",
          "criteria_type": "",
          "upgrade_version": "",
          "lock_acquire_time": "",
          "static_device_list": "10.106.150.184,10.106.154.192",
          "tenant_id": "37170931-1f35-4ddc-876f-5061e7b5eba3",
          "lock_acquiring_device": "",
          "disable_upgrade": "false",
          "device_family": "ns",
          "category": "default",
          "duration": "60",
          "maintenance_window_start": "",
          "upgrade_lock": "false",
          "name": "API-Demo-Group",
          "static_device_list_arr": ["10.106.150.184", "10.106.154.192"]
  }
]

}