Cisco AppDynamics Agent Principal Management API is currently beta and is subject to change. Therefore, if you adopt a beta API, future versions may not be fully compatible.

Agents gain system access by presenting their agent-principal credentials as a client ID and secret to obtain a time-limited use token for consuming platform APIs. For example, you can use the Agent Principal to consume Cisco AppDynamics data ingest APIs.

Principal Management API allows users to create, edit, and manage non-human identities using predefined service endpoints. 

These API methods are distinct per Cloud Tenant and not per company account.

Administrators can use the Agent Principal Management API to:

  • Create new agent credentials.

  • Delete a given agent permanently.

  • List all or selected registered agents with filtering.

  • Rotate secrets for the Agent Principal. 
  • Update the agent details of a given client.

  • Generate a new client secret for the agent client.

To begin using this API, you need a Service Principal and a valid JSON Web Token (JWT). To generate and use the token, see Call the Cisco Cloud Observability APIs.

Agent Endpoints

The syntax for the agent endpoints is as follows:

  • Server URL: https://tenantName.observe.appdynamics.com/administration/v1beta/
  • Example:  https://tenantName.observe.appdynamics.com/administration/v1beta/{endpoint}

The Agent Principal Management API enables you to perform the following operations with the following endpoints:

Agent Principals are only able to ingest data. Service Principals can consume all APIs except data ingest.

Operation

Endpoint (per Tenant)

Description

GET/clients/agentsList all registered agent clients or use an optional filter query.
POST/clients/agentsCreate new agent client credentials.
GET/clients/agents/{clientId}Get the agent client details for a given agent client.
PUT/clients/agents/{clientId}Update the agent client details of a given agent client.
DELETE/clients/agents/{clientId}Delete a given agent client permanently.
GET/clients/agents/{clientId}/secret/rotateRotates the secret for a given agent client. A new client secret will be returned.

Next Steps

To get started using the APIs, see the following sections in the AppDynamics Application Principal Management Service API documentation: