Pairing Profiles and Pairing Keys
The Public Stable API for pairing profiles gets, creates, updates, and deletes pairing profiles.
About Pairing Profiles and Keys
Pairing Profiles apply specific properties to workloads as they pair with the PCE, such as labels and the workload policy state.
When you configure a pairing profile, the pairing script contains a unique pairing key (activation code) at the end that securely identifies the VEN so it can authenticate with the PCE. You can configure a pairing key for one-time use or more, and set time and use limits.
The Pairing Key API can generate a new pairing key from a specified pairing profile.
Pairing Profile Methods
Functionality | HTTP | URI |
|---|---|---|
Get a collection of pairing profiles. |
|
|
Get the specified pairing profile. |
|
|
Create an individual pairing profile. |
|
|
Update an individual pairing profile. |
|
|
Delete an individual pairing profile. |
|
|
Get Pairing Profiles
This method enables you to retrieve a collection of all pairing profiles in your organization or a specific pairing profile.
By default, the maximum number of pairing profiles returned in a GET collection is 500. For more than 500 pairing profiles, use Asynchronous GET Collection.
Create a Pairing Profile
This method creates an individual pairing profile. The only required parameter for the POST method is enabled; others are optional.
URI to Create a Pairing Profile
POST [api_version][org_href]/pairing_profiles
Update a Pairing Profile
To update a pairing profile, specify its HREF, which can be obtained from getting a collection of pairing profiles.
URI to Update a Pairing Profile
PUT [api_version][pairing_profile_href]
Delete a Pairing Profile
To delete an individual pairing profile, specify its HREF, which you can obtain from a collection of pairing profiles.
URI to Delete a Pairing Profile
DELETE [api_version][pairing_profile_href]
Pairing Key API Method
Functionality | HTTP | URI |
|---|---|---|
Create a pairing key |
|
|
Create a Pairing Key
To create a pairing key, you need to pass a pairing profile HREF as a parameter. You can obtain the pairing profile HREF from the pairing profile page in the PCE web console.
A pairing key is governed by the parameters configured in the pairing profile.
URI to Create a Pairing Key
Obtain the pairing key HREF from the response body returned by an API call to get a collection of pairing keys.
POST [api_version][pairing_key_href]/pairing_key