Pagination in the Nebula API

Overview

All core API resources have support for bulk fetches via "list" API methods. For example, you can list access points, access rights or users.

The Salto Nebula API uses cursor-based pagination, i.e.: it returns a "cursor", or opaque token, with the list of results. This token is called the next_page_token and can be passed with the next API request to request the next page.

The field name should match the noun in the method name in the request. For example, there will be a maximum number of items returned based on the page_size field in the request.

Parameters

Order by

You can optionally use the order_by parameter to sort results in a specific way.

The string value should follow SQL syntax, that's to say it should be a comma-separated list of the field names. The default sorting order is ascending.

Here's an example:

• display_name DESC

This example sorts by display_name in descending order.

Not all of the fields in an entity are orderable. The service will return an UNKNOWN: field {entity} is not orderable error for non-orderable fields.

Example request

Lists access points within an installation (using Go):

resp, err := client.ListAccessPoints(context.Background(), &ListAccessPointsRequest{
    Parent:   "installations/{your-installation}",
    PageSize:  2,
})

Example response

{
  "access_points": [
    {
      "allowed_key_types": [
        "CARD",
        "MOBILE",
        "TAG"
      ],
      "name": "installations/{your-installation}/access-points/{your-door}",
      "parent_device_name": "installations/{your-installation}/extenders/{your-extender}",
      "display_name": "Your Door",
      "device_id": "01000000000002"
    },
    {
      "allowed_key_types": [
        "CARD",
        "MOBILE",
        "PIN"
      ],
      "name": "installations/{your-installation}/access-points/{your-door2}",
      "parent_device_name": "installations/{your-installation}/gateways/{your-gateway}",
      "display_name": "Your door2",
      "device_id": "01000000000003"
    }
  ],
  "next_page_token": "4VoaKt6Jv85cTe0X6xtS_oi2FMh65RqDaMwYs5kN0-nXk-QLBQiaihVDdHljzMSSSgLU0I-MfNOopm5WWo9XAm9b1GqBDIpPI0aiYw=="
}