Introduction IBM® Cloudant® for IBM Cloud® is a document-oriented database as a service DBaaS. It stores data as documents in JSON format. It is built with scalability, high availability, and durability in mind. It comes with a wide variety of indexing options that include MapReduce, IBM Cloudant Query, and full-text indexing. The replication capabilities make it easy to keep data in sync between database clusters, desktop PCs, and mobile devices. The key API difference between Gen 1 and Gen 2 is how you manage some aspects of instance configuration. In Gen 2, you use IBM Cloud resource management to configure these instead. Detailed documentation is also available such as a Getting started tutorialgs, API overview documentation, tutorials, and guidesabout. If you intend to store sensitive information in an IBM® Cloudant® for IBM Cloud® database you must use client-side encryption to render data unreadable to Cloudant operators. For example for PCI DSS compliance you must encrypt the Primary Account Number PAN before sending a document containing it to the database. This documentation describes the SDKs and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane. This documentation describes the Java SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane. This documentation describes the Node SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane. This documentation describes the Python SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane. This documentation describes the Go SDK and examples. To see usage information and examples in your preferred SDK, select the language tab in the right pane. The code examples on this tab use the IBM Cloudant SDK for Java&trade. Gradle groovy implementation 'com.ibm.cloud:cloudant:0.+' Maven Maven installation instructionshttps://github.com/IBM/cloudant-java-sdk/maven GitHub Method Path Summary GET / Retrieve server instance information GET /_uuids Retrieve one or more UUIDs GET /_all_dbs Query a list of all database names in the instance POST /_dbs_info Query information about multiple databases DELETE /{db} Delete a database GET /{db} Retrieve information about a database HEAD /{db} Retrieve the HTTP headers for a database PUT /{db} Create a database GET /{db}/_changes Query the database document changes feed (GET) POST /{db}/_changes Query the database document changes feed POST /{db} Create or modify a document in a database GET /{db}/_all_docs Query a list of all documents in a database (GET) POST /{db}/_all_docs Query a list of all documents in a database POST /{db}/_all_docs/queries Multi-query the list of all documents in a database POST /{db}/_bulk_docs Bulk modify multiple documents in a database POST /{db}/_bulk_get Bulk query revision information for multiple documents GET /{db}/_partition/{partition_key}/_all_docs Query a list of all documents in a database partition (GET) DELETE /{db}/{doc_id} Delete a document GET /{db}/{doc_id} Retrieve a document HEAD /{db}/{doc_id} Retrieve the HTTP headers for the document PUT /{db}/{doc_id} Create or modify a document DELETE /{db}/_design/{ddoc} Delete a design document GET /{db}/_design/{ddoc} Retrieve a design document HEAD /{db}/_design/{ddoc} Retrieve the HTTP headers for a design document PUT /{db}/_design/{ddoc} Create or modify a design document GET /{db}/_design/{ddoc}/_info Retrieve information about a design document GET /{db}/_design_docs Query a list of all design documents in a database (GET) POST /{db}/_design_docs Query a list of all design documents in a database POST /{db}/_design_docs/queries Multi-query the list of all design documents GET /{db}/_design/{ddoc}/_view/{view} Query a MapReduce view (GET) POST /{db}/_design/{ddoc}/_view/{view} Query a MapReduce view POST /{db}/_design/{ddoc}/_view/{view}/queries Multi-query a MapReduce view GET /{db}/_partition/{partition_key}/_design/{ddoc}/_view/{view} Query a database partition MapReduce view function (GET) POST /{db}/_explain Retrieve information about which index is used for a query POST /{db}/_find Query an index by using selector syntax GET /{db}/_index Retrieve information about all indexes POST /{db}/_index Create a new index on a database DELETE /{db}/_index/_design/{ddoc}/{type}/{index} Delete an index POST /{db}/_partition/{partition_key}/_explain Retrieve information about which partition index is used for a query POST /{db}/_partition/{partition_key}/_find Query a database partition index by using selector syntax GET /_search_analyze Query tokenization of sample text (GET) POST /_search_analyze Query tokenization of sample text GET /{db}/_design/{ddoc}/_search/{index} Query a search index (GET) POST /{db}/_design/{ddoc}/_search/{index} Query a search index GET /{db}/_design/{ddoc}/_search_disk_size/{index} Retrieve information about the search index disk size GET /{db}/_design/{ddoc}/_search_info/{index} Retrieve information about a search index GET /{db}/_partition/{partition_key}/_design/{ddoc}/_search/{index} Query a database partition search index (GET) GET /{db}/_partition/{partition_key} Retrieve information about a database partition HEAD /{db}/_partition/{partition_key} Retrieve HTTP headers for information about a database partition GET /{db}/_partition/{partition_key}/_all_docs Query a list of all documents in a database partition (GET) POST /{db}/_partition/{partition_key}/_all_docs Query a list of all documents in a database partition GET /{db}/_partition/{partition_key}/_design/{ddoc}/_search/{index} Query a database partition search index (GET) POST /{db}/_partition/{partition_key}/_design/{ddoc}/_search/{index} Query a database partition search index GET /{db}/_partition/{partition_key}/_design/{ddoc}/_view/{view} Query a database partition MapReduce view function (GET) POST /{db}/_partition/{partition_key}/_design/{ddoc}/_view/{view} Query a database partition MapReduce view function POST /{db}/_partition/{partition_key}/_explain Retrieve information about which partition index is used for a query POST /{db}/_partition/{partition_key}/_find Query a database partition index by using selector syntax GET /{db}/_changes Query the database document changes feed (GET) POST /{db}/_changes Query the database document changes feed POST /_replicate Create a transient replication POST /_replicator Create a persistent replication with a generated ID DELETE /_replicator/{doc_id} Cancel a persistent replication GET /_replicator/{doc_id} Retrieve the configuration for a persistent replication HEAD /_replicator/{doc_id} Retrieve the HTTP headers for a persistent replication PUT /_replicator/{doc_id} Create or modify a persistent replication GET /_scheduler/docs Retrieve replication scheduler documents GET /_scheduler/docs/_replicator/{doc_id} Retrieve a replication scheduler document HEAD /_scheduler/docs/_replicator/{doc_id} Retrieve HTTP headers for a replication scheduler document GET /_scheduler/jobs Retrieve replication scheduler jobs GET /_scheduler/jobs/{job_id} Retrieve a replication scheduler job HEAD /_scheduler/jobs/{job_id} Retrieve the HTTP headers for a replication scheduler job DELETE /{db}/{doc_id}/{attachment_name} Delete an attachment GET /{db}/{doc_id}/{attachment_name} Retrieve an attachment HEAD /{db}/{doc_id}/{attachment_name} Retrieve the HTTP headers for an attachment PUT /{db}/{doc_id}/{attachment_name} Create or modify an attachment DELETE /{db}/_local/{doc_id} Delete a local document GET /{db}/_local/{doc_id} Retrieve a local document HEAD /{db}/_local/{doc_id} Retrieve HTTP headers for a local document PUT /{db}/_local/{doc_id} Create or modify a local document POST /{db}/_revs_diff Query the document revisions and possible ancestors missing from the database GET /{db}/_shards Retrieve shard information GET /{db}/_shards/{doc_id} Retrieve shard information for a specific document GET /_active_tasks Retrieve list of running tasks GET /_membership Retrieve cluster membership information GET /_up Retrieve information about whether the server is up HEAD /_up Retrieve HTTP headers about whether the server is up