List credential entries

Latest Dynatrace
Reference
Published Oct 13, 2026
Early Access

List the credential entries in your Dynatrace environment with the Credential Vault API, filtered by type, name, or the user who can access them.


GET	SaaS	`https://{your-environment-id}.apps.dynatrace.com/v1/entries`

Overview

You use this operation to list the credential entries of your environment, optionally filtered by the type, name, and user query parameters. The response contains entry metadata only, never the username, certificate, or password itself. Entries owned by other users appear only when you have the credential-vault:entries:admin permission.

Authentication

To execute this request, you need a platform token or OAuth access token with credential-vault:entries: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 credential type. The element can hold these values `CERTIFICATE` `USERNAME_PASSWORD` `TOKEN` `SNMPV3` `AWS_MONITORING_KEY_BASED` `AWS_MONITORING_ROLE_BASED`	query	Optional
name	string	Filters the result by name. Enclose the value in quotation marks to match the whole phrase. Case-insensitive.	query	Optional
user	string	Filters the result to credentials accessible to the specified user (those they own or those shared with everyone).	query	Optional
scope	string	Filters the result by the specified scope.	query	Optional
page-key	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 page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters.	query	Optional
page-size	integer	The amount of credential vault entries 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
4XX	ErrorResponseEnvelope	Client side error.
5XX	ErrorResponseEnvelope	Server side error.

Response body objects

The `CredentialsList` object

A list of credentials sets for Synthetic monitors.

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

The `CredentialsResponseElement` object

Metadata of the credentials set.

Element	Type	Description
allowContextlessRequests	boolean	Allow access without app context, for example, from ad hoc functions in Workflows (requires the APP_ENGINE scope).
allowedEntities	CredentialAccessData[]	The set of entities allowed to use the credential.
credentialUsageSummary	CredentialUsageHandler[]	The list contains summary data related to the use of credentials.
description	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name	string	The name 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 `APP_ENGINE` `EXTENSION` `EXTENSION_AUTHENTICATION` `SYNTHETIC`
scopes	string[]	The set of scopes of the credentials set. The element can hold these values `APP_ENGINE` `EXTENSION` `EXTENSION_AUTHENTICATION` `SYNTHETIC`
type	string	The type of the credentials set. The element can hold these values `AWS_MONITORING_KEY_BASED` `AWS_MONITORING_ROLE_BASED` `CERTIFICATE` `PUBLIC_CERTIFICATE` `SNMPV3` `TOKEN` `UNKNOWN` `USERNAME_PASSWORD`

The `CredentialAccessData` object

The set of entities allowed to use the credential.

Element	Type	Description
id	string	-
type	string	- The element can hold these values `APPLICATION` `UNKNOWN` `USER`

The `CredentialUsageHandler` object

Keeps information about credential's usage.

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

The `ExternalVaultConfig` object

Configuration for external vault synchronization for username and password credentials.

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

The `ErrorResponseEnvelope` object

Encloses the encountered error.

Element	Type	Description
error	ErrorResponse	Basic information of the encountered error.

The `ErrorResponse` object

Basic information of the encountered error.

Element	Type	Description
code	integer	The returned HTTP status code.
details	ErrorResponseDetails	Detailed information of the error.
message	string	Description of the encountered error.

The `ErrorResponseDetails` object

Detailed information of the error.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constraintViolation` -> ConstraintViolationDetails The element can hold these values `constraintViolation`

Response body JSON models

{
  "credentials": [
    {
      "credentialUsageSummary": [
        {
          "HTTP_MONITOR": 4
        }
      ],
      "description": "Sample credentials for demo purposes",
      "id": "CREDENTIALS_VAULT-E80203F993472E6D",
      "name": "Sample username-password credentials",
      "owner": "admin",
      "ownerAccessOnly": true,
      "scope": "SYNTHETIC",
      "type": "USERNAME_PASSWORD"
    },
    {
      "credentialUsageSummary": [],
      "description": "Sample credentials for demo purposes",
      "id": "CREDENTIALS_VAULT-842DEF439999E15B",
      "name": "Sample certificate credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scope": "EXTENSION",
      "type": "CERTIFICATE"
    },
    {
      "credentialUsageSummary": [
        {
          "BROWSER_MONITOR": 11,
          "HTTP_MONITOR": 4
        }
      ],
      "description": "Sample token for demo purposes",
      "id": "CREDENTIALS_VAULT-854345639999E15B",
      "name": "Sample token credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scope": "SYNTHETIC",
      "type": "TOKEN"
    },
    {
      "awsPartition": "CHINA",
      "description": "Sample AWS credentials for demo purposes",
      "id": "CREDENTIALS_VAULT-12ABB17F0D93F8AF",
      "name": "Sample AWS key based credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scopes": [
        "CLOUDS_MONITORING_AUTHENTICATION"
      ],
      "type": "AWS_MONITORING_KEY_BASED"
    },
    {
      "accountID": "123456789012",
      "description": "Sample AWS credentials for demo purposes",
      "externalID": "21cf07eb-4812-4de7-d5b9-6189c5951ad4",
      "iamRole": "Dynatrace_monitoring_role",
      "id": "CREDENTIALS_VAULT-08D0C2A011411D64",
      "name": "Sample AWS role based credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scopes": [
        "CLOUDS_MONITORING_AUTHENTICATION"
      ],
      "type": "AWS_MONITORING_ROLE_BASED"
    }
  ]
}

{
  "error": {
    "code": 1,
    "details": {
      "type": "constraintViolation"
    },
    "message": "string"
  }
}

GET

SaaS

https://{your-environment-id}.apps.dynatrace.com/v1/entries

Overview

Parameters

Parameter	Type	Description	In	Required
type	string	Filters the result by the specified credential type. The element can hold these values `CERTIFICATE` `USERNAME_PASSWORD` `TOKEN` `SNMPV3` `AWS_MONITORING_KEY_BASED` `AWS_MONITORING_ROLE_BASED`	query	Optional
name	string	Filters the result by name. Enclose the value in quotation marks to match the whole phrase. Case-insensitive.	query	Optional
user	string	Filters the result to credentials accessible to the specified user (those they own or those shared with everyone).	query	Optional
scope	string	Filters the result by the specified scope.	query	Optional
page-key	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 page-key query parameter. When the page-key is set to obtain subsequent pages, you must omit all other query parameters.	query	Optional
page-size	integer	The amount of credential vault entries 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
4XX	ErrorResponseEnvelope	Client side error.
5XX	ErrorResponseEnvelope	Server side error.

Response body objects

The `CredentialsList` object

A list of credentials sets for Synthetic monitors.

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

The `CredentialsResponseElement` object

Metadata of the credentials set.

Element	Type	Description
allowContextlessRequests	boolean	Allow access without app context, for example, from ad hoc functions in Workflows (requires the APP_ENGINE scope).
allowedEntities	CredentialAccessData[]	The set of entities allowed to use the credential.
credentialUsageSummary	CredentialUsageHandler[]	The list contains summary data related to the use of credentials.
description	string	A short description of the credentials set.
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.
id	string	The ID of the credentials set.
name	string	The name 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 `APP_ENGINE` `EXTENSION` `EXTENSION_AUTHENTICATION` `SYNTHETIC`
scopes	string[]	The set of scopes of the credentials set. The element can hold these values `APP_ENGINE` `EXTENSION` `EXTENSION_AUTHENTICATION` `SYNTHETIC`
type	string	The type of the credentials set. The element can hold these values `AWS_MONITORING_KEY_BASED` `AWS_MONITORING_ROLE_BASED` `CERTIFICATE` `PUBLIC_CERTIFICATE` `SNMPV3` `TOKEN` `UNKNOWN` `USERNAME_PASSWORD`

The `CredentialAccessData` object

The set of entities allowed to use the credential.

Element	Type	Description
id	string	-
type	string	- The element can hold these values `APPLICATION` `UNKNOWN` `USER`

The `CredentialUsageHandler` object

Keeps information about credential's usage.

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

The `ExternalVaultConfig` object

Configuration for external vault synchronization for username and password credentials.

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

The `ErrorResponseEnvelope` object

Encloses the encountered error.

Element	Type	Description
error	ErrorResponse	Basic information of the encountered error.

The `ErrorResponse` object

Basic information of the encountered error.

Element	Type	Description
code	integer	The returned HTTP status code.
details	ErrorResponseDetails	Detailed information of the error.
message	string	Description of the encountered error.

The `ErrorResponseDetails` object

Detailed information of the error.

Element	Type	Description
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `constraintViolation` -> ConstraintViolationDetails The element can hold these values `constraintViolation`

Response body JSON models

{
  "credentials": [
    {
      "credentialUsageSummary": [
        {
          "HTTP_MONITOR": 4
        }
      ],
      "description": "Sample credentials for demo purposes",
      "id": "CREDENTIALS_VAULT-E80203F993472E6D",
      "name": "Sample username-password credentials",
      "owner": "admin",
      "ownerAccessOnly": true,
      "scope": "SYNTHETIC",
      "type": "USERNAME_PASSWORD"
    },
    {
      "credentialUsageSummary": [],
      "description": "Sample credentials for demo purposes",
      "id": "CREDENTIALS_VAULT-842DEF439999E15B",
      "name": "Sample certificate credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scope": "EXTENSION",
      "type": "CERTIFICATE"
    },
    {
      "credentialUsageSummary": [
        {
          "BROWSER_MONITOR": 11,
          "HTTP_MONITOR": 4
        }
      ],
      "description": "Sample token for demo purposes",
      "id": "CREDENTIALS_VAULT-854345639999E15B",
      "name": "Sample token credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scope": "SYNTHETIC",
      "type": "TOKEN"
    },
    {
      "awsPartition": "CHINA",
      "description": "Sample AWS credentials for demo purposes",
      "id": "CREDENTIALS_VAULT-12ABB17F0D93F8AF",
      "name": "Sample AWS key based credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scopes": [
        "CLOUDS_MONITORING_AUTHENTICATION"
      ],
      "type": "AWS_MONITORING_KEY_BASED"
    },
    {
      "accountID": "123456789012",
      "description": "Sample AWS credentials for demo purposes",
      "externalID": "21cf07eb-4812-4de7-d5b9-6189c5951ad4",
      "iamRole": "Dynatrace_monitoring_role",
      "id": "CREDENTIALS_VAULT-08D0C2A011411D64",
      "name": "Sample AWS role based credentials",
      "owner": "John.Doe@domain.com",
      "ownerAccessOnly": true,
      "scopes": [
        "CLOUDS_MONITORING_AUTHENTICATION"
      ],
      "type": "AWS_MONITORING_ROLE_BASED"
    }
  ]
}

{
  "error": {
    "code": 1,
    "details": {
      "type": "constraintViolation"
    },
    "message": "string"
  }
}

List credential entries

Overview

Authentication

Parameters

Response

Response codes

Response body objects

The CredentialsList object

The CredentialsResponseElement object

The CredentialAccessData object

The CredentialUsageHandler object

The ExternalVaultConfig object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

Response body JSON models

List credential entries

Overview

Authentication

Parameters

Response

Response codes

Response body objects

The CredentialsList object

The CredentialsResponseElement object

The CredentialAccessData object

The CredentialUsageHandler object

The ExternalVaultConfig object

The ErrorResponseEnvelope object

The ErrorResponse object

The ErrorResponseDetails object

Response body JSON models

The `CredentialsList` object

The `CredentialsResponseElement` object

The `CredentialAccessData` object

The `CredentialUsageHandler` object

The `ExternalVaultConfig` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `CredentialsList` object

The `CredentialsResponseElement` object

The `CredentialAccessData` object

The `CredentialUsageHandler` object

The `ExternalVaultConfig` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object