Elastic Stack

Elastic Stack (ELK Stack) Platform Configuration Snapshots API

The PlatformConfigurationSnapshots API from Elastic Stack (ELK Stack) — 2 operation(s) for platformconfigurationsnapshots.

Documentation GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /platform/configuration/snapshots/repositories List snapshot repository configurations · Get snapshot repositories #

Ask an LLM

“Which snapshot repositories are configured for the platform?”

“Can I see all the snapshot repository configurations available to deployments?”

Tell an agent

List all platform snapshot repositories.

Show every snapshot repository configuration.

GET /platform/configuration/snapshots/repositories/{repository_name} Get a snapshot repository configuration · Get snapshot repository #

Ask an LLM

“What type and settings does a particular snapshot repository have?”

“Do I need privileged permissions to see a snapshot repository's configuration contents?”

Tell an agent

Show the snapshot repository {repository_name}.

Get the configuration of snapshot repository {repository_name}.

PUT /platform/configuration/snapshots/repositories/{repository_name} Create or update a snapshot repository · Set snapshot repository #

Ask an LLM

“How do I add an S3 snapshot repository to the platform?”

“Can I update an existing snapshot repository's settings safely using its version?”

Tell an agent

Create snapshot repository {repository_name} of type {type} with settings {settings}.

Update snapshot repository {repository_name} at version {version} with settings {settings}.

DELETE /platform/configuration/snapshots/repositories/{repository_name} Delete a snapshot repository configuration · Delete snapshot repository #

Ask an LLM

“How do I remove a snapshot repository from the platform?”

“Can I also clean up the deployments that use a snapshot repository when deleting it?”

Tell an agent destructive · confirm first

Delete snapshot repository {repository_name}.

Delete snapshot repository {repository_name} and clean up deployments using it ({cleanup_deployments}).

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/elk-stack:elk-stack-platformconfigurationsnapshots-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: '1'
  title: Elastic Cloud Enterprise Platform Configuration Snapshots…
  termsOfService: ''
servers:
- url: https://{{hostname}}/api/v1
security:
- basicAuth: []
- apiKey: []
tags:
- name: PlatformConfigurationSnapshots
paths:
  /platform/configuration/snapshots/repositories:
    get:
      tags:
      - PlatformConfigurationSnapshots
      summary: Get snapshot repositories
      description: Retrieves a list of available snapshot repository configurations. To access the configuration contents, you must have privileged permissions.
      operationId: get-snapshot-repositories
      responses:
        '200':
          description: List of snapshot repository configs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryConfigs'
      x-doc:
        tag: Platform - Repository - CRUD
  /platform/configuration/snapshots/repositories/{repository_name}:
    get:
      tags:
      - PlatformConfigurationSnapshots
      summary: Get snapshot repository
      description: Retrieves the snapshot repository configuration. To access the configuration contents, you must have privileged permissions.
      operationId: get-snapshot-repository
      parameters:
      - name: repository_name
        in: path
        description: The name of the snapshot repository configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Retrieve snapshot repository config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryConfig'
      x-doc:
        tag: Platform - Repository - CRUD
    put:
      tags:
      - PlatformConfigurationSnapshots
      summary: Set snapshot repository
      description: Creates or updates the snapshot repository configuration.
      operationId: set-snapshot-repository
      parameters:
      - name: version
        in: query
        description: Checks for conflicts against the metadata version, then returns the value in the `x-cloud-resource-version` header.
        required: false
        schema:
          type: integer
      - name: repository_name
        in: path
        description: The name of the snapshot repository configuration.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: New snapshot repository config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RepositoryConfig'
      x-doc:
        tag: Platform - Repository - CRUD
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SnapshotRepositoryConfiguration'
        description: The Elasticsearch snapshot repository configuration
        required: true
    delete:
      tags:
      - PlatformConfigurationSnapshots
      summary: Delete snapshot repository
      description: Deletes the snapshot repository configuration.
      operationId: delete-snapshot-repository
      parameters:
      - name: repository_name
        in: path
        description: The name of the snapshot repository configuration.
        required: true
        schema:
          type: string
      - name: cleanup_deployments
        in: query
        description: Removes references to this snapshot repository configuration and disables snapshots on the clusters that were referencing this configuration. If a request is made to delete a repository configuration that has already been deleted and this parameter is set to true and clusters still reference the configuration, then the request will have the side effects of removing references and disabling snapshots for clusters that reference the previously deleted configuration.
        required: false
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Delete snapshot repository config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '500':
          description: Failed to delete references and disable snapshots in one or more referencing clusters.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BasicFailedReply'
      x-doc:
        tag: Platform - Repository - CRUD
components:
  schemas:
    BasicFailedReplyElement:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: A structured code representing the error type that occurred
        message:
          type: string
          description: A human readable message describing the error that occurred
        fields:
          type: array
          description: If the error can be tied to a specific field or fields in the user request, this lists those fields
          items:
            type: string
    SnapshotRepositoryConfiguration:
      type: object
      required:
      - settings
      - type
      properties:
        type:
          type: string
          description: 'Repository type, (Currently supported: ''s3'')'
        settings:
          type: object
          description: Elasticsearch repository configuration settings JSON. See [Elasticsearch documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html) for more information
          properties: {}
      description: The configuration for an Elasticsearch snapshot repository.
    RepositoryConfig:
      type: object
      required:
      - config
      - repository_name
      properties:
        repository_name:
          type: string
          description: Elasticsearch snapshot repository name
        config:
          type: object
          description: Elasticsearch configuration JSON for a snapshot repository
          properties: {}
      description: The snapshot repository configuration.
    BasicFailedReply:
      type: object
      required:
      - errors
      properties:
        errors:
          type: array
          description: A list of errors that occurred in the failing request
          items:
            $ref: '#/components/schemas/BasicFailedReplyElement'
    EmptyResponse:
      type: object
    RepositoryConfigs:
      type: object
      required:
      - configs
      properties:
        configs:
          type: array
          description: List of snapshot configurations
          items:
            $ref: '#/components/schemas/RepositoryConfig'
      description: A list of snapshot repository configurations.
  securitySchemes:
    apiKey:
      type: apiKey
      name: Authorization
      in: header
    basicAuth:
      type: http
      scheme: basic
x-elastic:
  curl:
    auth: '-H "Authorization: ApiKey $ECE_API_KEY"'

Elastic Stack (ELK Stack) Platform Configuration Snapshots API

Operations 4

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification