Try it free

List external datastore definitions

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List all external datastore definitions in Dynatrace Grail with the External Datastores API to review which external sources Grail can query.

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

Overview

You use this operation to retrieve every external datastore definition in your environment, for example to audit which external sources Grail can query or to export the definitions to another environment. It takes no parameters and returns the full list with a 200 response. To read a single definition, use its name with the get operation.

Authentication

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

Parameters

The request doesn't provide any configurable parameters.

Response

Response codes

CodeTypeDescription
200ExternalDatastoreDtos

Successfully retrieved all external datastore definitions.

401ErrorEnvelope

Unauthorized

403ErrorEnvelope

Missing permissions

4XXErrorEnvelope

Client Error

5XXErrorEnvelope

Server Error.

Response body objects

The ExternalDatastoreDtos object

ElementTypeDescription
externalDatastoresExternalDatastoreS3Dto[]-

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

{
"externalDatastores": [
{
"type": "s3://",
"name": "my-s3-store",
"displayName": "My S3 Store",
"bucketName": "my-s3-bucket",
"region": "us-east-2",
"connectionId": "my-connection-id",
"connectionName": "my-connection-name",
"version": 1
}
]
}
{
"error": {
"message": "Constraint Violations",
"code": 400
}
}
Related tags
Platform APIDynatrace Platform