You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/rest-apis/algod.md
+31-15Lines changed: 31 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -569,32 +569,29 @@ Given an application ID and box name, it returns the round, box name, and value
569
569
570
570
<aname="getapplicationboxes"></a>
571
571
### GET /v2/applications/{application-id}/boxes
572
-
Get boxes for a given application.
572
+
Get all box names for a given application.
573
573
```
574
574
GET /v2/applications/{application-id}/boxes
575
575
```
576
576
577
577
578
578
**Description**
579
-
Given an application ID, return boxes in lexographical order by name. If the results must be truncated, a next-token is supplied to continue the request.
579
+
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.
|**Query**|**max** <br>*optional*|Maximum number of boxes to return. Server may impose a lower limit.|integer|
588
-
|**Query**|**next** <br>*optional*|A box name, in the goal app call arg form 'encoding:value'. When provided, the returned boxes begin (lexographically) with the supplied name. Callers may implement pagination by reinvoking the endpoint with the token from a previous call's next-token.|string|
589
-
|**Query**|**prefix** <br>*optional*|A box name prefix, in the goal app call arg form 'encoding:value'. For ints, use the form 'int:1234'. For raw bytes, use the form 'b64:A=='. For printable strings, use the form 'str:hello'. For addresses, use the form 'addr:XYZ...'.|string|
590
-
|**Query**|**values** <br>*optional*|If true, box values will be returned.|boolean|
587
+
|**Query**|**max** <br>*optional*|Max number of box names to return. If max is not set, or max == 0, returns all box-names.|integer|
591
588
592
589
593
590
**Responses**
594
591
595
592
|HTTP Code|Description|Schema|
596
593
|---|---|---|
597
-
|**200**|Boxes of an application|[Response 200](#getapplicationboxes-response-200)|
594
+
|**200**|Box names of an application|[Response 200](#getapplicationboxes-response-200)|
|**value** <br>*optional*|The new value of the KV store entry, base64 encoded. <br>**Pattern** : `"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==\|[A-Za-z0-9+/]{3}=)?$"`|string (byte)|
0 commit comments