Box Developer Documentation
Log in
Latest version

Get storage policy

get
https://api.box.com/2.0
/storage_policies/:storage_policy_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Fetches a specific storage policy.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
34342

The ID of the storage policy.

Response

application/jsonStorage policy

Returns a storage policy object.

application/jsonClient error

An unexpected client error.

get
Get storage policy
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

cURL
curl -i -X GET "https://api.box.com/2.0/storage_policies/34342" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.storagePolicies.getStoragePolicyById(storagePolicy.id);
Python Gen
client.storage_policies.get_storage_policy_by_id(storage_policy.id)
.NET Gen
await client.StoragePolicies.GetStoragePolicyByIdAsync(storagePolicyId: storagePolicy.Id);
Swift Gen (Beta)
try await client.storagePolicies.getStoragePolicyById(storagePolicyId: storagePolicy.id)
Java
BoxStoragePolicy storagePolicy = new BoxStoragePolicy(api, id);
BoxStoragePolicy.Info storagePolicyInfo = storagePolicy.getInfo();
Python
storage_policy = client.storage_policy(policy_id='12345').get()
print(f'Storage Policy ID is {storage_policy.id} and name is {storage_policy.name}')
.NET
BoxStoragePolicy policy = await client.StoragePoliciesManager.GetStoragePolicyAsync(policyId: "6");
Node
client.storagePolicies.get('6')
    .then(storagePolicy => {
        /* storagePolicy -> {
            type: 'storage_policy', 
            id: '6',
            name: 'Tokyo & Singapore' }
        */
    });
iOS
client.storagePolicies.get(storagePolicyId: "22222") { (result: Result<StoragePolicy, BoxSDKError>) in
    guard case let .success(policy) = result else {
        print("Error getting storage policy")
        return
    }
    print("Policy ID is \(policy.id)")
}

Response Example

{
  "id": "11446498",
  "type": "storage_policy",
  "name": "Montreal / Dublin"
}