Credential vault API - POST a set of credentials

Creates a new set of credentials for synthetic monitors.

The request consumes and produces an application/json payload.

POST	ManagedDynatrace for Government	`https://{your-domain}/e/{your-environment-id}/api/v2/credentials`
	SaaS	`https://{your-environment-id}.live.dynatrace.com/api/v2/credentials`
	Environment ActiveGate	`https://{your-activegate-domain}/e/{your-environment-id}/api/v2/credentials`

Authentication

To execute this request, you need an access token with credentialVault.write scope.

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
body	Credentials	The JSON body of the request. Contains parameters of the new 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	DEPRECATED The scope of the credentials set. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC` `UNKNOWN`	required
scopes	string[]	The set of scopes of the credentials set. The element can hold these values `ALL` `EXTENSION` `SYNTHETIC` `UNKNOWN`	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",
  "scopes": [
    "SYNTHETIC",
    "EXTENSION_AUTHENTICATION"
  ]
}

Response

Response codes

Code	Type	Description
201	CredentialsId	Success. The new credentials set has been created. The response contains the ID of the set.
400	ErrorEnvelope	Failed. The input is invalid.

Response body objects

The `CredentialsId` object

A short representation of the credentials set.

Element	Type	Description
id	string	The ID of the credentials set.

Response body JSON model

json
{
  "id": "CREDENTIALS_VAULT-C43F2C2E6395AD23"
}

Example

In this example, the request creates a new set of credentials of the USERNAME_PASSWORD type. The username of the credentials set is john.smith and the password is abcd1234.

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 POST \
  https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/ \
  -H 'Authorization: Api-Token dt0c01.abc123.abcdefjhij1234567890' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "RESTtest",
  "description": "Test credentials",
  "password": "abcd1234",
  "ownerAccessOnly": true,
  "type": "USERNAME_PASSWORD",
  "certificate": "john.smith"
}'

Request URL

plaintext
https://mySampleEnv.live.dynatrace.com/api/config/v1/credentials/

Request body

json
{
  "name": "RESTtest",
  "description": "Test credentials",
  "password": "abcd1234",
  "ownerAccessOnly": true,
  "type": "USERNAME_PASSWORD",
  "user": "john.smith"
}

Response body

json
{
  "id": "CREDENTIALS_VAULT-1E6EA5075AF7E85D"
}

Response code

200