• Home
  • Dynatrace API
  • Environment
  • Credential vault
  • GET all credentials

Credential vault API - GET all credentials

Lists all credentials for synthetic monitors stored in your environment.

The request produces an application/json payload.

GETManagedDynatrace for Governmenthttps://{your-domain}/e/{your-environment-id}/api/v2/credentials
SaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/credentials
Environment ActiveGatehttps://{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

ParameterTypeDescriptionInRequired
typestring

Filters the result by the specified credentials type.

The element can hold these values
  • CERTIFICATE
  • USERNAME_PASSWORD
  • TOKEN
queryoptional
namestring

Filters the result by the name. When in quotation marks, whole phrase is taken. Case insensitive.

queryoptional
userstring

Filters credentials accessible to the user (owned by the user or the ones that are accessible for all).

queryoptional
nextPageKeystring

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.

queryoptional
pageSizeinteger

The amount of credentials in a single response payload.

The maximal allowed page size is 500.

If not set, 100 is used.

queryoptional

Response

Response codes

CodeTypeDescription
200CredentialsList

Success

Response body objects

The CredentialsList object

A list of credentials sets for Synthetic monitors.

ElementTypeDescription
totalCountinteger-
pageSizeinteger-
nextPageKeystring-
credentialsCredentialsResponseElement[]

A list of credentials sets for Synthetic monitors.

The CredentialsResponseElement object

Metadata of the credentials set.

ElementTypeDescription
namestring

The name of the credentials set.

idstring

The ID of the credentials set.

descriptionstring

A short description of the credentials set.

ownerstring

The owner of the credential (user for which used API token was created).

ownerAccessOnlyboolean

Flag indicating that this credential is visible only to the owner.

scopestring

The scope of the credentials set.

The element can hold these values
  • ALL
  • EXTENSION
  • SYNTHETIC
  • UNKNOWN
externalVaultExternalVaultConfig

Configuration for external vault synchronization for username and password credentials.

credentialUsageSummaryCredentialUsageHandler[]

The list contains summary data related to the use of credentials.

typestring

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.

ElementTypeDescription
sourceAuthMethodstring

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
The element can hold these values
  • AZURE_KEY_VAULT_CLIENT_SECRET
  • HASHICORP_VAULT_APPROLE
  • HASHICORP_VAULT_CERTIFICATE
vaultUrlstring-
usernameSecretNamestring-
passwordSecretNamestring-
tokenSecretNamestring-
credentialsUsedForExternalSynchronizationstring[]-
typestring-
The element can hold these values
  • AZURE_CERTIFICATE_MODEL
  • AZURE_CLIENT_SECRET_MODEL
  • HASHICORP_APPROLE_MODEL
  • HASHICORP_CERTIFICATE_MODEL

The CredentialUsageHandler object

Keeps information about credential's usage.

ElementTypeDescription
typestring

Type of usage.

countinteger

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 } ] } ] }
Related topics
  • Configure browser monitors

    Learn about configuring browser monitors and clickpaths.

  • Configure HTTP monitors

    Learn about configuring HTTP monitors.