Create security deployment

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

Creates a new security deployment configuration.

application/json

Body Required

The deployment request

  • name string

    The name of the security deployment cluster

  • version string

    The version of the Elasticsearch cluster

  • topology object

    The cluster topology used to create the security deployment cluster

    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

  • 201 application/json

    The security deployment was successfully created

    Hide headers attributes Show headers attributes
    Hide response attribute Show response attribute object
    • id string Required

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