File Catalog Api List File Catalog

File Catalog Api List File Catalog
List the file catalog

Lists the global file catalog, paginated, filterable and sortable. Accessible to every authenticated role.

Request
URI
GET
https://{api_host}/api/v1/file-catalog
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (default 0). A negative page answers 400 INVALID_PAGINATION; it is not clamped.

integer
pageSize
Optional
Constraints: minimum: 1 maximum: 100 default: 20

Number of items per page (default 20, 1 to 100). A value outside 1 to 100 answers 400 INVALID_PAGINATION; it is not clamped.

pageSize example
20
string
search
Optional

Case-insensitive match on file name or publisher, or a SHA-256 (full, or a hex prefix)

search example
backup-agent
state
Optional

Filter by global state

state example
UNAPPROVED
boolean
hasRule
Optional

true: only entries that have a rule. false: only entries without one

boolean
activeOnly
Optional

true: only files that at least one hypervisor currently has

activeOnly example
true
sortBy
Optional
Constraints: default: fileName

Sort field (default fileName): fileName, globalState or hypervisorCount; matched case-insensitively. Any other value answers 400 INVALID_FILTER.

sortBy example
fileName
sortOrder
Optional
Constraints: default: ASC

Sort direction, ASC or DESC (default ASC). Any other value answers 400 INVALID_FILTER.

sortOrder example
ASC

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. A page of file catalog entries

Returns PaginatedResponse_FileCatalogEntryDto of type(s) application/json
{
    "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 object
items
Required  

Array of items for the current page

integer As int32 As int32
page
Required  
Constraints: minimum: 0

Zero-based current page number

integer As int32 As int32
pageSize
Required  
Constraints: minimum: 1 maximum: 100

Number of items requested per page

integer As int64 As int64
totalItems
Required  

Total number of items matching filter criteria

integer As int32 As int32
totalPages
Required  
Constraints: minimum: 0

Total number of available pages


400

400 Bad Request: INVALID_PAGINATION or INVALID_FILTER

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

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

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

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.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/file-catalog