Get all box names for a given application.

Endpoint

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

• api_key

Parameters

Path Parameters

application-id
required
integer
An application identifier.

Query Parameters

max
integer
Max number of box names to return. If max is not set, or max == 0, returns all box-names.

limit
integer
Maximum number of boxes to return per page.

next
string
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.

prefix
string
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
Array
Allowed values: values
Include additional items in the response. Use values to include box values. Multiple values can be comma-separated.

round
integer format: uint64
Return box data from the given round. The round must be within the node’s available range.

Responses

200

Boxes of an application
Select media type application/json
object

• boxes

required
Array