Try it free

Update a fieldset

  • Latest Dynatrace
  • Reference
  • Published Oct 13, 2026

Update a fieldset in Dynatrace with the Grail Fieldsets API by replacing its definition, using the UID and optimistic locking version.

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

Overview

You must supply the fieldsetUid path parameter and the optimistic-locking-version query parameter to apply the update to the correct base version. The request body can include buckets, description, enabled, fields, scope, and tables, and the operation returns 200 when the fieldset is successfully updated.

Authentication

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

Parameters

ParameterTypeDescriptionInRequired
fieldsetUidstring

UID of the fieldset

pathRequired
optimistic-locking-versioninteger

optimistic-locking-version defines the base version that this update applies to. You can get the current version of a fieldset by checking the version field in the JSON Response of GET fieldsets or GET fieldset ATTENTION: this version and the version value in the JSON body must match.

queryRequired
bodyUpdateFieldsetRequest-bodyRequired

Request body objects

The UpdateFieldsetRequest object

ElementTypeDescriptionRequired
bucketsstring[]

List of the buckets on which fieldset is applicable.

Optional
descriptionstring

Description of the fieldset.

Optional
enabledboolean

Description of the fieldset.

Optional
fieldsstring[]

List of the fields.

Required
scopestring

Scope of the fieldset.

The element can hold these values
  • BUCKET
  • TABLE
  • TENANT
Required
tablesstring[]

List of the tables on which fieldset is applicable.

Optional

Request body JSON model

This is a model of the request body, showing the possible elements. It has to be adjusted for usage in an actual request.

{
"description": "Sensitive field set on table",
"enabled": true,
"scope": "TABLE",
"fields": [
"email",
"userid"
],
"tables": [
"spans",
"logs"
]
}

Response

Response codes

CodeTypeDescription
200-

fieldset successfully updated.

400ErrorEnvelope

Bad Request: the server cannot process the request due to a supposed client error.

404ErrorEnvelope

Not found: the server cannot find the requested fieldset.

5XXErrorEnvelope

Server error.

Response body objects

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

{
"error": {
"message": "Constraint Violations",
"details": {
"constraintViolations": [
{
"message": "size must be between 0 and 512",
"parameterDescriptor": "description"
}
]
},
"code": 400
}
}
Related tags
Platform APIDynatrace Platform