File Catalog Api List File Catalog
Lists the global file catalog, paginated, filterable and sortable. Accessible to every authenticated role.
Zero-based page index (default 0). A negative page answers 400 INVALID_PAGINATION; it is not clamped.
Number of items per page (default 20, 1 to 100). A value outside 1 to 100 answers 400 INVALID_PAGINATION; it is not clamped.
20
Case-insensitive match on file name or publisher, or a SHA-256 (full, or a hex prefix)
backup-agent
true: only entries that have a rule. false: only entries without one
true: only files that at least one hypervisor currently has
true
Sort field (default fileName): fileName, globalState or hypervisorCount; matched case-insensitively. Any other value answers 400 INVALID_FILTER.
fileName
Sort direction, ASC or DESC (default ASC). Any other value answers 400 INVALID_FILTER.
ASC
200 OK successful response envelope. A page of file catalog entries
{
"items": [
{
"fileId": 101,
"fileName": "backup-agent.sh",
"sha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"fileKind": "SCRIPT",
"globalState": "UNAPPROVED",
"hypervisorCount": 2
},
{
"fileId": 102,
"fileName": "sshd",
"sha256": "0000000000000000000000000000000000000000000000000000000000000000",
"fileKind": "ELF",
"publisher": "Example Software",
"globalState": "APPROVED",
"hypervisorCount": 12,
"rule": {
"ruleId": 1000001,
"name": "Allow sshd",
"action": "ALLOW",
"ruleRank": "CUSTOM_GLOBAL",
"isEnabled": true,
"attachment": "ATTACHED",
"attachedPolicyCount": 1
}
}
],
"page": 0,
"pageSize": 20,
"totalItems": 2,
"totalPages": 1
}
Array of items for the current page
Zero-based current page number
Number of items requested per page
Total number of items matching filter criteria
Total number of available pages
400 Bad Request: INVALID_PAGINATION or INVALID_FILTER
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked
{
"errorCode": "string",
"message": "string",
"path": "string",
"timestamp": "string",
"reason": "string"
}
Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.
Human-readable error description
Request URI path that produced the error
Timestamp when the error occurred as an ISO 8601 date-time with offset
A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.
curl -H 'Authorization: <value>' https://{api_host}/api/v1/file-catalog