Elastic Stack (ELK Stack) Platform Configuration Security API

openapi: 3.2.0
info:
  version: '1'
  title: Elastic Cloud Enterprise Platform Configuration Security API
  termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:
- name: PlatformConfigurationSecurity
paths:
  /platform/configuration/security/deployment:
    get:
      tags:
      - PlatformConfigurationSecurity
      summary: Get current security deployment
      description: Retrieves the current security deployment.
      operationId: get-security-deployment
      responses:
        '200':
          description: The security deployment was successfully returned
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityDeployment'
        '404':
          description: 'The realm specified by {realm_id} cannot be found. (code: `security_deployment.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Deployment
    post:
      tags:
      - PlatformConfigurationSecurity
      summary: Create security deployment
      description: Creates a new security deployment configuration.
      operationId: create-security-deployment
      responses:
        '201':
          description: The security deployment was successfully created
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdResponse'
        '409':
          description: '* There is a version conflict. (code: `security_deployment.version_conflict`)

            * There is a version conflict. (code: `security_deployment.already_exists`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.version_conflict
                - security_deployment.already_exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityDeploymentCreateRequest'
        description: The deployment request
        required: true
    put:
      tags:
      - PlatformConfigurationSecurity
      summary: Update security deployment
      description: Updates an existing security deployment configuration.
      operationId: update-security-deployment
      responses:
        '200':
          description: The security deployment was successfully updated
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/IdResponse'
        '409':
          description: '* There is a version conflict. (code: `security_deployment.version_conflict`)

            * There is a version conflict. (code: `security_deployment.already_exists`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.version_conflict
                - security_deployment.already_exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '404':
          description: 'The security deployment was not found. (code: `security_deployment.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Deployment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityDeploymentUpdateRequest'
        description: The update request
        required: true
  /platform/configuration/security/enrollment-tokens:
    get:
      tags:
      - PlatformConfigurationSecurity
      summary: Get enrollment tokens
      description: Retrieves a list of active enrollment tokens.
      operationId: get-enrollment-tokens
      responses:
        '200':
          description: A token has been generated that can be used to start new servers with the requested roles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEnrollmentTokenReply'
      x-doc:
        tag: Platform - Configuration - Security
    post:
      tags:
      - PlatformConfigurationSecurity
      summary: Create enrollment token
      description: Creates an enrollment token.
      operationId: create-enrollment-token
      responses:
        '200':
          description: A token has been generated that can be used to start new servers with the requested roles
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RequestEnrollmentTokenReply'
        '400':
          description: 'The token request format was invalid, details in the error (code: ''enrollment_tokens.invalid_token_request'')'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '403':
          description: 'No signing key is available to generate a token (code: ''enrollment_tokens.signing_key_not_found'')'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentTokenRequest'
        description: Request parameters for the enrollment token
        required: true
  /platform/configuration/security/enrollment-tokens/{token}:
    delete:
      tags:
      - PlatformConfigurationSecurity
      summary: Delete enrollment token
      description: Revokes and deletes the enrollment token.
      operationId: delete-enrollment-token
      parameters:
      - name: token
        in: path
        description: The token or token identifier to revoke.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The supplied token has been revoked and can no longer be used to start services on new servers
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '404':
          description: 'Token not found (code: ''enrollment_tokens.invalid_token_id'')'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security
  /platform/configuration/security/realms:
    get:
      tags:
      - PlatformConfigurationSecurity
      summary: List security realm configurations
      description: Retrieves a list of security realm configurations.
      operationId: get-security-realm-configurations
      responses:
        '200':
          description: The security realm configurations were successfully returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecurityRealmInfoList'
      x-doc:
        tag: Platform - Configuration - Security Realms
  /platform/configuration/security/realms/_reorder:
    post:
      tags:
      - PlatformConfigurationSecurity
      summary: Reorder security realms
      description: Reorder security realms.
      operationId: reorder-security-realms
      responses:
        '200':
          description: The reorder request was successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: '* Invalid ids . (code: `security_realm.invalid_ids`)

            * Missing ids . (code: `security_realm.missing_ids`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.invalid_ids
                - security_realm.missing_ids
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SecurityRealmsReorderRequest'
        description: The reorder request
        required: true
  /platform/configuration/security/realms/active-directory:
    post:
      tags:
      - PlatformConfigurationSecurity
      summary: Create Active Directory configuration
      description: 'Creates a new Active Directory configuration. '
      operationId: create-active-directory-configuration
      responses:
        '201':
          description: The Active Directory configuration was successfully created
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: '* The realm id is already in use. (code: `security_realm.id_conflict`)

            * The selected id is not valid. (code: `security_realm.invalid_id`)

            * Order must be greater than zero. (code: `security_realm.invalid_order`)

            * Invalid Elasticsearch Security realm type. (code: `security_realm.invalid_type`)

            * The realm order is already in use. (code: `security_realm.order_conflict`)

            * Advanced YAML format is invalid. (code: `security_realm.invalid_yaml`)

            * The url format is invalid. (code: `security_realm.invalid_url`)

            * Invalid Active Directory URL. (code: `security_realm.active_directory.invalid_url`)

            * Invalid certificate bundle URL. (code: `security_realm.invalid_bundle_url`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.id_conflict
                - security_realm.invalid_id
                - security_realm.invalid_order
                - security_realm.invalid_type
                - security_realm.order_conflict
                - security_realm.invalid_yaml
                - security_realm.invalid_url
                - security_realm.active_directory.invalid_url
                - security_realm.invalid_bundle_url
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActiveDirectorySettings'
        description: The Active Directory configuration
        required: true
  /platform/configuration/security/realms/active-directory/{realm_id}:
    get:
      tags:
      - PlatformConfigurationSecurity
      summary: Get Active Directory configuration
      description: 'Retrieves a single Active Directory security realm configuration. '
      operationId: get-active-directory-configuration
      parameters:
      - name: realm_id
        in: path
        description: The Elasticsearch Security realm identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The Active Directory configuration was successfully retrieved
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActiveDirectorySettings'
        '404':
          description: 'The realm specified by {realm_id} cannot be found. (code: `security_realm.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
    put:
      tags:
      - PlatformConfigurationSecurity
      summary: Update Active Directory configuration
      description: 'Updates an existing Active Directory configuration. '
      operationId: update-active-directory-configuration
      parameters:
      - name: realm_id
        in: path
        description: The Elasticsearch Security realm identifier.
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The Active Directory configuration was successfully updated
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: '* The realm id is already in use. (code: `security_realm.id_conflict`)

            * The selected id is not valid. (code: `security_realm.invalid_id`)

            * Order must be greater than zero. (code: `security_realm.invalid_order`)

            * Invalid Elasticsearch Security realm type. (code: `security_realm.invalid_type`)

            * The realm order is already in use. (code: `security_realm.order_conflict`)

            * Advanced YAML format is invalid. (code: `security_realm.invalid_yaml`)

            * The url format is invalid. (code: `security_realm.invalid_url`)

            * Invalid Active Directory URL. (code: `security_realm.active_directory.invalid_url`)

            * Invalid certificate bundle URL. (code: `security_realm.invalid_bundle_url`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.id_conflict
                - security_realm.invalid_id
                - security_realm.invalid_order
                - security_realm.invalid_type
                - security_realm.order_conflict
                - security_realm.invalid_yaml
                - security_realm.invalid_url
                - security_realm.active_directory.invalid_url
                - security_realm.invalid_bundle_url
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '404':
          description: 'The realm specified by {realm_id} cannot be found. (code: `security_realm.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There is a version conflict. (code: `security_realm.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ActiveDirectorySettings'
        description: The Active Directory configuration
        required: true
    delete:
      tags:
      - PlatformConfigurationSecurity
      summary: Delete Active Directory configuration
      description: 'Deletes a single Active Directory configuration. '
      operationId: delete-active-directory-configuration
      parameters:
      - name: realm_id
        in: path
        description: The Elasticsearch Security realm identifier.
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The Active Directory configuration was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '404':
          description: 'The realm specified by {realm_id} cannot be found. (code: `security_realm.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There is a version conflict. (code: `security_realm.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
  /platform/configuration/security/realms/ldap:
    post:
      tags:
      - PlatformConfigurationSecurity
      summary: Create LDAP configuration
      description: Creates a new LDAP configuration.
      operationId: create-ldap-configuration
      responses:
        '201':
          description: The LDAP configuration was successfully created
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: '* The realm id is already in use. (code: `security_realm.id_conflict`)

            * The selected id is not valid. (code: `security_realm.invalid_id`)

            * Order must be greater than zero. (code: `security_realm.invalid_order`)

            * Invalid Elasticsearch Security realm type. (code: `security_realm.invalid_type`)

            * The realm order is already in use. (code: `security_realm.order_conflict`)

            * Advanced YAML format is invalid. (code: `security_realm.invalid_yaml`)

            * The url format is invalid. (code: `security_realm.invalid_url`)

            * Invalid LDAP URL. (code: `security_realm.ldap.invalid_url`)

            * Invalid certificate bundle URL. (code: `security_realm.invalid_bundle_url`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.id_conflict
                - security_realm.invalid_id
                - security_realm.invalid_order
                - security_realm.invalid_type
                - security_realm.order_conflict
                - security_realm.invalid_yaml
                - security_realm.invalid_url
                - security_realm.ldap.invalid_url
                - security_realm.invalid_bundle_url
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LdapSettings'
        description: The LDAP configuration
        required: true
  /platform/configuration/security/realms/ldap/{realm_id}:
    get:
      tags:
      - PlatformConfigurationSecurity
      summary: Get LDAP configuration
      description: Retrieves a single LDAP security realm configuration.
      operationId: get-ldap-configuration
      parameters:
      - name: realm_id
        in: path
        description: The Elasticsearch Security realm identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The LDAP configuration was successfully retrieved
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LdapSettings'
        '404':
          description: 'The realm specified by {realm_id} cannot be found. (code: `security_realm.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
    put:
      tags:
      - PlatformConfigurationSecurity
      summary: Update LDAP configuration
      description: Updates an existing LDAP configuration.
      operationId: update-ldap-configuration
      parameters:
      - name: realm_id
        in: path
        description: The Elasticsearch Security realm identifier.
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The LDAP configuration was successfully updated
          headers:
            x-cloud-resource-version:
              description: The resource version, which is used to avoid update conflicts with concurrent operations
              schema:
                type: string
            x-cloud-resource-created:
              description: The date-time when the resource was created (ISO format relative to UTC)
              schema:
                type: string
            x-cloud-resource-last-modified:
              description: The date-time when the resource was last modified (ISO format relative to UTC)
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '400':
          description: '* The realm id is already in use. (code: `security_realm.id_conflict`)

            * The selected id is not valid. (code: `security_realm.invalid_id`)

            * Order must be greater than zero. (code: `security_realm.invalid_order`)

            * Invalid Elasticsearch Security realm type. (code: `security_realm.invalid_type`)

            * The realm order is already in use. (code: `security_realm.order_conflict`)

            * Advanced YAML format is invalid. (code: `security_realm.invalid_yaml`)

            * The url format is invalid. (code: `security_realm.invalid_url`)

            * Invalid LDAP URL. (code: `security_realm.ldap.invalid_url`)

            * Invalid certificate bundle URL. (code: `security_realm.invalid_bundle_url`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.id_conflict
                - security_realm.invalid_id
                - security_realm.invalid_order
                - security_realm.invalid_type
                - security_realm.order_conflict
                - security_realm.invalid_yaml
                - security_realm.invalid_url
                - security_realm.ldap.invalid_url
                - security_realm.invalid_bundle_url
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '404':
          description: 'The realm specified by {realm_id} cannot be found. (code: `security_realm.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There is a version conflict. (code: `security_realm.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_realm.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Configuration - Security Realms
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LdapSettings'
        description: The LDAP configuration
        required: true
    delete:
      tags:
      - PlatformConfigurationSecurity
      summary: Delete LDAP configuration
      description: Deletes a single LDAP configuration.
      operationId: delete-ldap-configuration
      parameters:
      - name: realm_id
        in: path
        description: The Elasticsearch Security realm identifier.
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: When specified, checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: The LDAP configuration was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/sc

# --- truncated at 32 KB (77 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/elk-stack/refs/heads/main/openapi/elk-stack-platformconfigurationsecurity-api-openapi.yml