Update security deployment

PUT /platform/configuration/security/deployment
Basic auth Api key

Updates an existing security deployment configuration.

application/json

Body Required

The update request

  • version string

    The version of Elasticsearch to upgrade to. When not included, no upgrade is performed.

  • topology object

    The cluster topology for the Elasticsearch security deployment.

    Hide topology attributes Show topology attributes object
    • size object

      Measured by the amount of a resource. The final cluster size is calculated using multipliers from the topology instance configuration.

      Hide size attributes Show size attributes object
      • value integer(int32) Required

        Amount of resource

      • resource string Required

        Type of resource. In ESS the resource used should always be memory.

        Values are memory or storage.

    • zone_count integer(int32)

      The number of zones in which data nodes will be placed

Responses

  • 200 application/json

    The security deployment was successfully updated

    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)

    Hide response attribute Show response attribute object
    • id string Required

      The ID
  • 404 application/json

    The security deployment was not found. (code: security_deployment.not_found)

    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Value is security_deployment.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
  • 409 application/json
    • There is a version conflict. (code: security_deployment.version_conflict)
    • There is a version conflict. (code: security_deployment.already_exists)
    Hide headers attribute Show headers attribute
    • x-cloud-error-codes string

      The error codes associated with the response

      Values are security_deployment.version_conflict or security_deployment.already_exists.

    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
PUT /platform/configuration/security/deployment 
curl \
 --request PUT 'https://{{hostname}}/api/v1/platform/configuration/security/deployment' \
 --user "username:password" \
 --header "Content-Type: application/json" \
 --data '{"version":"string","topology":{"size":{"value":42,"resource":"memory"},"zone_count":42}}'