Credential vault API - GET credentials metadata
Gets the metadata of the specified set of credentials for synthetic monitors. The credentials set itself (username/certificate and password) is not included in the response.
The request produces an application/json
payload.
This request is an Early Adopter release and may be changed in non-compatible way.
GET |
|
Authentication
To execute this request, you need the Read credential vault entries (credentialVault.read
) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
id | string |
The Dynatrace entity ID of the required credentials set. |
path | required |
Response
Response codes
Code | Description |
---|---|
200 | Success. The response contains the metadata of the credentials set. |
Response body
The CredentialsResponseElement object
Metadata of the credentials set.
Element | Type | Description |
---|---|---|
name | string | The name of the credentials set. |
id | string | The ID of the credentials set. |
type | string | The type of the credentials set. |
description | string | A short description of the credentials set. |
owner | string | The owner of the credential (user for which used API token was created). |
ownerAccessOnly | boolean | Flag indicating that this credential is visible only to the owner. |
scope | string | The scope of the credentials set. |
{
"name": "Sample username-password credentials",
"id": "CREDENTIALS_VAULT-C43F2C2E6395AD23",
"type": "USERNAME_PASSWORD",
"description": "Sample credentials for demo purposes.\n",
"owner": "user@domain.com",
"ownerAccessOnly": "true",
"scope": "SYNTHETIC"
}
Example
In this example, the request fetches the metadata of the easyTravel credentials set with the ID of CREDENTIALS_VAULT-9415C41E3649FE3C.
The API token is passed in the Authorization header.
Curl
curl -X GET \
'https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/CREDENTIALS_VAULT-9415C41E3649FE3C' \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/CREDENTIALS_VAULT-9415C41E3649FE3C
Response body
{
"name": "easyTravel",
"id": "CREDENTIALS_VAULT-9415C41E3649FE3C",
"type": "USERNAME_PASSWORD",
"description": "Credentials for easyTravel test app"
}
Response code
200