Set a Deployment's resource metadata

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

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 string Required

The kind of resource

Values are elasticsearch, kibana, apm, appsearch, enterprise_search, or 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)

Body Required

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

string string

Responses

200

The resource metadata was successfully changed (the updated JSON is returned)
Hide headers attributes Show headers attributes
- 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)
400

The metadata is invalid. (code: deployments.invalid_metadata)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.invalid_metadata.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
404
- 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)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Values are deployments.deployment_not_found or deployments.deployment_resource_not_found.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
449

Please retry. (code: deployments.metadata_internal_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.metadata_internal_error.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields
500

We have failed you. (code: deployments.metadata_internal_error)
Hide headers attribute Show headers attribute
- x-cloud-error-codes string
  
  The error codes associated with the response
  
  Value is deployments.metadata_internal_error.
Hide response attribute Show response attribute object
- errors array[object] Required
  
  A list of errors that occurred in the failing request
  
  Hide errors attributes Show errors attributes object
  
  code string Required
  
  A structured code representing the error type that occurred
  
  message string Required
  
  A human readable message describing the error that occurred
  
  fields array[string]
  
  If the error can be tied to a specific field or fields in the user request, this lists those fields

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

curl \
 -X POST https://{{hostname}}/api/v1/deployments/{deployment_id}/{resource_kind}/{ref_id}/metadata/raw \
 -d '"string"'

Request examples

string

Response examples (200)

# Headers
x-cloud-resource-version: string
x-cloud-resource-created: string
x-cloud-resource-last-modified: string

# Payload
string

Response examples (400)

# Headers
x-cloud-error-codes: deployments.invalid_metadata

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (404)

# Headers
x-cloud-error-codes: deployments.deployment_not_found

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (449)

# Headers
x-cloud-error-codes: deployments.metadata_internal_error

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}

Response examples (500)

# Headers
x-cloud-error-codes: deployments.metadata_internal_error

# Payload
{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "fields": [
        "string"
      ]
    }
  ]
}