Configuration Profile APIs
With the configuration profile APIs, you can get, create, update, and delete the configuration profiles. We also support direct assignment of configuration profiles and fetching the Cloud Agents which were assigned configuration profiles using direct assignment APIs.
The following are the APIs to manage the Configuration Profiles associated with the new Cloud Agent Configuration Profile user interface.
- Authentication API
- Get Configuration Profile
- Create Configuration Profile
- Update Configuration Profile
- Update Profile Priority
- Delete Configuration Profile
- Directly Assign the Configuration Profile to the Agents
- Fetch Cloud Agents Assigned via Direct Assignment API
The following table illustrates the mapping of new Configuration profile APIs to legacy APIs:
| API Name | Legacy Configuration Profile APIs | New Configuration Profile APIs | Description |
|---|---|---|---|
| Get Configuration Profile | [GET][POST] /qps/rest/1.0/get/ca/agentconfig/<id> | [GET]/caui/v1/config-profiles | This API retrieves details of the selected configuration profile in the user account. |
| [POST] /qps/rest/1.0/search/ca/agentconfig | This API retrieves the details of configuration profiles associated to a user account. | ||
| Create Configuration Profile | [POST] /qps/rest/1.0/create/ca/agentconfig | [POST]/caui/v1/config-profiles | This API creates a new configuration profile record. |
| Update Configuration Profile | [POST] /qps/rest/1.0/update/ca/agentconfig | [PUT]/caui/v1/config-profiles | This API updates the configuration profile in the user's account. |
| Delete Configuration Profile | [POST] /qps/rest/1.0/delete/ca/agentconfig/<id> | [DELETE]/caui/v1/config-profiles/<id> | Delete a configuration profile in the user’s account. |
| Update Profile Priority | NA | [PUT]/caui/v1/config-profiles/priority | This API updates the priority of the selected configuration profile. |
| Directly Assign the Configuration Profile to the Agents | NA | [PUT] /caui/v1/config-profiles/direct-assign/<profile_id> | You can use this API to assign configuration profiles to Cloud Agents by specifying their host assets in the API request. |
| Fetch Cloud Agents Assigned via Direct Assignment | NA | [GET] /caui/1.0/config-profiles/<profile-id>/agents | Using this API you can generate the list of Cloud Agents for which the configuration profile is assigned using direct assignment API. |
We recommend using the new Configuration Profile APIs to manage the configuration profiles. However, if you are using the legacy Cloud Agent user interface, you can refer to legacy Configuration Profile APIs.