Get an external datastore definition in Dynatrace Grail by its name with the External Datastores API to inspect how an external source is set up.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/v1/external-datastore-definitions/{storeName} |
You use the storeName path parameter to read one external datastore definition, for example to check its settings before you update it. The operation returns the stored definition with a 200 response. To change it afterward, use the full or partial update operation with the optimistic-locking-version that matches the stored definition.
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.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| storeName | string | Name of the external datastore. | path | Required |
| Code | Type | Description |
|---|---|---|
| 200 | External | Successfully retrieved external datastore definition. |
| 400 | Error | Bad Request |
| 401 | Error | Unauthorized |
| 403 | Error | Missing permissions |
| 404 | Error | External datastore with provided name was not found. |
| 4XX | Error | Client Error |
| 5XX | Error | Server Error. |
ExternalDatastoreS3Dto object| Element | Type | Description |
|---|---|---|
| bucketName | string | The S3 bucket name. |
| connectionId | string | References the connection settings object. |
| connectionName | string | References the connection settings object. |
| displayName | string | Descriptive name of the external datastore. |
| name | string | Unique Name of the external datastore. Cannot be changed after creation. |
| region | string | The AWS region the S3 bucket resides in. |
| type | string | Type of the external datastore. |
| version | integer | Used for optimistic locking. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Error | The response for error state |
ErrorResponse objectThe response for error state
| Element | Type | Description |
|---|---|---|
| code | integer | Error code, which normally matches the HTTP error code. |
| details | Error | Detailed information about the error. |
| message | string | A short, clear error message without details |
ErrorResponseDetails objectDetailed information about the error.
| Element | Type | Description |
|---|---|---|
| constraintViolations | Error | Information about an input parameter that violated some validation rule of the service API. |
| errorMessage | string | Complete error message. |
| missingPermissions | string[] | List of missing IAM permissions necessary to successfully execute the request. |
| missingScopes | string[] | List of missing IAM scopes necessary to successfully execute the request. |
ErrorResponseDetailsConstraintViolations objectInformation about an input parameter that violated some validation rule of the service API.
| Element | Type | Description |
|---|---|---|
| message | string | Message describing the error. |
| parameterDescriptor | string | Describes the violating parameter. |
{"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","details": {"constraintViolations": [{"message": "must not be blank","parameterDescriptor": "storeName"}]},"code": 400}}