Set a Deployment's resource metadata

POST /deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw

Auth

Advanced use only. Sets the internal metadata, in free-form JSON, for the resource. Only use the parameter to set the modified JSON that is returned from the get version of the metadata.

Path parameters

deployment_id string required: Identifier for the Deployment
resource_kind enum required: The kind of resource; Values: elasticsearch kibana apm appsearch enterprise_search integrations_server
ref_id string required: User-specified RefId for the Resource (or '_main' if there is only one)

Query parameters

version string: If specified, checks for conflicts against the metadata version (returned in 'x-cloud-resource-version' of the GET request)

Request body

The freeform JSON for the cluster (should always be based on the current version retrieved from the GET)

Type: string

Responses

The resource metadata was successfully changed (the updated JSON is returned)

application/json

Response Type: string

Response headers

x-cloud-resource-version string: The resource version, which is used to avoid update conflicts with concurrent operations
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)

The metadata is invalid. (code: deployments.invalid_metadata)

application/json

The Deployment specified by {deployment_id} cannot be found. (code: deployments.deployment_not_found)
The Resource specified by {ref_id} cannot be found. (code: deployments.deployment_resource_not_found)

application/json

Please retry. (code: deployments.metadata_internal_error)

application/json

We have failed you. (code: deployments.metadata_internal_error)

application/json