AWS credentials API - POST new credentials

Creates a new AWS credentials configuration. Check the connection status for these credentials after 10 minutes with the GET credentials request.

The body must not provide an ID. The Dynatrace server automatically assigns an ID.

The request consumes and produces an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials

Parameters

Parameter Type Description In Required
body AwsCredentialsConfig

The JSON body of the request. Contains parameters of the new AWS credentials configuration.

body optional

The AwsCredentialsConfig object

Configuration of an AWS credentials.

Element Type Description Required
metadata ConfigurationMetadata

Metadata useful for debugging.

optional
id string

The unique ID of the credentials.

optional
connectionStatus string

The status of the connection to the AWS environment.

  • CONNECTED: There was a connection within last 10 minutes.
  • DISCONNECTED: A problem occurred with establishing connection using these credentials. Check whether the data is correct.
  • UNINITIALIZED: The successful connection has never been established for these credentials.
The connectionStatus element can hold these values.
optional
label string

The name of the credentials.

required
partitionType string

The type of the AWS partition.

The partitionType element can hold these values.
required
authenticationData AwsAuthenticationData

The type of the AWS authentication and the respective credentials.

required
taggedOnly boolean

Monitor only resources which have specified AWS tags (true) or all resources (false).

required
tagsToMonitor AwsConfigTag[]

A list of AWS tags to be monitored.

You can specify up to 10 tags.

Only applicable when the taggedOnly parameter is set to true.

required
supportingServices AwsSupportingService[]

A list of supporting services to be monitored.

required

The AwsSupportingService object

A supporting service to be monitored.

Element Type Description Required
name string

The short name of the supporting service.

required
metrics string[]

A list of metrics to be monitored for this service in format: <DimensionName> <MetricName> <AggregationShortName>.

required

The AwsConfigTag object

An AWS tag of the resource to be monitored.

Element Type Description Required
name string

The key of the AWS tag.

required
value string

The value of the AWS tag.

required

The AwsAuthenticationData object

A credentials for the AWS authentication.

Element Type Description Required
type string

The type of the authentication: role-based or key-based.

The type element can hold these values.
required
keyBasedAuthentication KeyBasedAuthentication

The credentials for the key-based authentication.

Only applicable when the type parameter is set to KEYS.

optional
roleBasedAuthentication RoleBasedAuthentication

The credentials for the role-based authentication.

Only applicable when the type parameter is set to ROLE.

optional

The RoleBasedAuthentication object

The credentials for the role-based authentication.

Element Type Description Required
iamRole string

The IAM role to be used by Dynatrace to get monitoring data.

required
accountId string

The ID of the Amazon account.

required
externalId string

The external ID token for setting an IAM role.

You can obtain it with the GET /aws/iamExternalId request.

optional

The KeyBasedAuthentication object

The credentials for the key-based authentication.

Element Type Description Required
accessKey string

The ID of the access key.

required
secretKey string

The secret access key.

required

The ConfigurationMetadata object

Metadata useful for debugging

Element Type Description Required
configurationVersions integer[]

A Sorted list of the version numbers of the configuration.

optional
clusterVersion string

Dynatrace server version.

optional

Possible values

Possible values for the type element in the AwsAuthenticationData object:

  • KEYS
  • ROLE

Possible values for the partitionType element in the AwsCredentialsConfig object:

  • AWS_CN
  • AWS_DEFAULT
  • AWS_US_GOV

Possible values for the connectionStatus element in the AwsCredentialsConfig object:

  • CONNECTED
  • DISCONNECTED
  • UNINITIALIZED

Response format

The EntityShortRepresentation object

The short representation of a Dynatrace entity.

Element Type Description
id string

The ID of the Dynatrace entity.

name string

The name of the Dynatrace entity.

description string

A short description of the Dynatrace entity.

GET the external ID token

Gets the external ID token for setting an IAM role.

The request produces an application/json payload.

GET
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/iamExternalId
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/iamExternalId

Response format

The AwsIamToken object

The external ID token for setting IAM Role in AWS.

Element Type Description
token string

The external ID token for setting IAM Role in AWS.

Validate payload

We recommend that you validate the payload before submitting it with an actual request. A response code of 204 indicates a valid payload.

The request consumes an application/json payload.

POST
  • Managed https://{your-domain}/e/{your-environment-id}/api/config/v1/aws/credentials/validator
  • SaaS https://{your-environment-id}.live.dynatrace.com/api/config/v1/aws/credentials/validator

Response codes

Code Description
204 Validated. The submitted configuration is valid. Response doesn't have a body.
400 Failed. The input is invalid.