Get all box names for a given application.
GET /v2/applications/{application-id}/boxes
Given an application ID, return all box names. No particular ordering is guaranteed. Request fails when client or server-side configured limits prevent returning all box names.
Pagination mode is enabled when any of the following parameters are provided: limit, next, prefix, include, or round. In pagination mode box values can be requested and results are returned in sorted order.
To paginate: use the next-token from a previous response as the next parameter in the following request. Pin the round parameter to the round value from the first page’s response to ensure consistent results across pages. The server enforces a per-response byte limit, so fewer results than limit may be returned even when more exist; the presence of next-token is the only reliable signal that more data is available.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”An application identifier.
Query Parameters
Section titled “Query Parameters ”Max number of box names to return. If max is not set, or max == 0, returns all box-names.
Maximum number of boxes to return per page.
A box name, in the goal app call arg form ‘encoding:value’, representing the earliest box name to include in results. Use the next-token from a previous response.
A box name prefix, in the goal app call arg form ‘encoding:value’, to filter results by. Only boxes whose names start with this prefix will be returned.
Include additional items in the response. Use values to include box values. Multiple values can be comma-separated.
Return box data from the given round. The round must be within the node’s available range.
Responses
Section titled “ Responses ”Boxes of an application
object
Box descriptor describes a Box.
object
Base64 encoded box name
Base64 encoded box value. Present only when the values query parameter is set to true.
Used for pagination, when making another request provide this token with the next parameter. The next token is the box name to use as the pagination cursor, encoded in the goal app call arg form.
The round for which this information is relevant.
Bad Request
An error response with optional data field.
object
object
Invalid API Token
An error response with optional data field.
object
object
Internal Error
An error response with optional data field.
object
object
default
Section titled “default ”Unknown Error