API Quick Reference

/ | /_active_tasks | /_all_dbs | /_cluster_setup | /_db_updates | /_dbs_info | /_membership | /_node/{node-name}/_config | /_node/{node-name}/_config/{section} | /_node/{node-name}/_config/{section}/{key} | /_node/{node-name}/_restart | /_node/{node-name}/_stats | /_node/{node-name}/_system | /_replicate | /_reshard | /_reshard/jobs | /_reshard/jobs/{jobid} | /_reshard/jobs/{jobid}/state | /_reshard/state | /_scheduler/docs | /_scheduler/docs/{replicator_db} | /_scheduler/docs/{replicator_db}/{docid} | /_scheduler/jobs | /_search_analyze | /_session | /_up | /_utils | /_utils/ | /_uuids | /favicon.ico | /{db} | /{db}/_all_docs | /{db}/_all_docs/queries | /{db}/_bulk_docs | /{db}/_bulk_get | /{db}/_changes | /{db}/_compact | /{db}/_compact/{ddoc} | /{db}/_design/{ddoc} | /{db}/_design/{ddoc}/_info | /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} | /{db}/_design/{ddoc}/_list/{func}/{view} | /{db}/_design/{ddoc}/_rewrite/{path} | /{db}/_design/{ddoc}/_search/{index} | /{db}/_design/{ddoc}/_search_info/{index} | /{db}/_design/{ddoc}/_show/{func} | /{db}/_design/{ddoc}/_show/{func}/{docid} | /{db}/_design/{ddoc}/_update/{func} | /{db}/_design/{ddoc}/_update/{func}/{docid} | /{db}/_design/{ddoc}/_view/{view} | /{db}/_design/{ddoc}/_view/{view}/queries | /{db}/_design/{ddoc}/{attname} | /{db}/_design_docs | /{db}/_ensure_full_commit | /{db}/_explain | /{db}/_find | /{db}/_index | /{db}/_index/{designdoc}/json/{name} | /{db}/_local/{docid} | /{db}/_local_docs | /{db}/_missing_revs | /{db}/_partition/{partition} | /{db}/_partition/{partition}/_all_docs | /{db}/_partition/{partition}/_design/{ddoc}/_view/{view} | /{db}/_purge | /{db}/_purged_infos_limit | /{db}/_revs_diff | /{db}/_revs_limit | /{db}/_security | /{db}/_shards | /{db}/_shards/{docid} | /{db}/_sync_shards | /{db}/_view_cleanup | /{db}/{docid} | /{db}/{docid}/{attname}
 
/
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
POST /_dbs_info Returns information of a list of the specified databases
 
/_membership
GET /_membership Returns a list of nodes
 
/_node/{node-name}/_config
GET /_node/{node-name}/_config Obtains a list of the entire server configuration
 
/_node/{node-name}/_config/{section}
GET /_node/{node-name}/_config/{section} Returns all the configuration values for the specified section
 
/_node/{node-name}/_config/{section}/{key}
GET /_node/{node-name}/_config/{section}/{key} Returns a specific section/configuration value
PUT /_node/{node-name}/_config/{section}/{key} Sets the specified configuration value
DELETE /_node/{node-name}/_config/{section}/{key} Removes the current setting
 
/_node/{node-name}/_restart
POST /_node/{node-name}/_restart Restarts CouchDB application on a given node
 
/_node/{node-name}/_stats
GET /_node/{node-name}/_stats Returns server statistics
 
/_node/{node-name}/_system
GET /_node/{node-name}/_system Returns system-level server statistics
 
/_replicate
POST /_replicate Starts or cancels the replication
 
/_reshard
GET /_reshard Retrieve summary information about resharding on the cluster
 
/_reshard/jobs
GET /_reshard/jobs Retrieve information about all the resharding jobs on the cluster
 
/_reshard/jobs/{jobid}
GET /_reshard/jobs/{jobid} Retrieve information about a particular resharding job
POST /_reshard/jobs/{jobid} Create one or more resharding jobs
DELETE /_reshard/jobs/{jobid} Remove a resharding job
 
/_reshard/jobs/{jobid}/state
GET /_reshard/jobs/{jobid}/state Retrieve the state of a single resharding job
PUT /_reshard/jobs/{jobid}/state Change the state of a resharding job
 
/_reshard/state
GET /_reshard/state Retrieve the state of resharding on the cluster
PUT /_reshard/state Change resharding state on the cluster
 
/_scheduler/docs
GET /_scheduler/docs Retrieve information about replication documents from the ``_replicator`` database.
 
/_scheduler/docs/{replicator_db}
GET /_scheduler/docs/{replicator_db} Retrieve information about replication documents from a specific replicator database.
 
/_scheduler/docs/{replicator_db}/{docid}
GET /_scheduler/docs/{replicator_db}/{docid} Retrieve information about a particular replication document
 
/_scheduler/jobs
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/
 
/_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
GET /{db} Returns the database information
POST /{db} Creates a new document with generated ID if _id is not specified
PUT /{db} Creates a new database
DELETE /{db} Deletes an existing database
 
/{db}/_all_docs
GET /{db}/_all_docs Returns a built-in view of all documents in this database
POST /{db}/_all_docs Returns a built-in view of all documents in this database
 
/{db}/_all_docs/queries
POST /{db}/_all_docs/queries Returns results for the specified queries
 
/{db}/_bulk_docs
POST /{db}/_bulk_docs Inserts or updates multiple documents in to the database in a single request
 
/{db}/_bulk_get
POST /{db}/_bulk_get Fetches several documents at the given revisions
 
/{db}/_changes
GET /{db}/_changes Returns changes for the given database
POST /{db}/_changes Returns changes for the given database for certain document IDs
 
/{db}/_compact
POST /{db}/_compact Starts a compaction for the database
 
/{db}/_compact/{ddoc}
POST /{db}/_compact/{ddoc} Starts a compaction for all the views in the selected design document
 
/{db}/_design/{ddoc}
HEAD /{db}/_design/{ddoc} Returns bare information in the HTTP Headers for the design document
GET /{db}/_design/{ddoc} Returns the design document
PUT /{db}/_design/{ddoc} Creates a new design document or new version of an existing one
DELETE /{db}/_design/{ddoc} Deletes the design document
COPY /{db}/_design/{ddoc} Copies the design document
 
/{db}/_design/{ddoc}/_info
GET /{db}/_design/{ddoc}/_info Returns view index information for the specified design document
 
/{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view}
GET /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} Executes a list function against the view from other design document
POST /{db}/_design/{ddoc}/_list/{func}/{other-ddoc}/{view} Same as GET method for the related endpoint
 
/{db}/_design/{ddoc}/_list/{func}/{view}
GET /{db}/_design/{ddoc}/_list/{func}/{view} Executes a list function against the view from the same design document
POST /{db}/_design/{ddoc}/_list/{func}/{view} Same as GET method for the related endpoint
 
/{db}/_design/{ddoc}/_rewrite/{path}
ANY /{db}/_design/{ddoc}/_rewrite/{path} Rewrites HTTP request for the specified path by using stored array of routing rules or JavaScript function
 
/{db}/_design/{ddoc}/_search/{index}
GET /{db}/_design/{ddoc}/_search/{index} Returns results for the specified search index
 
/{db}/_design/{ddoc}/_search_info/{index}
GET /{db}/_design/{ddoc}/_search_info/{index} Returns metadata for the specified search index
 
/{db}/_design/{ddoc}/_show/{func}
GET /{db}/_design/{ddoc}/_show/{func} Executes a show function against null document
POST /{db}/_design/{ddoc}/_show/{func} Same as GET method for the related endpoint
 
/{db}/_design/{ddoc}/_show/{func}/{docid}
GET /{db}/_design/{ddoc}/_show/{func}/{docid} Executes a show function against the specified document
POST /{db}/_design/{ddoc}/_show/{func}/{docid} Same as GET method for the related endpoint
 
/{db}/_design/{ddoc}/_update/{func}
POST /{db}/_design/{ddoc}/_update/{func} Executes an update function against the null document
 
/{db}/_design/{ddoc}/_update/{func}/{docid}
PUT /{db}/_design/{ddoc}/_update/{func}/{docid} Executes an update function against the specified document
 
/{db}/_design/{ddoc}/_view/{view}
GET /{db}/_design/{ddoc}/_view/{view} Returns results for the specified stored view
POST /{db}/_design/{ddoc}/_view/{view} Returns results for the specified view
 
/{db}/_design/{ddoc}/_view/{view}/queries
POST /{db}/_design/{ddoc}/_view/{view}/queries Returns results for the specified queries
 
/{db}/_design/{ddoc}/{attname}
HEAD /{db}/_design/{ddoc}/{attname} Returns bare information in the HTTP Headers for the attachment
GET /{db}/_design/{ddoc}/{attname} Gets the attachment of a design document
PUT /{db}/_design/{ddoc}/{attname} Adds an attachment of a design document
DELETE /{db}/_design/{ddoc}/{attname} Deletes an attachment of a design document
 
/{db}/_design_docs
GET /{db}/_design_docs Returns a built-in view of all design documents in this database
POST /{db}/_design_docs Returns a built-in view of all design documents in this database
 
/{db}/_ensure_full_commit
POST /{db}/_ensure_full_commit Deprecated endpoint to support CouchDB versions < 3.0 replicators.
 
/{db}/_explain
POST /{db}/_explain Identify which index is being used by a particular query.
 
/{db}/_find
POST /{db}/_find Find documents within a given database
 
/{db}/_index
GET /{db}/_index List all indexes.
POST /{db}/_index Create a new index.
 
/{db}/_index/{designdoc}/json/{name}
DELETE /{db}/_index/{designdoc}/json/{name} Delete an index
 
/{db}/_local/{docid}
GET /{db}/_local/{docid} Returns the latest revision of the local document
PUT /{db}/_local/{docid} Inserts a new version of the local document
DELETE /{db}/_local/{docid} Deletes the local document
COPY /{db}/_local/{docid} Copies the local document within the same database
 
/{db}/_local_docs
GET /{db}/_local_docs Returns a built-in view of all local (non-replicating) documents in this database
POST /{db}/_local_docs Returns a built-in view of all local (non-replicating) documents in this database
 
/{db}/_missing_revs
POST /{db}/_missing_revs By given list of document revisions returns the document revisions that do not exist in the database
 
/{db}/_partition/{partition}
GET /{db}/_partition/{partition} Returns document and size info for the given partition
 
/{db}/_partition/{partition}/_all_docs
GET /{db}/_partition/{partition}/_all_docs Return all docs in the specified partition
 
/{db}/_partition/{partition}/_design/{ddoc}/_view/{view}
GET /{db}/_partition/{partition}/_design/{ddoc}/_view/{view} Execute a partitioned query
 
/{db}/_purge
POST /{db}/_purge Purges documents entirely from database
 
/{db}/_purged_infos_limit
GET /{db}/_purged_infos_limit Returns the limit of historical purges to store in the database
PUT /{db}/_purged_infos_limit Sets the limit of historical purges to store in the database
 
/{db}/_revs_diff
POST /{db}/_revs_diff By given list of document revisions returns differences between the given revisions and ones that are in the database
 
/{db}/_revs_limit
GET /{db}/_revs_limit Returns the limit of historical revisions to store for a single document in the database
PUT /{db}/_revs_limit Sets the limit of historical revisions to store for a single document in the database
 
/{db}/_security
GET /{db}/_security Returns the special security object for the database
PUT /{db}/_security Sets the special security object for the database
 
/{db}/_shards
GET /{db}/_shards Displays the shard map layout of a database
 
/{db}/_shards/{docid}
GET /{db}/_shards/{docid} Returns the specific shard in which a document is stored
 
/{db}/_sync_shards
POST /{db}/_sync_shards Trigger a synchronization of all shard replicas in the database
 
/{db}/_view_cleanup
POST /{db}/_view_cleanup Removes view files that are not used by any design document
 
/{db}/{docid}
HEAD /{db}/{docid} Returns bare information in the HTTP Headers for the document
GET /{db}/{docid} Returns the document
PUT /{db}/{docid} Creates a new document or new version of an existing document
DELETE /{db}/{docid} Deletes the document
COPY /{db}/{docid} Copies the document within the same database
 
/{db}/{docid}/{attname}
HEAD /{db}/{docid}/{attname} Returns bare information in the HTTP Headers for the attachment
GET /{db}/{docid}/{attname} Gets the attachment of a document
PUT /{db}/{docid}/{attname} Adds an attachment of a document
DELETE /{db}/{docid}/{attname} Deletes an attachment of a document