Get a credential entry

Latest Dynatrace
Reference
Published Oct 13, 2026
Early Access

Get the metadata of a credential entry in Dynatrace with the Credential Vault API by its ID; the username, certificate, or password is never returned.


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

Overview

You use the entry-id path parameter to read the metadata of one credential entry. The response doesn't include the credential itself, such as the username, certificate, or password. To read an entry owned by another user, you need 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
entry-id	string	The ID of the required credential entry.	path	Required

Response

Response codes

Code	Type	Description
200	CredentialsResponseElement	Success. The response contains the metadata of the credential entry.
4XX	ErrorResponseEnvelope	Client side error.
5XX	ErrorResponseEnvelope	Server side error.

Response body objects

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

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

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

GET

SaaS

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

Parameter

Type

Description

Required

entry-id

string

The ID of the required credential entry.

path

Required

Response

Response codes

Code	Type	Description
200	CredentialsResponseElement	Success. The response contains the metadata of the credential entry.
4XX	ErrorResponseEnvelope	Client side error.
5XX	ErrorResponseEnvelope	Server side error.

Response body objects

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

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

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

Get a credential entry

Overview

Authentication

Parameters

Response

Response codes

Response body objects

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

Get a credential entry

Overview

Authentication

Parameters

Response

Response codes

Response body objects

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 `CredentialsResponseElement` object

The `CredentialAccessData` object

The `CredentialUsageHandler` object

The `ExternalVaultConfig` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object

The `CredentialsResponseElement` object

The `CredentialAccessData` object

The `CredentialUsageHandler` object

The `ExternalVaultConfig` object

The `ErrorResponseEnvelope` object

The `ErrorResponse` object

The `ErrorResponseDetails` object