1. API Reference — Apache CouchDB® 3.4 Documentation

# 1. API Reference

The components of the API URL path help determine the part of the CouchDB server that is being accessed. The result is the structure of the URL request both identifies and effectively describes the area of the database you are accessing.

As with all URLs, the individual components are separated by a forward slash.

As a general rule, URL components and JSON fields starting with the `_` (underscore) character represent a special component or entity within the server or returned object. For example, the URL fragment `/_all_dbs` gets a list of all of the databases in a CouchDB instance.

This reference is structured according to the URL structure, as below.

- 1.1. API Basics
  - 1.1.1. Request Format and Responses
  - 1.1.2. HTTP Headers
  - 1.1.3. JSON Basics
  - 1.1.4. HTTP Status Codes
- 1.2. Server
  - 1.2.1. `/`
  - 1.2.2. `/_active_tasks`
  - 1.2.3. `/_all_dbs`
  - 1.2.4. `/_dbs_info`
  - 1.2.5. `/_cluster_setup`
  - 1.2.6. `/_db_updates`
  - 1.2.7. `/_membership`
  - 1.2.8. `/_replicate`
  - 1.2.9. `/_scheduler/jobs`
  - 1.2.10. `/_scheduler/docs`
  - 1.2.11. `/_node/{node-name}`
  - 1.2.12. `/_node/{node-name}/_stats`
  - 1.2.13. `/_node/{node-name}/_prometheus`
  - 1.2.14. `/_node/{node-name}/_smoosh/status`
  - 1.2.15. `/_node/{node-name}/_system`
  - 1.2.16. `/_node/{node-name}/_restart`
  - 1.2.17. `/_node/{node-name}/_versions`
  - 1.2.18. `/_search_analyze`
  - 1.2.19. `/_nouveau_analyze`
  - 1.2.20. `/_utils`
  - 1.2.21. `/_up`
  - 1.2.22. `/_uuids`
  - 1.2.23. `/favicon.ico`
  - 1.2.24. `/_reshard`
  - 1.2.25. Authentication
  - 1.2.26. Configuration
- 1.3. Databases
  - 1.3.1. `/{db}`
  - 1.3.2. `/{db}/_all_docs`
  - 1.3.3. `/{db}/_design_docs`
  - 1.3.4. `/{db}/_bulk_get`
  - 1.3.5. `/{db}/_bulk_docs`
  - 1.3.6. `/{db}/_find`
  - 1.3.7. `/{db}/_index`
  - 1.3.8. `/{db}/_explain`
  - 1.3.9. `/{db}/_shards`
  - 1.3.10. `/{db}/_shards/{docid}`
  - 1.3.11. `/{db}/_sync_shards`
  - 1.3.12. `/{db}/_changes`
  - 1.3.13. `/{db}/_compact`
  - 1.3.14. `/{db}/_compact/{ddoc}`
  - 1.3.15. `/{db}/_ensure_full_commit`
  - 1.3.16. `/{db}/_view_cleanup`
  - 1.3.17. `/{db}/_security`
  - 1.3.18. `/{db}/_purge`
  - 1.3.19. `/{db}/_purged_infos`
  - 1.3.20. `/{db}/_purged_infos_limit`
  - 1.3.21. `/{db}/_missing_revs`
  - 1.3.22. `/{db}/_revs_diff`
  - 1.3.23. `/{db}/_revs_limit`
- 1.4. Documents
  - 1.4.1. `/{db}/{docid}`
  - 1.4.2. `/{db}/{docid}/{attname}`
- 1.5. Design Documents
  - 1.5.1. `/{db}/_design/{ddoc}`
  - 1.5.2. `/{db}/_design/{ddoc}/{attname}`
  - 1.5.3. `/{db}/_design/{ddoc}/_info`
  - 1.5.4. `/{db}/_design/{ddoc}/_view/{view}`
  - 1.5.5. `/{db}/_design/{ddoc}/_search/{index}`
  - 1.5.6. `/{db}/_design/{ddoc}/_search_info/{index}`
  - 1.5.7. `/{db}/_design/{ddoc}/_nouveau/{index}`
  - 1.5.8. `/{db}/_design/{ddoc}/_nouveau_info/{index}`
  - 1.5.9. `/{db}/_design/{ddoc}/_show/{func}`
  - 1.5.10. `/{db}/_design/{ddoc}/_show/{func}/{docid}`
  - 1.5.11. `/{db}/_design/{ddoc}/_list/{func}/{view}`
  - 1.5.12. `/{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}`
  - 1.5.13. `/{db}/_design/{ddoc}/_update/{func}`
  - 1.5.14. `/{db}/_design/{ddoc}/_update/{func}/{docid}`
  - 1.5.15. `/{db}/_design/{ddoc}/_rewrite/{path}`
- 1.6. Partitioned Databases
  - 1.6.1. `/{db}/_partition/{partition_id}`
  - 1.6.2. `/{db}/_partition/{partition_id}/_all_docs`
  - 1.6.3. `/{db}/_partition/{partition_id}/_design/{ddoc}/_view/{view}`
  - 1.6.4. `/{db}/_partition/{partition_id}/_find`
  - 1.6.5. `/{db}/_partition/{partition_id}/_explain`
- 1.7. Local (non-replicating) Documents
  - 1.7.1. `/{db}/_local_docs`
  - 1.7.2. `/{db}/_local_docs/queries`
  - 1.7.3. `/{db}/_local/{docid}`