HashiCorp Consul Snapshot API

openapi: 3.1.0
info:
  title: HashiCorp Consul HTTP ACL Snapshot API
  description: The Consul HTTP API provides full access to Consul functionality including service discovery, health checking, key/value storage, ACL management, Connect service mesh, configuration entries, and multi-datacenter operations.
  version: 1.18.0
  contact:
    name: HashiCorp
    url: https://www.consul.io/
  license:
    name: Business Source License 1.1
    url: https://github.com/hashicorp/consul/blob/main/LICENSE
servers:
- url: http://localhost:8500/v1
  description: Local Consul agent
- url: https://{consul_host}:{port}/v1
  description: Custom Consul server
  variables:
    consul_host:
      default: localhost
    port:
      default: '8500'
security:
- ConsulToken: []
tags:
- name: Snapshot
  description: Snapshot and restore operations
paths:
  /snapshot:
    get:
      operationId: getSnapshot
      summary: Generate a snapshot
      description: Generates and returns an atomic, point-in-time snapshot of the Consul state.
      tags:
      - Snapshot
      parameters:
      - $ref: '#/components/parameters/dc'
      responses:
        '200':
          description: Snapshot data
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
    put:
      operationId: restoreSnapshot
      summary: Restore a snapshot
      description: Restores a point-in-time snapshot of the Consul state.
      tags:
      - Snapshot
      parameters:
      - $ref: '#/components/parameters/dc'
      requestBody:
        required: true
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
      responses:
        '200':
          description: Snapshot restored
components:
  parameters:
    dc:
      name: dc
      in: query
      description: Datacenter to query (defaults to agent's datacenter)
      schema:
        type: string
  securitySchemes:
    ConsulToken:
      type: apiKey
      name: X-Consul-Token
      in: header
      description: ACL token for authentication