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.

PUTSaaShttps://{your-environment-id}.live.dynatrace.com/api/v2/credentials/{id}
Environment ActiveGateCluster ActiveGatehttps://{your-activegate-domain}:9999/e/{your-environment-id}/api/v2/credentials/{id}

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
id
string

The Dynatrace entity ID of the credentials set to be updated.

path
required
body

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
allowContextlessRequests
boolean

Allow ad-hoc functions to access the credential details (requires the APP_ENGINE scope).

optional
allowedEntities

The set of entities allowed to use the credential.

optional
description
string

A short description of the credentials set.

optional
id
string

The ID of the credentials set.

optional
name
string

The name of the credentials set.

required
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.

  • APP_ENGINE
  • EXTENSION
  • SYNTHETIC
optional
scopes
string[]

The set of scopes of the credentials set.

Limitations: CredentialsScope.APP_ENGINE is only available on the new Dynatrace SaaS platform - it's not available on managed or non-Grail SaaS environments.

  • APP_ENGINE
  • 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
  • SNMPV3 -> SNMPV3Credentials
  • AWS_KEY_BASED -> AWSKeyBasedCredentialsDto
  • AWS_ROLE_BASED -> AWSRoleBasedCredentials
  • AWS_KEY_BASED
  • AWS_ROLE_BASED
  • CERTIFICATE
  • PUBLIC_CERTIFICATE
  • SNMPV3
  • TOKEN
  • USERNAME_PASSWORD
optional

The CredentialAccessData object

The set of entities allowed to use the credential.

Element
Type
Description
Required
id
string
-
optional
type
string
-
  • APPLICATION
  • UNKNOWN
  • USER
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.

{
  "allowContextlessRequests": "false",
  "allowedEntities": [
    {
      "id": "jane.doe@example.com",
      "type": "USER"
    },
    {
      "id": "john.smith@example.com",
      "type": "USER"
    },
    {
      "id": "my.with.credentials",
      "type": "APPLICATION"
    }
  ],
  "description": "Sample set of credentials for API documentation",
  "name": "Sample credentials",
  "ownerAccessOnly": false,
  "password": "1234abcd",
  "scope": "SYNTHETIC",
  "scopes": [
    "SYNTHETIC",
    "EXTENSION_AUTHENTICATION"
  ],
  "type": "USERNAME_PASSWORD",
  "user": "john.smith@example.com"
}

Response

Response codes

Code
Type
Description
201

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

Failed. The input is invalid.

4XX

Client side error.

5XX

Server side error.

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

{
  "id": "CREDENTIALS_VAULT-C43F2C2E6395AD23"
}

Related topics