List storage policies

get

https://api.box.com/2.0

/storage_policies

Fetches all the storage policies in the enterprise.

Request

authorizationbearer [ACCESS_TOKEN]

content-typeapplication/json

Query Parameters

fields string arrayin queryoptional

exampleid,type,name

A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.

Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

limit integer (int64)in queryoptional

example1000max1000

The maximum number of items to return per page.

marker stringin queryoptional

exampleJV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii

Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.

This requires usemarker to be set to true.

Response

200application/jsonStorage policies

Returns a collection of storage policies.

defaultapplication/jsonClient error

An unexpected client error.

get

List storage policies

You can now try out some of our APIs live, right here in the documentation.

Request Example

cURL

curl -i -X GET "https://api.box.com/2.0/storage_policies" \
     -H "authorization: Bearer <ACCESS_TOKEN>"

TypeScript Gen

await client.storagePolicies.getStoragePolicies();

Python Gen

client.storage_policies.get_storage_policies()

.NET Gen

await client.StoragePolicies.GetStoragePoliciesAsync();

Swift Gen (Beta)

try await client.storagePolicies.getStoragePolicies()

Java

Iterable<BoxStoragePolicy.Info> storagePolicies = BoxStoragePolicy.getAll(api);
for (BoxStoragePolicy.Info storagePolicyInfo : storagePolicies) {
        //Do something with the storage policy.
}

Python

storage_policies = client.get_storage_policies(limit=100)
for storage_policy in storage_policies:
    print(f'The storage policy id is {storage_policy.id} and name is {storage_policy.name}')

.NET

BoxCollectionMarkerBased<BoxStoragePolicy> policies = await client.StoragePoliciesManager
    .GetListStoragePoliciesAsync();

Node

client.storagePolicies.getAll()
    .then(policies => {
        /* policies -> {
            next_marker: null,
            limit: 1000,
            entries: 
            [ { type: 'storage_policy', id: '42', name: 'Montreal / Dublin' },
                { type: 'storage_policy', id: '126', name: 'Frankfurt / Dublin' },
                { type: 'storage_policy', id: '162', name: 'US' } ] }
        */
    });

iOS

let iterator = client.storagePolicies.listForEnterprise()
iterator.next { results in
    switch results {
    case let .success(page):
        for policy in page.entries {
            print("Storage policy \(policy.id)")
        }

    case let .failure(error):
        print(error)
    }
}

Response Example

{
  "entries": [
    {
      "id": "11446498",
      "type": "storage_policy",
      "name": "Montreal / Dublin"
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii",
  "prev_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"
}