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.

GET	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/credentials/{id}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/credentials/{id}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/credentials/{id}`

Authentication

To execute this request, you need 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	Type	Description
200	CredentialsResponseElement	Success. The response contains the metadata of the credentials set.

Response body objects

The `CredentialsResponseElement` object

Metadata of the credentials set.

Element	Type	Description	Required
name	string	The name of the credentials set.	required
id	string	The ID of the credentials set.	optional
type	string	The type of the credentials set. The element can hold these values `CERTIFICATE` `PUBLIC_CERTIFICATE` `TOKEN` `UNKNOWN` `USERNAME_PASSWORD`	required
description	string	A short description of the credentials set.	required
owner	string	The owner of the credential (user for which used API token was created).	required
ownerAccessOnly	boolean	Flag indicating that this credential is visible only to the owner.	required
scope	string	The scope of the credentials set. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC`	optional
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.	optional
credentialUsageSummary	CredentialUsageHandler[]	The list contains summary data related to the use of credentials.	required

The `ExternalVaultConfig` object

Configuration for external vault synchronization for username and password credentials.

Element	Type	Description	Required
type	string	- The element can hold these values `AZURE_KEY_VAULT_CERTIFICATE` `AZURE_KEY_VAULT_CLIENT_SECRET` `HASHICORP_VAULT_APPROLE` `HASHICORP_VAULT_CERTIFICATE`	optional
vaultUrl	string	-	optional
usernameSecretName	string	-	optional
passwordSecretName	string	-	optional
sourceAuthMethod	string	Defines the actual set of fields depending on the value. See one of the following objects: `HASHICORP_VAULT_APPROLE` -> HashicorpApproleConfig `HASHICORP_VAULT_CERTIFICATE` -> HashicorpCertificateConfig `AZURE_KEY_VAULT_CLIENT_SECRET` -> AzureClientSecretConfig `AZURE_KEY_VAULT_CERTIFICATE` -> AzureCertificateConfig The element can hold these values `AZURE_KEY_VAULT_CERTIFICATE` `AZURE_KEY_VAULT_CLIENT_SECRET` `HASHICORP_VAULT_APPROLE` `HASHICORP_VAULT_CERTIFICATE`	required

The `CredentialUsageHandler` object

Keeps information about credential's usage.

Element	Type	Description	Required
type	string	Type of usage.	optional
count	integer	The number of uses.	optional

Response body JSON model

json
{
  "name": "Sample username-password credentials",
  "id": "CREDENTIALS_VAULT-C43F2C2E6395AD23",
  "type": "USERNAME_PASSWORD",
  "description": "Sample credentials for demo purposes.",
  "owner": "user@domain.com",
  "ownerAccessOnly": "true",
  "scope": "SYNTHETIC",
  "externalVault": {
    "sourceAuthMethod": "HASHICORP_VAULT_APPROLE",
    "vaultUrl": "https://vault-cluster.vault.fb17d2fc-be92-4230-afa2-91dbfda3cbad.aws.hashicorp.cloud:8200",
    "usernameSecretName": "username",
    "passwordSecretName": "password",
    "pathToCredentials": "kv/credentials",
    "roleId": "00e4858c-ec33-bc99-4e7e-34de6967de6c",
    "secretId": "CREDENTIALS_VAULT-XXXXXXXXXXXXXXXX",
    "vaultNamespace": "admin"
  },
  "credentialUsageSummary": [
    {
      "HTTP_MONITOR": 3,
      "BROWSER_MONITOR": 2
    }
  ]
}

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

bash
curl -X GET \
  'https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/CREDENTIALS_VAULT-9415C41E3649FE3C' \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890'

Request URL

http
https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/CREDENTIALS_VAULT-9415C41E3649FE3C

Response body

json
{
  "name": "easyTravel",
  "id": "CREDENTIALS_VAULT-9415C41E3649FE3C",
  "type": "USERNAME_PASSWORD",
  "description": "Credentials for easyTravel test app"
}

Response code

200