Credential vault API - PUT a set of credentials

Updates the specified set of credentials for synthetic monitors.

The request consumes and produces an application/json payload.

PUT	Managed	`https://{your-domain}/e/{your-environment-id}/api/config/v1/credentials/{id}`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/config/v1/credentials/{id}`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/config/v1/credentials/{id}`

Authentication

To execute this request, you need Write credential vault entries (credentialVault.write) permission assigned to your API token. To learn how to obtain and use it, see Tokens and authentication.

Parameters

Refer to JSON models to find all JSON models that depend on the type of the model.

Parameter	Type	Description	In	Required
id	string	The Dynatrace entity ID of the credentials set to be updated.	path	optional
body	Credentials	The JSON body of the request. Contains updated parameters of the credentials set.	body	required

Request body objects

The `Credentials` 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.

Element	Type	Description	Required
name	string	The name of the credentials set.	required
id	string	The ID of the credentials set.	optional
description	string	A short description of the credentials set.	optional
ownerAccessOnly	boolean	The credentials set is available to every user (`false`) or to owner only (`true`).	optional
scope	string	The scope of the credentials set. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC`	required
type	string	Defines the actual set of fields depending on the value. See one of the following objects: `CERTIFICATE` -> CertificateCredentials `PUBLIC_CERTIFICATE` -> PublicCertificateCredentials `USERNAME_PASSWORD` -> UserPasswordCredentials `TOKEN` -> TokenCredentials The element can hold these values `CERTIFICATE` `PUBLIC_CERTIFICATE` `TOKEN` `USERNAME_PASSWORD`	optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

json
{
  "name": "Sample credentials",
  "type": "USERNAME_PASSWORD",
  "description": "Sample set of credentials for API documentation",
  "user": "john.smith",
  "password": "1234abcd",
  "ownerAccessOnly": "true",
  "scope": "SYNTHETIC"
}

Response

Response codes

Code	Type	Description
201	CredentialsResponseElement	Success. The new credentials set has been created. The response contains the ID of the set.
204	-	Success. The credentials set has been updated. Response doesn't have a body.
400	ErrorEnvelope	Failed. The input is invalid

Response body objects

The `CredentialsResponseElement` object

Metadata of the credentials set.

Element	Type	Description	Required
name	string	The name of the credentials set.	required
id	string	The ID of the credentials set.	optional
type	string	The type of the credentials set. The element can hold these values `CERTIFICATE` `PUBLIC_CERTIFICATE` `TOKEN` `UNKNOWN` `USERNAME_PASSWORD`	required
description	string	A short description of the credentials set.	required
owner	string	The owner of the credential (user for which used API token was created).	required
ownerAccessOnly	boolean	Flag indicating that this credential is visible only to the owner.	required
scope	string	The scope of the credentials set. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC`	optional
externalVault	ExternalVaultConfig	Configuration for external vault synchronization for username and password credentials.	optional
credentialUsageSummary	CredentialUsageHandler[]	The list contains summary data related to the use of credentials.	required

The `ExternalVaultConfig` object

Configuration for external vault synchronization for username and password credentials.

Element	Type	Description	Required
type	string	- The element can hold these values `AZURE_KEY_VAULT_CERTIFICATE` `AZURE_KEY_VAULT_CLIENT_SECRET` `HASHICORP_VAULT_APPROLE` `HASHICORP_VAULT_CERTIFICATE`	optional
vaultUrl	string	-	optional
usernameSecretName	string	-	optional
passwordSecretName	string	-	optional
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 `AZURE_KEY_VAULT_CERTIFICATE` -> AzureCertificateConfig The element can hold these values `AZURE_KEY_VAULT_CERTIFICATE` `AZURE_KEY_VAULT_CLIENT_SECRET` `HASHICORP_VAULT_APPROLE` `HASHICORP_VAULT_CERTIFICATE`	required

The `CredentialUsageHandler` object

Keeps information about credential's usage.

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

Response body JSON model

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

Example

In this example, the request updates the set of credentials created in the POST request example.

It changes the username to mary.brown and the password to 4321dcba.

The API token is passed in the Authorization header.

You can download or copy the example request body to try it out on your own.

Curl

bash
curl -X PUT \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/CREDENTIALS_VAULT-1E6EA5075AF7E85D \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "RESTtest",
  "description": "Test credentials",
  "password": "4321dcba",
  "ownerAccessOnly": true,
  "type": "USERNAME_PASSWORD",
  "user": "mary.brown"
}'

Request URL

http
https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/CREDENTIALS_VAULT-1E6EA5075AF7E85D

Request body

json
{
  "name": "RESTtest",
  "description": "Test credentials",
  "password": "4321dcba",
  "ownerAccessOnly": true,
  "type": "USERNAME_PASSWORD",
  "user": "mary.brown"
}

Response code

204