Sample - Box Platform API
GET/storage_policies/{storage_policy_id}

Get a storage policy

Retrieves a specific storage policy by its identifier. Use storage_policy_id to select the storage policy whose storage zone details you need.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
storage_policy_idstringrequired
The unique identifier of the storage policy to retrieve.

2 status codes
200Returns a storage policy object containing its required identifier and type, along with its name and storage zone details.
idstringrequired
The unique identifier for this storage policy.
typestringrequired
The value will always be `storage_policy`.
Allowed:storage_policy
namestringoptional
A descriptive name of the region.
defaultReturned when an unexpected client error occurs.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

storage_policy_id must identify the storage policy to retrieve. Provide the identifier as a string.