Manage Dynatrace Grail Storage Management API bucket definitions: create, update, truncate, delete, and administer Grail buckets lifecycle.
Use the @dynatrace-sdk/client-bucket-management SDK client instead of calling this API directly — it handles authentication, typing, and the environment URL for you. This REST reference is for external and automation use.
This API allows you to manage storage for Grail. Data is organizied in buckets. To get familiar with the data model within Grail check the Grail data model documentation.
There are 4 permissions that are enabling the management of the Grail bucket storage. More about Grail storage permissions can be read in the documentation.
storage:bucket-definitions:read
storage:bucket-definitions:write
storage:bucket-definitions:delete
storage:bucket-definitions:truncate
Operations which modify buckets use mandatory optimistic locking. When such operations are executed, the user must provide the version upon which they operate. The version can be found in the JSON within the response of GET bucket definitions or GET bucket definition.
If the document version in the service doesn't match, because the document has been modified in the meantime, then the operation gets rejected.
Creating a custom storage bucket can have benefits in terms of data management. Read more about custom buckets.
Bucket creation can take up to 1 minute.
To create a new custom Grail bucket with Storage Management you need to specify:
A unique bucket name
Bucket name can not start with
The bucket name can't be edited or changed at a later time.
Display name. You can use this field to describe your bucket.
Retention period in days between 1 day - 3657 days (10 years).
Platform API endpoints use Platform token and OAuth client authentication. Attach a platform token or OAuth access token to the Authorization HTTP header using the Bearer scheme.
--header 'Authorization: Bearer <platform-token-or-oauth-access-token>'
For details, see Tokens and authentication and Platform tokens.
GET /bucket-definitions)POST /bucket-definitions)GET /bucket-definitions/{bucketName})PUT /bucket-definitions/{bucketName})DELETE /bucket-definitions/{bucketName})PATCH /bucket-definitions/{bucketName})POST /bucket-definitions/{bucketName}:truncate)