Set cluster metadataedit
DEPRECATED (Scheduled to be removed in the next major version): Advanced use only. Sets the internal metadata, in free-form JSON, for the APM instance. Only use the parameters to set the modified JSON that is returned from the get version of the metadata.
Requestedit
POST /api/v1/clusters/apm/{cluster_id}/metadata/raw
Path parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
Y |
The APM deployment identifier. |
Query parametersedit
Name | Type | Required | Description |
---|---|---|---|
|
|
N |
Checks for conflicts against the metadata version, then returns the value in the |
Request bodyedit
(string
) (required) The freeform JSON for the cluster (should always be based on the current version retrieved from the GET)
Responsesedit
-
200
-
(
object
) The cluster metadata was successfully changed (the updated JSON is returned)Headers
-
x-cloud-resource-created
(string
) - The date-time when the resource was created (ISO format relative to UTC)
-
x-cloud-resource-last-modified
(string
) - The date-time when the resource was last modified (ISO format relative to UTC)
-
x-cloud-resource-version
(string
) - The resource version, which is used to avoid update conflicts with concurrent operations
-
-
404
-
(
BasicFailedReply
) The cluster specified by {cluster_id} cannot be found (code: 'clusters.cluster_not_found') -
449
-
(
BasicFailedReply
) Elevated permissions are required. (code: '"root.unauthorized.rbac.elevated_permissions_required"')
To perform this operation, you must be authenticated by means of one of the following methods: apiKey, basicAuth.
Request exampleedit
curl -XPOST https://{{hostname}}/api/v1/clusters/apm/{cluster_id}/metadata/raw \ -H "Authorization: ApiKey $ECE_API_KEY"