Elastic Stack (ELK Stack) Platform Infrastructure API

openapi: 3.2.0
info:
  version: '1'
  title: Elastic Cloud Enterprise Platform Infrastructure API
  termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:
- name: PlatformInfrastructure
paths:
  /platform/configuration/api_base_url:
    get:
      tags:
      - PlatformInfrastructure
      summary: Get API base Url
      description: Gets the API base Url configuration value.
      operationId: get-api-base-url
      responses:
        '200':
          description: The API base Url 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/ApiBaseUrlData'
        '404':
          description: 'There is no configured API base value but optimistic locking was sent. (code: `adminconsole.base_url.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsole.base_url.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '500':
          description: 'The persisted Url is malformed. (code: `adminconsole.base_url.invalid_persisted_data`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsole.base_url.invalid_persisted_data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: API - Base Url
    put:
      tags:
      - PlatformInfrastructure
      summary: Set API base Url
      description: Saves the API base Url configuration value.
      operationId: set-api-base-url
      parameters:
      - name: version
        in: query
        description: If specified, then checks for conflicts against the version stored in the persistent store (returned in 'x-cloud-resource-version' of the GET request). If not specified, will unconditionally upsert.
        required: false
        schema:
          type: string
      - name: skip_cascading_operations
        in: query
        description: Whether or not to skip cascading operations, such as re-provisioning the Security Deployment.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: The API base Url was successfully saved.
          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/ApiBaseUrlData'
        '400':
          description: 'The optimistic locking version format was wrong. (code: `adminconsole.base_url.bad_version_format`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsole.base_url.bad_version_format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '412':
          description: 'skip_cascading_operations was false but the Security Deployment already had a pending plan. (code: `security_deployment.cluster_pending_plan_exists`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - security_deployment.cluster_pending_plan_exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '404':
          description: 'There is no configured API base value but optimistic locking was sent. (code: `adminconsole.base_url.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsole.base_url.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There was an optimistic locking version conflict. (code: `adminconsole.base_url.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsole.base_url.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: API - Base Url
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApiBaseUrlData'
        description: Data containing the base Url to set
        required: true
  /platform/configuration/store:
    get:
      tags:
      - PlatformInfrastructure
      summary: List Config Store Option
      description: List all existing Config Store Option.
      operationId: list-config-store-option
      responses:
        '200':
          description: List of existing Config Store Option
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfigStoreOptionList'
      x-doc:
        tag: Platform - configuration - Store
  /platform/configuration/store/{config_option_id}:
    get:
      tags:
      - PlatformInfrastructure
      summary: Find Config Store Option by name
      description: Find Config Store Option by name.
      operationId: get-config-store-option
      parameters:
      - name: config_option_id
        in: path
        description: Name of the Config Store Option that you would like to find
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Config Store Option retrieved successfully
          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/ConfigStoreOption'
        '404':
          description: 'Config Store Option do not exist by that name. (code: `platform.config.store.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - platform.config.store.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - configuration - Store
    post:
      tags:
      - PlatformInfrastructure
      summary: Create Config Store Option
      description: Inserts new Config Store Option.
      operationId: create-config-store-option
      parameters:
      - name: config_option_id
        in: path
        description: Name of the Config Store Option that you would like to create
        required: true
        schema:
          type: string
      responses:
        '201':
          description: The Config Store Option was inserted successfully
          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/ConfigStoreOption'
        '400':
          description: 'Config Store Option data already exists for the given name. (code: `platform.config.store.already_exists`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - platform.config.store.already_exists
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - configuration - Store
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigStoreOptionData'
        description: The Config Store Option definition
        required: true
    put:
      tags:
      - PlatformInfrastructure
      summary: Update Config Store Option
      description: Update existing Config Store Option.
      operationId: put-config-store-option
      parameters:
      - name: config_option_id
        in: path
        description: Name of the Config Store Option that you would like to modify
        required: true
        schema:
          type: string
      - name: version
        in: query
        description: If specified then 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: Config Store Option retrieved successfully
          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/ConfigStoreOption'
        '404':
          description: 'There was no existing data for the given Config Store Id. (code: `platform.config.store.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - platform.config.store.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '409':
          description: 'There is a version conflict. (code: `platform.config.store.version_conflict`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - platform.config.store.version_conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - configuration - Store
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfigStoreOptionData'
        description: The Config Store Option definition
        required: true
    delete:
      tags:
      - PlatformInfrastructure
      summary: Delete Config Store Option by name
      description: Delete Config Store Option by name.
      operationId: delete-config-store-option
      parameters:
      - name: config_option_id
        in: path
        description: Name of the Config Store Option that you would like to delete
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Config Store Option deleted successfully
          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'
        '404':
          description: 'Config Store Option do not exist by that name. (code: `platform.config.store.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - platform.config.store.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - configuration - Store
  /platform/infrastructure/adminconsoles:
    get:
      tags:
      - PlatformInfrastructure
      summary: Get adminconsoles
      description: Retrieves an overview of all adminconsoles.
      operationId: get-adminconsoles
      responses:
        '200':
          description: An overview of all adminconsoles.
          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/AdminconsolesOverview'
      x-doc:
        tag: Platform - Adminconsoles
  /platform/infrastructure/adminconsoles/_reindex:
    post:
      tags:
      - PlatformInfrastructure
      summary: Reindex region indices
      description: Start reindex of all regional indices.
      operationId: reindex-adminconsoles
      responses:
        '202':
          description: Started reindexing of regional indices.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
      x-doc:
        tag: Platform - Adminconsoles
  /platform/infrastructure/adminconsoles/{adminconsole_id}/logging_settings:
    get:
      tags:
      - PlatformInfrastructure
      summary: Get adminconsole logging settings
      description: Get the logging settings for this adminconsole instance.
      operationId: get-adminconsole-logging-settings
      parameters:
      - name: adminconsole_id
        in: path
        description: The identifier for the adminconsole instance
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The logging settings for the adminconsole instance
          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/LoggingSettings'
        '404':
          description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsoles.logging_settings.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Adminconsoles
    put:
      tags:
      - PlatformInfrastructure
      summary: Set adminconsole logging settings
      description: Set the logging settings for this adminconsole instance.
      operationId: set-adminconsole-logging-settings
      parameters:
      - name: adminconsole_id
        in: path
        description: The identifier for the adminconsole instance
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The updated logging settings for the adminconsole instance
          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/LoggingSettings'
        '404':
          description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsoles.logging_settings.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Adminconsoles
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LoggingSettings'
        description: The new logging settings for the adminconsole instance
        required: true
    delete:
      tags:
      - PlatformInfrastructure
      summary: Delete adminconsole logging settings
      description: Reset the default logging settings for this adminconsole instance.
      operationId: delete-adminconsole-logging-settings
      parameters:
      - name: adminconsole_id
        in: path
        description: The identifier for the adminconsole instance
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The updated logging settings for the adminconsole instance
          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/LoggingSettings'
        '404':
          description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsoles.logging_settings.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Adminconsoles
    patch:
      tags:
      - PlatformInfrastructure
      summary: Update adminconsole logging settings
      description: All changes in the specified object are applied to the logging settings for this adminconsole instance according to the JSON Merge Patch processing rules. Omitting existing fields causes the same values to be reapplied. Specifying a `null` value reverts the field to the default value, or removes the field when no default value exists.
      operationId: update-adminconsole-logging-settings
      parameters:
      - name: adminconsole_id
        in: path
        description: The identifier for the adminconsole instance
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The updated logging settings for the adminconsole instance
          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/LoggingSettings'
        '404':
          description: 'The logging settings for this adminconsole were not found. (code: `adminconsoles.logging_settings.not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - adminconsoles.logging_settings.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '400':
          description: 'The update request is invalid. (code: `patch.request_malformed`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - patch.request_malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Adminconsoles
      requestBody:
        content:
          application/json:
            schema:
              type: string
        description: The logging settings to update
        required: true
  /platform/infrastructure/allocators:
    get:
      tags:
      - PlatformInfrastructure
      summary: Get allocators
      description: Retrieves the information for all of the allocators in the platform.
      operationId: get-allocators
      parameters:
      - name: q
        in: query
        description: (Optional) The query that filters the allocators. Maps to an Elasticsearch `query_string` query.
        required: false
        schema:
          type: string
      - name: size
        in: query
        description: (Optional) The maximum number of search results to return. Defaults to 100.
        required: false
        schema:
          type: integer
          default: 100
      - name: from
        in: query
        description: (Optional) The offset from the first result you want to fetch. Defaults to 0.
        required: false
        schema:
          type: integer
          default: 0
      - name: sort
        in: query
        description: (Optional) A comma-separated array of fields to sort the search results by. Defaults to `allocator_id`.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: An overview of all allocators
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllocatorOverview'
      x-doc:
        tag: Platform - Allocators
  /platform/infrastructure/allocators/_resync:
    post:
      tags:
      - PlatformInfrastructure
      summary: Resynchronize allocators
      description: Asynchronously synchronizes all allocator information in the back-end search index.
      operationId: resync-allocators
      parameters:
      - name: skip_matching_version
        in: query
        description: When true, skips the document indexing when the version matches the in-memory copy.
        required: false
        schema:
          type: boolean
          default: true
      responses:
        '202':
          description: The ids of documents, organized by model version, that will be synchronized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelVersionIndexSynchronizationResults'
      x-doc:
        tag: Platform - Allocators
  /platform/infrastructure/allocators/_search:
    post:
      tags:
      - PlatformInfrastructure
      summary: Search allocators
      description: Retrieves the information for all the allocators in the platform that match a specified query.
      operationId: search-allocators
      responses:
        '200':
          description: An overview of allocators that matched the given search query
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllocatorOverview'
      x-doc:
        tag: Platform - Allocators
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchRequest'
        description: The optional search request to execute. If not supplied then all allocators are matched
  /platform/infrastructure/allocators/{allocator_id}:
    get:
      tags:
      - PlatformInfrastructure
      summary: Get allocator
      description: Retrieves the allocator by the ID.
      operationId: get-allocator
      parameters:
      - name: allocator_id
        in: path
        description: The allocator identifier.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: The information for the allocator specified by {allocator_id}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllocatorInfo'
        '404':
          description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - allocators.allocator_not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Allocators
    delete:
      tags:
      - PlatformInfrastructure
      summary: Delete allocator
      description: Deletes the allocator.
      operationId: delete-allocator
      parameters:
      - name: allocator_id
        in: path
        description: The allocator identifier.
        required: true
        schema:
          type: string
      - name: remove_instances
        in: query
        description: Removes the instances from the deleted allocator.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: The allocator specified by {allocator_id} was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '404':
          description: 'The allocator specified by {allocator_id} cannot be found. (code: `allocators.allocator_not_found`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - allocators.allocator_not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
        '400':
          description: '* The allocator specified by {allocator_id} could not be deleted. (code: `allocators.delete_connected_allocator_attempt`)

            * The allocator specified by {allocator_id} could not be deleted. (code: `allocators.delete_allocator_with_instances_attempt`)'
          headers:
            x-cloud-error-codes:
              description: The error codes associated with the response
              schema:
                type: string
                enum:
                - allocators.delete_connected_allocator_attempt
                - allocators.delete_allocator_with_instances_attempt
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Allocators
  /platform/infrastructure/allocators/{allocator_id}/_resync:
    post:
      tags:
      - PlatformInfrastructure
      summary: Resynchronize allocator
      description: Immediately synchronizes the allocator information in the back-end search index and caches.
      operationId: resync-allocator
    

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