Try it free

List fieldsets

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

List fieldsets in Dynatrace with the Grail Fieldsets API, filtering by enabled or disabled status to review available definitions.

GETSaaShttps://{your-environment-id}.apps.dynatrace.com/platform/storage/fieldsets/v1/fieldsets

Overview

You can use the enabled query parameter to filter the fieldsets returned by this operation. It responds with fieldsets successfully retrieved, giving you the current set of fieldset definitions.

Authentication

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

Parameters

ParameterTypeDescriptionInRequired
enabledboolean

enabled or disabled fieldsets

queryOptional

Response

Response codes

CodeTypeDescription
200Fieldsets

fieldsets successfully retrieved.

5XXErrorEnvelope

Server error.

Response body objects

The Fieldsets object

ElementTypeDescription
fieldsetsFieldset[]

List of fieldsets.

The Fieldset object

ElementTypeDescription
bucketsstring[]

List of the buckets on which fieldset is applicable.

createdstring

Timestamp in ISO-8601 indicating when the field record was created.

createdBystring

Creator of the fieldset.

descriptionstring

Description of the fieldset.

enabledboolean

Indicates if the fieldset is enabled.

fieldsstring[]

List of the fields.

lastModifiedstring

Timestamp in ISO-8601 indicating when the field record was updated.

lastModifiedBystring

Last user who modified the fieldset.

namestring

Name of the fieldset.

readOnlyboolean

Indicates if the fieldset is read only and can not be updated.

scopestring

Scope of the fieldset.

tablesstring[]

List of the tables on which fieldset is applicable.

uidstring

Unique identifier of the fieldset.

versioninteger

Used for optimistic locking. 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.

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

{
  "fieldsets": [
    {
      "uid": "1",
      "name": "sensitive-fields-on-table",
      "description": "",
      "createdBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45",
      "enabled": true,
      "readOnly": false,
      "scope": "TABLE",
      "fields": [
        "email",
        "userid"
      ],
      "tables": [
        "spans",
        "logs"
      ],
      "version": 1,
      "lastModifiedBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45",
      "created": "2024-01-01T15:04:20.698Z",
      "lastModified": "2024-12-31T18:06:09.647Z"
    },
    {
      "uid": "2",
      "name": "sensitive-fields-on-buckets",
      "description": "",
      "createdBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45",
      "enabled": true,
      "readOnly": false,
      "scope": "BUCKET",
      "fields": [
        "email",
        "userid"
      ],
      "buckets": [
        "default_spans",
        "default_logs"
      ],
      "version": 1,
      "lastModifiedBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45",
      "created": "2024-01-01T15:04:20.698Z",
      "lastModified": "2024-12-31T18:06:09.647Z"
    },
    {
      "uid": "3",
      "name": "sensitive-fields",
      "description": "",
      "createdBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45",
      "enabled": true,
      "readOnly": false,
      "scope": "TENANT",
      "fields": [
        "email",
        "userid"
      ],
      "version": 1,
      "lastModifiedBy": "6e6abcde-3e36-42ab-bc5c-9abcdec123a45",
      "created": "2024-01-01T15:04:20.698Z",
      "lastModified": "2024-12-31T18:06:09.647Z"
    }
  ]
}
{
  "error": {
    "message": "Something went wrong. The issue was logged",
    "code": 500
  }
}
Related tags
Platform APIDynatrace Platform