Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
App Services

List AppServices

Lists all the clusters under the organization.

In order to access this endpoint, the provided API key must have at least one of the roles referenced below:

  • Organization Owner
  • Project Owner
  • Project Manager
  • Project Viewer
  • Database Data Reader/Writer
  • Database Data Reader

Returned set of clusters is reduced to what the caller has access to view. To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/appservices

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: name, id, description.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

projectIdstring uuid
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the project.

Response

Successfully listed appservices matching query.

Example response

{
  "data": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "name": "My App Service",
      "description": "Description of the App Service.",
      "cloudProvider": "aws",
      "nodes": 2,
      "compute": {
        "cpu": 2,
        "ram": 4
      },
      "clusterId": "ffffffff-aaaa-1414-eeee-000000000000",
      "currentState": "deploying",
      "version": "3.141.5",
      "plan": "basic",
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      },
      "loadBalancerCidr": "10.1.0.0/24"
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}