List all bucket definitions in Dynatrace with the Grail Storage Management API, including additional fields and newly created buckets after a short delay.
| GET | SaaS | https://{your-environment-id}.apps.dynatrace.com/platform/storage/management/v1/bucket-definitions |
You can use the add-fields query parameter to include additional response fields. The operation returns all bucket definitions, but newly created buckets may not appear immediately and can take up to one minute.
To execute this request, you need a platform token or OAuth access token with storage:bucket-definitions:read scope. To learn how to obtain and use it, see Tokens and authentication.
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| add-fields | string[] | add-fields: Define additional fields added to the response. Depending on the field this may result in longer response times:
Note: Hold down STRG on Windows/Linux or Command on Mac to select multiple values in the box below. The element can hold these values
| query | Optional |
| Code | Type | Description |
|---|---|---|
| 200 | Buckets | Successfully retrieved all bucket definitions |
| 400 | Error | bad request |
| 401 | Error | unauthorized |
| 403 | Error | missing permissions |
Buckets object| Element | Type | Description |
|---|---|---|
| buckets | Bucket[] | - |
Bucket object| Element | Type | Description |
|---|---|---|
| bucketClass | string | The class of the bucket. Read-only after creation. The element can hold these values
|
| bucketName | string | The unique identifier of the bucket within the tenant. |
| displayName | string | Descriptive name of the bucket. No restriction regarding unique naming or valid characters. |
| estimatedUncompressedBytes | integer | Estimated uncompressed size of the bucket in bytes. |
| estimatedUncompressedBytesOnDemand | integer | Estimated uncompressed size of on-demand data in the bucket in bytes. |
| estimatedUncompressedBytesQueryIncluded | integer | Estimated uncompressed size of query-included data in the bucket in bytes. |
| includedQueryLimitDays | integer | The period in days in which queries from the bucket are included in the pricing model. |
| metricInterval | string | Interval of aggregated metric data. Only applies to metric buckets. The element can hold these values
|
| records | integer | Amount of records in the bucket. |
| retentionDays | integer | The retention period in days of the data in the bucket. |
| status | string | The current status of the bucket, depending on bucket lifecycle. The element can hold these values
|
| table | string | Name of the table the bucket is assigned to. |
| updatable | boolean | A flag indicating whether a bucket can be updated or not. |
| version | integer | Optimistic locking version. Update requests define with this on which version the data updated is based on. This must match with the version stored, otherwise the update will fail due to concurrent modification. |
ErrorEnvelope object| Element | Type | Description |
|---|---|---|
| error | Exceptional | - |
ExceptionalReturn object| Element | Type | Description |
|---|---|---|
| code | integer | - |
| errorDetails | (Custom | - |
| message | string | - |
CustomValidationErrorInfo objectErrorInfo object| Element | Type | Description |
|---|---|---|
| message | string | - |
InvalidAuditEventsErrorInfo objectMediaTypeErrorInfo objectParameterErrorInfo objectProxyErrorInfo objectQueryFrontendRawErrorInfo objectRequestBodyErrorInfo object{"buckets": [{"bucketName": "default_metrics","table": "metrics","displayName": "Default metrics","status": "active","retentionDays": 462,"includedQueryLimitDays": 0,"metricInterval": "PT1M","version": 1,"updatable": false},{"bucketName": "default_bizevents","table": "bizevents","displayName": "Business events (35 days)","status": "active","retentionDays": 35,"includedQueryLimitDays": 0,"version": 1,"updatable": false}]}
{"error": {"code": 400,"message": "Missing request header","errorDetails": [{"type": "parameter","parameterDescriptor": "Dt-Tenant","message": "is required"}]}}