Skip to main content
GET
/
v2
/
vault-plus
/
status
Get storage status for a connection
curl --request GET \
  --url https://api.ofauth.com/v2/vault-plus/status \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <x-connection-id>'
{
  "connectionId": "conn_v5bsqkzsjfk8cgr7hqbbw09t",
  "storedCount": 40,
  "pendingCount": 2,
  "totalSizeBytes": 123456
}

Authorizations

​
apiKey
string
header
required

Your OFAuth API key for authenticating requests.

Headers

​
x-connection-id
string
required

Connection ID whose Vault+ cache status should be returned.

Minimum string length: 1
Example:

"conn_v5bsqkzsjfk8cgr7hqbbw09t"

Response

Connection-scoped Vault+ cache counts and storage size.

Connection-scoped Vault+ cache status.

​
connectionId
string
required

Connection ID from the x-connection-id header.

Example:

"conn_v5bsqkzsjfk8cgr7hqbbw09t"

​
storedCount
number
required

Number of internal media variants that have completed persistent Vault+ storage for this connection.

Example:

40

​
pendingCount
number
required

Number of internal media variants known to Vault+ but not yet stored. Calculated as total known variants minus stored variants.

Example:

2

​
totalSizeBytes
number
required

Total persistent storage bytes currently used by this connection.

Example:

123456