Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

Edge Server REST API

    March 23, 2025
    + 12
    Couchbase Edge Server has a REST API that enables you to get database information, perform document operations, run SQL++ queries, and manage replication.

    Clients do not need any special tools, SDKs, or libraries to access the Edge Server REST API. The REST API supports off-the-shelf HTTP clients, such as Insomnia or Postman.

    Versioning

    To allow for future changes, the REST API is versioned. The current version is 1.0.

    Requests may include an API-Version header to specify the API version. If omitted, it defaults to 1.0. Currently, versioning is optional, but future releases may introduce other versions of the Edge Server REST API.

    Concurrent Access and Revision Numbers

    To support concurrent requests, the REST API supports optimistic concurrency control, using query parameters or If-Match headers in combination with revision numbers. Details are noted in the endpoint descriptions. A typical pattern is to do a GET request on a specified resource, which returns a revision number. You can then include the revision number in a PUT or DELETE request to update the resource.

    See Also