API Quick Reference
/ |
/_active_tasks |
/_all_dbs |
/_cluster_setup |
/_db_updates |
/_dbs_info |
/_membership |
/_node |
/_nouveau_analyze |
/_replicate |
/_reshard |
/_scheduler |
/_search_analyze |
/_session |
/_up |
/_utils |
/_uuids |
/favicon.ico |
/{db}
/ | ||
GET / | Returns the welcome message and version information | |
/_active_tasks | ||
GET /_active_tasks | Obtains a list of the tasks running in the server | |
/_all_dbs | ||
GET /_all_dbs | Returns a list of all the databases | |
/_cluster_setup | ||
GET /_cluster_setup | Return the status of the cluster setup wizard | |
POST /_cluster_setup | Sets up a node as a single node or as part of a cluster. | |
/_db_updates | ||
GET /_db_updates | Return the server changes of databases | |
/_dbs_info | ||
GET /_dbs_info | Returns all databases information | |
POST /_dbs_info | Returns information of a list of the specified databases | |
/_membership | ||
GET /_membership | Returns a list of nodes | |
/_node | ||
GET /_node/{node-name} | Returns node name | |
GET /_node/{node-name}/_config | Obtains a list of the entire server configuration | |
GET /_node/{node-name}/_config/{section} | Returns all the configuration values for the specified section | |
GET /_node/{node-name}/_config/{section}/{key} | Returns a specific section/configuration value | |
GET /_node/{node-name}/_prometheus | Returns server statistics in prometheus format | |
GET /_node/{node-name}/_smoosh/status | Returns metrics of the CouchDB's auto-compaction daemon | |
GET /_node/{node-name}/_stats | Returns server statistics | |
GET /_node/{node-name}/_system | Returns system-level server statistics | |
GET /_node/{node-name}/_versions | Returns system-level server version informations | |
POST /_node/{node-name}/_config/_reload | Reload the configuration from disk | |
POST /_node/{node-name}/_restart | Restarts CouchDB application on a given node | |
PUT /_node/{node-name}/_config/{section}/{key} | Sets the specified configuration value | |
DELETE /_node/{node-name}/_config/{section}/{key} | Removes the current setting | |
/_nouveau_analyze | ||
POST /_nouveau_analyze | Tests the results of analyzer tokenization | |
/_replicate | ||
POST /_replicate | Starts or cancels the replication | |
/_reshard | ||
GET /_reshard | Retrieve summary information about resharding on the cluster | |
GET /_reshard/jobs | Retrieve information about all the resharding jobs on the cluster | |
GET /_reshard/jobs/{jobid} | Retrieve information about a particular resharding job | |
GET /_reshard/jobs/{jobid}/state | Retrieve the state of a single resharding job | |
GET /_reshard/state | Retrieve the state of resharding on the cluster | |
POST /_reshard/jobs | Create one or more resharding jobs | |
PUT /_reshard/jobs/{jobid}/state | Change the state of a resharding job | |
PUT /_reshard/state | Change resharding state on the cluster | |
DELETE /_reshard/jobs/{jobid} | Remove a resharding job | |
/_scheduler | ||
GET /_scheduler/docs | Retrieve information about replication documents from the ``_replicator`` database. | |
GET /_scheduler/docs/{replicator_db} | Retrieve information about replication documents from a specific replicator database. | |
GET /_scheduler/docs/{replicator_db}/{docid} | Retrieve information about a particular replication document | |
GET /_scheduler/jobs | Retrieve information about replication jobs | |
/_search_analyze | ||
POST /_search_analyze | Tests the results of analyzer tokenization | |
/_session | ||
GET /_session | Returns Cookie-based login user information | |
POST /_session | Authenticates user by Cookie-based user login | |
DELETE /_session | Logout Cookie-based user | |
/_up | ||
GET /_up | Health check endpoint | |
/_utils | ||
GET /_utils | Redirects to /_utils/ | |
GET /_utils/ | CouchDB administration interface (Fauxton) | |
/_uuids | ||
GET /_uuids | Generates a list of UUIDs from the server | |
/favicon.ico | ||
GET /favicon.ico | Returns the site icon | |
/{db} | ||
HEAD /{db} | Checks the database existence | |
HEAD /{db}/_design/{ddoc} | Returns bare information in the HTTP Headers for the design document | |
HEAD /{db}/_design/{ddoc}/{attname} | Returns bare information in the HTTP Headers for the attachment | |
HEAD /{db}/{docid} | Returns bare information in the HTTP Headers for the document | |
HEAD /{db}/{docid}/{attname} | Returns bare information in the HTTP Headers for the attachment | |
GET /{db} | Returns the database information | |
GET /{db}/_all_docs | Returns a built-in view of all documents in this database | |
GET /{db}/_changes | Returns changes for the given database | |
GET /{db}/_design/{ddoc} | Returns the design document | |
GET /{db}/_design/{ddoc}/_info | Returns view index information for the specified design document | |
GET /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} | Executes a list function against the view from other design document | |
GET /{db}/_design/{ddoc}/_list/{func}/{view} | Executes a list function against the view from the same design document | |
GET /{db}/_design/{ddoc}/_nouveau/{index} | Returns results for the specified nouveau index | |
GET /{db}/_design/{ddoc}/_nouveau_info/{index} | Returns metadata for the specified nouveau index | |
GET /{db}/_design/{ddoc}/_search/{index} | Returns results for the specified search index | |
GET /{db}/_design/{ddoc}/_search_info/{index} | Returns metadata for the specified search index | |
GET /{db}/_design/{ddoc}/_show/{func} | Executes a show function against null document | |
GET /{db}/_design/{ddoc}/_show/{func}/{docid} | Executes a show function against the specified document | |
GET /{db}/_design/{ddoc}/_view/{view} | Returns results for the specified stored view | |
GET /{db}/_design/{ddoc}/{attname} | Gets the attachment of a design document | |
GET /{db}/_design_docs | Returns a built-in view of all design documents in this database | |
GET /{db}/_index | List all indexes. | |
GET /{db}/_local/{docid} | Returns the latest revision of the local document | |
GET /{db}/_local_docs | Returns a built-in view of all local (non-replicating) documents in this database | |
GET /{db}/_partition/{partition_id} | Returns document and size info for the given partition | |
GET /{db}/_partition/{partition_id}/_all_docs | Return all docs in the specified partition | |
GET /{db}/_partition/{partition_id}/_design/{ddoc}/_view/{view} | Execute a partitioned query | |
GET /{db}/_purged_infos | Returns a history list of purged document IDs and revisions | |
GET /{db}/_purged_infos_limit | Returns the limit of historical purges to store in the database | |
GET /{db}/_revs_limit | Returns the limit of historical revisions to store for a single document in the database | |
GET /{db}/_security | Returns the special security object for the database | |
GET /{db}/_shards | Displays the shard map layout of a database | |
GET /{db}/_shards/{docid} | Returns the specific shard in which a document is stored | |
GET /{db}/{docid} | Returns the document | |
GET /{db}/{docid}/{attname} | Gets the attachment of a document | |
POST /{db} | Creates a new document with generated ID if _id is not specified | |
POST /{db}/_all_docs | Returns a built-in view of all documents in this database | |
POST /{db}/_all_docs/queries | Returns results for the specified queries | |
POST /{db}/_bulk_docs | Inserts or updates multiple documents in to the database in a single request | |
POST /{db}/_bulk_get | Fetches several documents at the given revisions | |
POST /{db}/_changes | Returns changes for the given database for certain document IDs or selector filter. | |
POST /{db}/_compact | Starts a compaction for the database | |
POST /{db}/_compact/{ddoc} | Starts a compaction for all the views in the selected design document | |
POST /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} | Same as GET method for the related endpoint | |
POST /{db}/_design/{ddoc}/_list/{func}/{view} | Same as GET method for the related endpoint | |
POST /{db}/_design/{ddoc}/_show/{func} | Same as GET method for the related endpoint | |
POST /{db}/_design/{ddoc}/_show/{func}/{docid} | Same as GET method for the related endpoint | |
POST /{db}/_design/{ddoc}/_update/{func} | Executes an update function against the null document | |
POST /{db}/_design/{ddoc}/_view/{view} | Returns results for the specified view | |
POST /{db}/_design/{ddoc}/_view/{view}/queries | Returns results for the specified queries | |
POST /{db}/_design_docs | Returns a built-in view of all design documents in this database | |
POST /{db}/_design_docs/queries | Returns results for the specified queries | |
POST /{db}/_ensure_full_commit | Deprecated endpoint to support CouchDB versions < 3.0 replicators. | |
POST /{db}/_explain | Identify which index is being used by a particular query. | |
POST /{db}/_find | Find documents within a given database. | |
POST /{db}/_index | Create a new index. | |
POST /{db}/_index/_bulk_delete | Delete indexes in bulk. | |
POST /{db}/_local_docs | Returns a built-in view of all local (non-replicating) documents in this database | |
POST /{db}/_local_docs/queries | Returns results for the specified queries | |
POST /{db}/_missing_revs | By given list of document revisions returns the document revisions that do not exist in the database | |
POST /{db}/_partition/{partition_id}/_explain | Find index that is used with a query | |
POST /{db}/_partition/{partition_id}/_find | Query the partition specified by ``partition_id`` | |
POST /{db}/_purge | Purges documents entirely from database | |
POST /{db}/_revs_diff | By given list of document revisions returns differences between the given revisions and ones that are in the database | |
POST /{db}/_sync_shards | Trigger a synchronization of all shard replicas in the database | |
POST /{db}/_view_cleanup | Removes view files that are not used by any design document | |
PUT /{db} | Creates a new database | |
PUT /{db}/_design/{ddoc} | Creates a new design document or new version of an existing one | |
PUT /{db}/_design/{ddoc}/_update/{func}/{docid} | Executes an update function against the specified document | |
PUT /{db}/_design/{ddoc}/{attname} | Adds an attachment of a design document | |
PUT /{db}/_local/{docid} | Inserts a new version of the local document | |
PUT /{db}/_purged_infos_limit | Sets the limit of historical purges to store in the database | |
PUT /{db}/_revs_limit | Sets the limit of historical revisions to store for a single document in the database | |
PUT /{db}/_security | Sets the special security object for the database | |
PUT /{db}/{docid} | Creates a new document or new version of an existing document | |
PUT /{db}/{docid}/{attname} | Adds an attachment of a document | |
DELETE /{db} | Deletes an existing database | |
DELETE /{db}/_design/{ddoc} | Deletes the design document | |
DELETE /{db}/_design/{ddoc}/{attname} | Deletes an attachment of a design document | |
DELETE /{db}/_index/{design_doc}/json/{name} | Delete an index. | |
DELETE /{db}/_local/{docid} | Deletes the local document | |
DELETE /{db}/{docid} | Deletes the document | |
DELETE /{db}/{docid}/{attname} | Deletes an attachment of a document | |
COPY /{db}/_design/{ddoc} | Copies the design document | |
COPY /{db}/_local/{docid} | Copies the local document within the same database | |
COPY /{db}/{docid} | Copies the document within the same database | |
ANY /{db}/_design/{ddoc}/_rewrite/{path} | Rewrites HTTP request for the specified path by using stored array of routing rules or JavaScript function |