Skip to content

Get box names for a given application.

GET
/v2/applications/{application-id}/boxes

Given an application ID, returns the box names of that application sorted lexicographically.

application-id
required
integer
limit
integer

Maximum number of results to return. There could be additional pages even if the limit is not reached.

next
string

The next page of results. Use the next token provided by the previous results.

include
Array<string>
Allowed values: values

Include additional items in the response. Use values to include box values. Multiple values can be comma-separated.

Box names of an application

object
application-id
required

[appidx] application index.

integer
boxes
required
Array<object>

Box descriptor describes an app box.

object
name
required

Base64 encoded box name

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
value

Base64 encoded box value. Present only when the values query parameter is set to true.

string format: byte
/^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$/
next-token

Used for pagination, when making another request provide this token with the next parameter.

string
round

The round for which this information is relevant.

integer

Response for errors

object
data
object
message
required
string

Response for errors

object
data
object
message
required
string

Response for errors

object
data
object
message
required
string