Skip to content

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.

application-id
required
integer

An application identifier.

max
integer

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

Box names of an application

object
boxes
required
Array<object>

Box descriptor describes a 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}=)?$/

Bad Request

An error response with optional data field.

object
data
object
message
required
string

Invalid API Token

An error response with optional data field.

object
data
object
message
required
string

Internal Error

An error response with optional data field.

object
data
object
message
required
string

Unknown Error