Credential vault API - GET all credentials

Lists all credentials for synthetic monitors stored in your environment.

The request produces an application/json payload.

GET	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/credentials`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/credentials`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/credentials`

Authentication

To execute this request, you need an access token with credentialVault.read scope.

To learn how to obtain and use it, see Tokens and authentication.

Parameters

Parameter	Type	Description	In	Required
type	string	Filters the result by the specified credentials type. The element can hold these values `CERTIFICATE` `USERNAME_PASSWORD` `TOKEN`	query	optional
name	string	Filters the result by the name. When in quotation marks, whole phrase is taken. Case insensitive.	query	optional
user	string	Filters credentials accessible to the user (owned by the user or the ones that are accessible for all).	query	optional
scope	string	Filters credentials with specified scope.	query	optional
nextPageKey	string	The cursor for the next page of results. You can find it in the nextPageKey field of the previous response. The first page is always returned if you don't specify the nextPageKey query parameter. When the nextPageKey is set to obtain subsequent pages, you must omit all other query parameters.	query	optional
pageSize	integer	The amount of credentials in a single response payload. The maximal allowed page size is 500. If not set, 100 is used.	query	optional

Response

Response codes

Code	Type	Description
200	CredentialsList	Success
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `CredentialsList` object

A list of credentials sets for Synthetic monitors.

Element	Type	Description
totalCount	integer	-
pageSize	integer	-
nextPageKey	string	-
credentials	CredentialsResponseElement[]	A list of credentials sets for Synthetic monitors.

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.
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. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC` `UNKNOWN`
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
credentialUsageSummary	CredentialUsageHandler[]	The list contains summary data related to the use of credentials.
scopes	string[]	The set of scopes of the credentials set. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC` `UNKNOWN`
type	string	The type of the credentials set. The element can hold these values `CERTIFICATE` `PUBLIC_CERTIFICATE` `TOKEN` `UNKNOWN` `USERNAME_PASSWORD`

The `ExternalVaultConfig` object

Configuration for external vault synchronization for username and password credentials.

Element	Type	Description
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 `CYBERARK_VAULT_USERNAME_PASSWORD` -> CyberArkUsernamePasswordConfig The element can hold these values `AZURE_KEY_VAULT_CLIENT_SECRET` `CYBERARK_VAULT_USERNAME_PASSWORD` `HASHICORP_VAULT_APPROLE` `HASHICORP_VAULT_CERTIFICATE`
vaultUrl	string	-
usernameSecretName	string	-
passwordSecretName	string	-
tokenSecretName	string	-
credentialsUsedForExternalSynchronization	string[]	-
type	string	- The element can hold these values `AZURE_CERTIFICATE_MODEL` `AZURE_CLIENT_SECRET_MODEL` `CYBERARK_VAULT_USERNAME_PASSWORD_MODEL` `HASHICORP_APPROLE_MODEL` `HASHICORP_CERTIFICATE_MODEL`

The `CredentialUsageHandler` object

Keeps information about credential's usage.

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

Response body JSON model

json
{
  "credentials": [
    {
      "name": "Sample username-password credentials",
      "id": "CREDENTIALS_VAULT-E80203F993472E6D",
      "type": "USERNAME_PASSWORD",
      "description": "Sample credentials for demo purposes",
      "owner": "admin",
      "ownerAccessOnly": true,
      "scope": "SYNTHETIC",
      "credentialUsageSummary": [
        {
          "HTTP_MONITOR": 4
        }
      ]
    },
    {
      "name": "Sample certificate credentials",
      "id": "CREDENTIALS_VAULT-842DEF439999E15B",
      "type": "CERTIFICATE",
      "description": "Sample credentials for demo purposes",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scope": "EXTENSION",
      "credentialUsageSummary": []
    },
    {
      "name": "Sample token credentials",
      "id": "CREDENTIALS_VAULT-854345639999E15B",
      "type": "TOKEN",
      "description": "Sample token for demo purposes",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scope": "SYNTHETIC",
      "credentialUsageSummary": [
        {
          "HTTP_MONITOR": 4,
          "BROWSER_MONITOR": 11
        }
      ]
    }
  ]
}