• Home
  • Dynatrace API
  • Configuration
  • Credential vault
  • JSON models

Credential vault API - JSON models

This API is deprecated. Use the Credential vault API from the Environment API instead.

JSON models of the Credential vault API vary depending on the type of the object. Here you can find JSON models for each variation.

Variations of the Credentials object

The Credentials object is the base for all credentials. The actual set of fields depends on the type of the credentials.

CERTIFICATE

CertificateCredentials

The CertificateCredentials object

A set of credentials for synthetic monitors.

The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.

ElementTypeDescription
certificatestring

The certificate in the string format.

passwordstring

The password of the credential (Base64 encoded).

certificateFormatstring

The certificate format.

The element can hold these values
  • PEM
  • PKCS12
  • UNKNOWN
json
{ "name": "string", "id": "string", "description": "string", "password": "string", "ownerAccessOnly": true, "type": "CERTIFICATE", "certificate": "string" }

TOKEN

TokenCredentials

The TokenCredentials object

A set of credentials for synthetic monitors.

The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.

ElementTypeDescription
tokenstring

Token in the string format.

externalVaultExternalVault

Information for synchronization credentials with external vault

The ExternalVault object

Information for synchronization credentials with external vault

ElementTypeDescription
sourceAuthMethodstring

Defines the actual set of fields depending on the value. See one of the following objects:

  • HASHICORP_VAULT_APPROLE -> HashicorpApprole
  • HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate
  • AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret
The element can hold these values
  • AZURE_KEY_VAULT_CLIENT_SECRET
  • HASHICORP_VAULT_APPROLE
  • HASHICORP_VAULT_CERTIFICATE
vaultUrlstring

External vault URL.

usernameSecretNamestring

The name of the secret saved in external vault where username is stored.

passwordSecretNamestring

The name of the secret saved in external vault where password is stored.

tokenSecretNamestring

The name of the secret saved in external vault where token is stored.

json
{ "name": "string", "id": "string", "description": "string", "password": "string", "ownerAccessOnly": true, "type": "TOKEN", "token": "string" }

USERNAME_PASSWORD

UserPasswordCredentials

The UserPasswordCredentials object

A set of credentials for synthetic monitors.

The actual set of fields depends on the type of credentials. Find the list of actual objects in the description of the type field or see Credential vault API - JSON models.

ElementTypeDescription
userstring

The username of the credentials set.

passwordstring

The password of the credential.

externalVaultExternalVault

Information for synchronization credentials with external vault

The ExternalVault object

Information for synchronization credentials with external vault

ElementTypeDescription
sourceAuthMethodstring

Defines the actual set of fields depending on the value. See one of the following objects:

  • HASHICORP_VAULT_APPROLE -> HashicorpApprole
  • HASHICORP_VAULT_CERTIFICATE -> HashicorpCertificate
  • AZURE_KEY_VAULT_CLIENT_SECRET -> AzureClientSecret
The element can hold these values
  • AZURE_KEY_VAULT_CLIENT_SECRET
  • HASHICORP_VAULT_APPROLE
  • HASHICORP_VAULT_CERTIFICATE
vaultUrlstring

External vault URL.

usernameSecretNamestring

The name of the secret saved in external vault where username is stored.

passwordSecretNamestring

The name of the secret saved in external vault where password is stored.

tokenSecretNamestring

The name of the secret saved in external vault where token is stored.

json
{ "name": "string", "id": "string", "description": "string", "password": "string", "ownerAccessOnly": true, "type": "USERNAME_PASSWORD", "user": "string" }