Get a bucket definition

• Latest Dynatrace
• Reference
• Published Oct 13, 2026

Get a bucket definition in Dynatrace with the Grail Storage Management API by name, including additional fields and newly created buckets after a short delay.

Overview

You must supply the bucketName path parameter, and you can use add-fields to include additional response fields. The operation returns the matching bucket definition, though newly created buckets may take up to one minute to appear.

Authentication

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.

Parameters

Response

{
  "bucketName": "default_metrics",
  "table": "metrics",
  "displayName": "Default metrics",
  "status": "active",
  "retentionDays": 462,
  "includedQueryLimitDays": 0,
  "metricInterval": "PT1M",
  "version": 1,
  "updatable": false
}

{
  "error": {
    "code": 400,
    "message": "Missing request header",
    "errorDetails": [
      {
        "type": "parameter",
        "parameterDescriptor": "Dt-Tenant",
        "message": "is required"
      }
    ]
  }
}