Responses

• 200

  The security deployment was successfully 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)

  Hide response attributes Show response attributes object

  • cluster_id string Required

    The identifier for the security deployment cluster

  • deployment_id string

    The identifier for the security deployment

  • name string Required

    The name of the security deployment cluster

  • version string

    The version of the Elasticsearch cluster

  • status string Required

    The current status of the cluster

    Values are initializing, stopping, stopped, rebooting, restarting, reconfiguring, or started.

  • has_pending_plan boolean Required

    True if a pending plan is in progress

  • is_healthy boolean Required

    True if the cluster is healthy

  • is_enabled boolean Required

    True if the security cluster is currently enabled

• 404

  The realm specified by {realm_id} cannot be 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