Try it free

Partially update an external datastore definition

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Partially update an external datastore definition in Dynatrace Grail with the External Datastores API, changing only the fields you send in the request.

PATCHSaaShttps://{your-environment-id}.apps.dynatrace.com/v1/external-datastore-definitions/{storeName}

Overview

Partially update an existing external datastore definition.

Only the provided fields will be updated. The name field cannot be changed after creation.

The following fields can be updated:

  • displayName human-readable label (up to 200 characters)
  • bucketName the S3 bucket name (up to 1000 characters)
  • region the AWS region (up to 1000 characters)
  • connectionId reference to the connection settings object (up to 1000 characters)
  • connectionName optional reference to the connection settings object (up to 1000 characters).

Uses optimistic locking - pass the current version via the optimistic-locking-version query parameter.

Authentication

To execute this request, you need a platform token or OAuth access token with storage:external-datastore-definitions:write scope. To learn how to obtain and use it, see Tokens and authentication.

Parameters

ParameterTypeDescriptionInRequired
storeNamestring

Name of the external datastore.

pathRequired
optimistic-locking-versioninteger

Version for optimistic locking. Must match the current stored version.

queryRequired
bodyPartialUpdateExternalDatastoreS3Dto-bodyRequired

Request body objects

The PartialUpdateExternalDatastoreS3Dto object

ElementTypeDescriptionRequired
bucketNamestring

The S3 bucket name.

Optional
connectionIdstring

References the connection settings object.

Optional
connectionNamestring

References the connection settings object.

Optional
displayNamestring

Descriptive name of the external datastore.

Optional
regionstring

The AWS region the S3 bucket resides in.

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.

{
"type": "s3://",
"displayName": "My Updated S3 Store",
"bucketName": "my-updated-s3-bucket"
}

Response

Response codes

CodeTypeDescription
200ExternalDatastoreS3Dto

Successfully updated external datastore definition.

400ErrorEnvelope

Invalid request.

401ErrorEnvelope

Unauthorized

403ErrorEnvelope

Missing permissions

404ErrorEnvelope

External datastore with provided name was not found.

409ErrorEnvelope

Optimistic locking version mismatch.

4XXErrorEnvelope

Client Error

5XXErrorEnvelope

Server Error.

Response body objects

The ExternalDatastoreS3Dto object

ElementTypeDescription
bucketNamestring

The S3 bucket name.

connectionIdstring

References the connection settings object.

connectionNamestring

References the connection settings object.

displayNamestring

Descriptive name of the external datastore.

namestring

Unique Name of the external datastore. Cannot be changed after creation.

regionstring

The AWS region the S3 bucket resides in.

typestring

Type of the external datastore.

versioninteger

Used for optimistic locking.

The ErrorEnvelope object

ElementTypeDescription
errorErrorResponse

The response for error state

The ErrorResponse object

The response for error state

ElementTypeDescription
codeinteger

Error code, which normally matches the HTTP error code.

detailsErrorResponseDetails

Detailed information about the error.

messagestring

A short, clear error message without details

The ErrorResponseDetails object

Detailed information about the error.

ElementTypeDescription
constraintViolationsErrorResponseDetailsConstraintViolations[]

Information about an input parameter that violated some validation rule of the service API.

errorMessagestring

Complete error message.

missingPermissionsstring[]

List of missing IAM permissions necessary to successfully execute the request.

missingScopesstring[]

List of missing IAM scopes necessary to successfully execute the request.

The ErrorResponseDetailsConstraintViolations object

Information about an input parameter that violated some validation rule of the service API.

ElementTypeDescription
messagestring

Message describing the error.

parameterDescriptorstring

Describes the violating parameter.

Response body JSON models

{
"type": "s3://",
"name": "my-s3-store",
"displayName": "My Updated S3 Store",
"bucketName": "my-updated-s3-bucket",
"region": "us-east-2",
"connectionId": "my-connection-id",
"connectionName": "my-connection-name",
"version": 2
}
{
"error": {
"message": "Constraint Violations",
"details": {
"constraintViolations": [
{
"message": "size must be between 0 and 200",
"parameterDescriptor": "displayName"
}
]
},
"code": 400
}
}
Related tags
Platform APIDynatrace Platform