Endpoint

/v1/file-system/security/keys/{key_ref}/usages

GET

Get file system public key usage by using the name or identifier of the specified key.

Parameters

Name Description Required
key_ref The name or identifier of the public key for which to show snapshot and snapshot policy usage. Yes
after Return entries after the given key (keys are returned in the paging object) No
limit Return no more than this many entries; the system may choose a smaller limit. No

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_change_lock_key_usage_page",
  "type": "object",
  "properties": {
    "usages": {
      "type": "array",
      "items": {
        "description": "Usages of the key",
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "enum": [
              "snapshot",
              "snapshot_policy",
              "replication_target"
            ],
            "description": "type:\n * `replication_target` - FS_CHANGE_LOCK_KEY_USAGE_REPLICATION,\n * `snapshot` - FS_CHANGE_LOCK_KEY_USAGE_SNAPSHOT,\n * `snapshot_policy` - FS_CHANGE_LOCK_KEY_USAGE_SNAPSHOT_POLICY"
          },
          "id": {
            "description": "id",
            "type": "string"
          }
        }
      }
    }
  }
}