Get
/sys/v1/accounts/{acct_id}/usage
Get account usage information. See input and output of this API for info on what it can return.
Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Path parameters
acct_id
string (uuid) Required
Query parameters
CountParams
object
range_from
integer
range_to
integer
detailed_usage
boolean
saas_full_usage
boolean
Responses
2XX
Success result
object
num_operations
integer
The count of all operations performed in the account. This value includes both key management (e.g., CRUD ops) and cryptographic operations (e.g., encrypt/decrypt).
To illustrate, here are a few examples:
- If you have a key which was copied to another group and then do a key rotation (with the key-links also being updated), the
num_operationscount will increase by two. - If you have a key and do an encrypt operation this will increase the
num_operationsandencryption_operationseach by one. - If you delete a key, this will increase the only
num_operationsby one.
encryption_operations
integer | null
decryption_operations
integer | null
sign_operations
integer | null
verify_operations
integer | null
tokenization_operations
integer | null
detokenization_operations
integer | null
secrets_operations
integer | null
plugin_invoke_operations
integer | null
apps
object
generic
integer
Minimum0
Maximum4294967295
tokenization
integer
Minimum0
Maximum4294967295
tep
integer
Minimum0
Maximum4294967295
accelerator
integer
Minimum0
Maximum4294967295
secrets_management
integer
Minimum0
Maximum4294967295
aws_cloud_accounts
integer
Minimum0
Maximum4294967295
azure_cloud_accounts
integer
Minimum0
Maximum4294967295
gcp_cloud_accounts
integer
Minimum0
Maximum4294967295
google_ekm_projects
integer
Minimum0
Maximum4294967295
aws_xks_instances
integer
Minimum0
Maximum4294967295
plugin
integer | null
Minimum0
Maximum4294967295
sobjects
integer | null
The total number of sobjects in the account, or
an approximation thereof. This field is present if
the saas_full_usage query parameter is specified
when retrieving account usage statistics.
Note that all sobjects in the account are counted, regardless of whether the user has access to them.
sobjects_accuracy
An indicator of how accurate a count of objects is.
OneOf
object
object
$type
string
Valid values[
"Exact"
]
object
object
$type
string
Valid values[
"Approximate"
]
hsm_gateway
integer | null
Minimum0
Maximum4294967295
operation_top_app
object | null
property*
integer additionalProperties
operation_top_sobject
object | null
property*
integer additionalProperties