# Copyright 2022-Present Couchbase, Inc.
#
# Use of this software is governed by the Business Source License included
# in the file licenses/BSL-Couchbase.txt.  As of the Change Date specified
# in that file, in accordance with the Business Source License, use of this
# software will be governed by the Apache License, Version 2.0, included in
# the file licenses/APL2.txt.

openapi: 3.0.3
info:
  title: Sync Gateway Admin REST API
  description: |-
    # Introduction

    The Sync Gateway Admin REST API is used to administer user accounts and roles, and to run administrative tasks in superuser mode.
  version: '4.2'
  license:
    name: Business Source License 1.1 (BSL)
    url: 'https://github.com/couchbase/sync_gateway/blob/master/LICENSE'
servers:
  - url: '{protocol}://{hostname}:4985'
    description: Admin API
    variables:
      protocol:
        description: The protocol to use (HTTP or HTTPS)
        default: http
        enum:
          - http
          - https
      hostname:
        description: The hostname to use
        default: localhost
paths:
  '/{db}/_session':
    $ref: './paths/admin/db-_session.yaml'
  '/{db}/_session/{sessionid}':
    $ref: './paths/admin/db-_session-sessionid.yaml'
  '/{keyspace}/_raw/{docid}':
    $ref: './paths/admin/keyspace-_raw-docid.yaml'
  '/{keyspace}/_revtree/{docid}':
    $ref: './paths/admin/keyspace-_revtree-docid.yaml'
  '/{db}/':
    $ref: './paths/admin/db-.yaml'
  /_all_dbs:
    $ref: ./paths/admin/_all_dbs.yaml
  '/{db}/_user/':
    $ref: './paths/admin/db-_user-.yaml'
  '/{db}/_user/{name}':
    $ref: './paths/admin/db-_user-name.yaml'
  '/{db}/_user/{name}/_session':
    $ref: './paths/admin/db-_user-name-_session.yaml'
  '/{db}/_user/{name}/_session/{sessionid}':
    $ref: './paths/admin/db-_user-name-_session-sessionid.yaml'
  '/{db}/_user/{name}/_access_history':
    $ref: './paths/admin/db-_user-name-_access_history.yaml'
  '/{db}/_user/{name}/_access_history/compact':
    $ref: './paths/admin/db-_user-name-_access_history-compact.yaml'
  '/{db}/_role/':
    $ref: './paths/admin/db-_role-.yaml'
  '/{db}/_role/{name}':
    $ref: './paths/admin/db-_role-name.yaml'
  '/{db}/_replication/':
    $ref: './paths/admin/db-_replication-.yaml'
  '/{db}/_replication/{replicationid}':
    $ref: './paths/admin/db-_replication-replicationid.yaml'
  '/{db}/_replicationStatus/':
    $ref: './paths/admin/db-_replicationStatus-.yaml'
  '/{db}/_replicationStatus/{replicationid}':
    $ref: './paths/admin/db-_replicationStatus-replicationid.yaml'
  '/_profile/{profilename}':
    $ref: './paths/admin/_profile-profilename.yaml'
  /_profile:
    $ref: ./paths/admin/_profile.yaml
  /_heap:
    $ref: ./paths/admin/_heap.yaml
  /_stats:
    $ref: ./paths/admin/_stats.yaml
  /_config:
    $ref: ./paths/admin/_config.yaml
  /_cluster_info:
    $ref: ./paths/admin/_cluster_info.yaml
  /_cluster_compat_version:
    $ref: ./paths/admin/_cluster_compat_version.yaml
  /_cluster_compat_version/freeze:
    $ref: ./paths/admin/_cluster_compat_version-freeze.yaml
  /_cluster_compat_version/unfreeze:
    $ref: ./paths/admin/_cluster_compat_version-unfreeze.yaml
  /_status:
    $ref: ./paths/admin/_status.yaml
  /_sgcollect_info:
    $ref: ./paths/admin/_sgcollect_info.yaml
  /_debug/pprof/goroutine:
    $ref: ./paths/admin/_debug-pprof-goroutine.yaml
  /_debug/pprof/cmdline:
    $ref: ./paths/admin/_debug-pprof-cmdline.yaml
  /_debug/pprof/symbol:
    $ref: ./paths/admin/_debug-pprof-symbol.yaml
  /_debug/pprof/heap:
    $ref: ./paths/admin/_debug-pprof-heap.yaml
  /_debug/pprof/profile:
    $ref: ./paths/admin/_debug-pprof-profile.yaml
  /_debug/pprof/block:
    $ref: ./paths/admin/_debug-pprof-block.yaml
  /_debug/pprof/threadcreate:
    $ref: ./paths/admin/_debug-pprof-threadcreate.yaml
  /_debug/pprof/mutex:
    $ref: ./paths/admin/_debug-pprof-mutex.yaml
  /_debug/pprof/trace:
    $ref: ./paths/admin/_debug-pprof-trace.yaml
  /_debug/fgprof:
    $ref: ./paths/admin/_debug-fgprof.yaml
  /_post_upgrade:
    $ref: ./paths/admin/_post_upgrade.yaml
  '/{db}/_config':
    $ref: './paths/admin/db-_config.yaml'
  '/{db}/_config/audit':
    $ref: './paths/admin/db-_config-audit.yaml'
  '/{keyspace}/_config/sync':
    $ref: './paths/admin/keyspace-_config-sync.yaml'
  '/{keyspace}/_config/import_filter':
    $ref: './paths/admin/keyspace-_config-import_filter.yaml'
  '/{db}/_resync':
    $ref: './paths/admin/db-_resync.yaml'
  '/{db}/_index_init':
    $ref: './paths/admin/db-_index_init.yaml'
  '/{keyspace}/_purge':
    $ref: './paths/admin/keyspace-_purge.yaml'
  '/{keyspace}/_channel_history/{docid}':
    $ref: './paths/admin/keyspace-_channel_history.yaml'
  '/{keyspace}/_channel_history/{docid}/compact':
    $ref: './paths/admin/keyspace-_channel_history-compact.yaml'
  '/{db}/_flush':
    $ref: './paths/admin/db-_flush.yaml'
  '/{db}/_online':
    $ref: './paths/admin/db-_online.yaml'
  '/{db}/_offline':
    $ref: './paths/admin/db-_offline.yaml'
  '/{db}/_dump/{view}':
    $ref: './paths/admin/db-_dump-view.yaml'
  '/{db}/_view/{view}':
    $ref: './paths/admin/db-_view-view.yaml'
  '/{keyspace}/_dumpchannel/{channel}':
    $ref: './paths/admin/keyspace-_dumpchannel-channel.yaml'
  '/{db}/_repair':
    $ref: './paths/admin/db-_repair.yaml'
  '/{db}/_compact':
    $ref: './paths/admin/db-_compact.yaml'
  '/{db}/_attachment_migration':
    $ref: './paths/admin/db-_attachment_migration.yaml'
  '/{db}/_metadata_migration':
    $ref: './paths/admin/db-_metadata_migration.yaml'
  '/{keyspace}/':
    $ref: './paths/admin/keyspace-.yaml'
  /_expvar:
    $ref: ./paths/admin/_expvar.yaml
  /:
    $ref: ./paths/admin/-.yaml
  /_ping:
    $ref: ./paths/common/_ping.yaml
  '/{keyspace}/_changes':
    $ref: './paths/admin/keyspace-_changes.yaml'
  '/{db}/_design/{ddoc}':
    $ref: './paths/admin/db-_design-ddoc.yaml'
  '/{db}/_design/{ddoc}/_view/{view}':
    $ref: './paths/admin/db-_design-ddoc-_view-view.yaml'
  '/{keyspace}/_revs_diff':
    $ref: './paths/admin/keyspace-_revs_diff.yaml'
  '/{keyspace}/_local/{docid}':
    $ref: './paths/admin/keyspace-_local-docid.yaml'
  '/{keyspace}/{docid}':
    $ref: './paths/admin/keyspace-docid.yaml'
  '/{keyspace}/{docid}/{attach}':
    $ref: './paths/admin/keyspace-docid-attach.yaml'
  '/{keyspace}/_all_docs':
    $ref: './paths/admin/keyspace-_all_docs.yaml'
  '/{keyspace}/_bulk_docs':
    $ref: './paths/admin/keyspace-_bulk_docs.yaml'
  '/{keyspace}/_bulk_get':
    $ref: './paths/admin/keyspace-_bulk_get.yaml'
  '/{db}/_oidc':
    $ref: './paths/admin/db-_oidc.yaml'
  '/{db}/_oidc_challenge':
    $ref: './paths/admin/db-_oidc_challenge.yaml'
  '/{db}/_oidc_callback':
    $ref: './paths/admin/db-_oidc_callback.yaml'
  '/{db}/_oidc_refresh':
    $ref: './paths/admin/db-_oidc_refresh.yaml'
  '/{db}/_oidc_testing/.well-known/openid-configuration':
    $ref: './paths/common/db-_oidc_testing-.well-known-openid-configuration.yaml'
  '/{db}/_oidc_testing/authorize':
    $ref: './paths/common/db-_oidc_testing-authorize.yaml'
  '/{db}/_oidc_testing/token':
    $ref: './paths/common/db-_oidc_testing-token.yaml'
  '/{db}/_oidc_testing/certs':
    $ref: './paths/common/db-_oidc_testing-certs.yaml'
  '/{db}/_oidc_testing/authenticate':
    $ref: './paths/common/db-_oidc_testing-authenticate.yaml'
  '/{db}/_blipsync':
    $ref: './paths/admin/db-_blipsync.yaml'
  # deprecated endpoints, put at the end to show up at the bottom
  '/{db}/_facebook':
    $ref: './paths/admin/db-_facebook.yaml'
  '/{db}/_google':
    $ref: './paths/admin/db-_google.yaml'
  '/{db}/_ensure_full_commit':
    $ref: './paths/common/db-_ensure_full_commit.yaml'
  /_logging:
    $ref: ./paths/admin/_logging.yaml
  /_rosmar/:
    x-internal: true
    $ref: ./paths/admin/_rosmar.yaml
  '/_rosmar/{bucketkeyspace}':
    x-internal: true
    $ref: './paths/admin/_rosmar-bucketkeyspace.yaml'
tags:
  - name: Authentication
    description: Manage authentication
  - name: Server
    description: Manage server activities
  - name: Database Management
    description: Create and manage Sync Gateway databases
  - name: Database Configuration
    description: Configure Sync Gateway databases
  - name: Database Security
    description: Create and manage database users and roles
  - name: Session
    description: Manage user sessions
  - name: Document
    description: Create and manage documents and attachments
  - name: Replication
    description: Create and manage inter-Sync Gateway replications
  - name: Metrics
    description: Get Sync Gateway statistics
  - name: Profiling
    description: Generate information to help debug and fine-tune Sync Gateway
  - name: Unsupported
    description: Endpoints that are not supported by Sync Gateway
externalDocs:
  description: ⬆️ Admin REST API Overview
  url: rest-api-admin.html