Oxelone Docs

Search docs and API

Find a guide, a section of one, or an API operation by its name.

Open console (opens in a new tab)

API reference Using the API

Pagination

A list that pages answers with one page of rows and a next_cursor. Pass it back as cursor to get the next page. When next_cursor is null, that was the last page.

Two pages of machines

The parameters

ParameterWhat it does
limitRows wanted on this page. Each list has its own maximum, and a larger limit is lowered to it.
cursorWhere the previous page stopped: the next_cursor it returned.

Cursors are opaque

A cursor is a position, not a key. Do not build one or take one apart, and do not keep one for later: pass the one you were given straight back. A cursor the API cannot read starts the list over from the first page.

Counting

A list may also answer with total, the number of rows the filter matched across every page, which is not the length of one page. Which lists page, and what each returns, is on that operation's page under Query parameters and Response.