Synthetic Credential Vault API

The Synthetic Credential Vault API allows administrators to manage credentials securely. This documentation provides details on how to create, list, update, and upload credentials using the API.

Prerequisites

Ensure that:

  • You have an administrator role to create an API client.
  • API clients have the Manage Credential Vault permission to perform LIST, CREATE, UPDATE, and UPLOAD actions.
  • API clients have the Manage Self Credential permission to view credential values.

Associate a Role

To associate a role with an API client:

  1. Navigate to Settings > Administration > Roles.
  2. Create a custom role.
  3. Associate the role with either Manage Credential Vault permission or Manage Self Credential Permission.
  4. Assign the role to the API client.

Base URL 

https://<controller-url>/controller/restui/eumSyntheticCredentialsUiService/

Create a Credential Vault

Creates a new credential vault from the specified JSON payload.

Resource URL

POST <controller- url>/controller/restui/eumSyntheticCredentialsUiService/create

Request/Response Format

JSON

Example

This example creates a single key-value pair in the credential vault.

Request
{
"credentials": [
{
"credentialName": "URL",
"credentialValue": "https//www.appdynamics.com/"
}
]
}
Response
Status code 204. No response body returned.

Retrieve all Credentials Key-Value Pairs

This API displays all the available credential key-value pairs.

Resource URL

POST <controller- url>/controller/restui/eumSyntheticCredentialsUiService/data

Response Format

JSON

Example Response

{
"sortDirection": "ASC",
"sortColumnName": "KEY",
"searchString": "",
"pageOffsetKey": null
}

Retrieve Credential Key-Value Pair of Specific Applications

This API displays all the credential key-value pairs of the specified applications.

Resource URL

GET <controller- url>/controller/restui/eumSyntheticCredentialsUiService/list/<application-id>

Response Format

JSON

Example Response

{
"credentialNamesInApp": [
"url"
],
"credentialNamesNotInApp": [
"appdymics_secret",
"github_pass"
]
}

Update Credential Key-Value Pairs

This API updates the key-value pairs in the credential vault. The version is mandatory and must be incremented with each update request.

Resource URL

PUT <controller- url>/controller/restui/eumSyntheticCredentialsUiService/update

Response Format

JSON

Example

Request
{
"credentials": [
{
"credentialName": "URL",
"credentialValue": "www.appdynamics.com",
"appId": 24,
"version": 4
}
]
}
Response
Status code 204. No response body returned.

Upload Credential Key-Value Pairs

This API uploads multiple key-value pairs to the credential vault.

Resource URL

POST <controller- url>/controller/restui/eumSyntheticCredentialsUiService/upload

Response Format

JSON

Example

Request
{
"credentials": [
{
"credentialName": "URL",
"credentialValue": "www.appdynamics.com"
},
{
"credentialName": "username",
"credentialValue": "appd_user"
}
]
}
Response
Status code 204. No response body returned.