Replace label assignments

PUT/v2/labels/assignments

Replaces the complete label set for one target atomically, ignoring label IDs that do not exist in the caller's organization and removing stale assignments. The response contains only existing label IDs. Concurrent replacements use last-write-wins semantics. The operation requires only the target resource's update permission: dashboards|update, datasets|update, monitors|update, or notifiers|update. Datasets must also be readable, writable, and owned by the caller's organization. Monitor dataset permissions match those required to read the monitor. A target that uses the wrong identifier for its type returns 400. An unknown target type, duplicate label IDs, and more than 500 label IDs fail request validation with 422. A target that does not exist or is not owned by the caller's organization returns 404.

Body

application/json

Property	Type	Description
`labelIds`	`string[]`Required
`target`	`object`Required	A resource that supports organization labels. Single-identifier targets use id; frontend-generated integration dashboards use templateId and dataset.
`dataset`	`string`	Required only for frontend-generated integration dashboards and rejected for other target types. Use the current dataset name. Assignments use the underlying dataset instance, so permanent deletion and recreation do not restore old labels.
`id`	`string`	Public identifier for the resource. Use the dashboard UID for a dashboard, the dataset name for a dataset, and the ID returned by the monitor, notifier, or backend-provided integration dashboard APIs.
`templateId`	`string`	Stable frontend-owned template key for a frontend-generated integration dashboard, such as k8s.stats. Requires dataset and rejects id. Whitespace and control characters are rejected.
`type`	`string`Required

Request

curl -X PUT 'https://api.axiom.co/v2/labels/assignments' \
  -H 'Authorization: Bearer API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"labelIds":["string"],"target":{"dataset":"string","id":"string","templateId":"string","type":"dashboard"}}'

Try itRun this request against your Axiom organization

Credentials stay in this browser tab and are only sent to Axiom when you run the request.

API token RequiredRequest body application/json

Response

200The target's complete label set after the atomic replacement.

application/json

400The target uses the wrong identifier for its type.

403The caller lacks the target resource's update permission, or the dataset is shared or not writable.

404The target does not exist or is not owned by the caller's organization.

422Request validation failed. The payload contains an unknown target type, duplicate label IDs, or more than 500 label IDs.

Property	Type	Description
`labelIds`	`string[]`Required
`target`	`object`Required	A resource that supports organization labels. Single-identifier targets use id; frontend-generated integration dashboards use templateId and dataset.
`dataset`	`string`	Required only for frontend-generated integration dashboards and rejected for other target types. Use the current dataset name. Assignments use the underlying dataset instance, so permanent deletion and recreation do not restore old labels.
`id`	`string`	Public identifier for the resource. Use the dashboard UID for a dashboard, the dataset name for a dataset, and the ID returned by the monitor, notifier, or backend-provided integration dashboard APIs.
`templateId`	`string`	Stable frontend-owned template key for a frontend-generated integration dashboard, such as k8s.stats. Requires dataset and rejects id. Whitespace and control characters are rejected.
`type`	`string`Required