Rule Pack Api Review Upload
Verifies and diffs an uploaded pack (source UPLOAD) and stores the review for 7 days, replacing every other stored review. Installing it is a separate call. A request that is not multipart/form-data answers 415. Requires the ADMIN role.
The Rule Pack as multipart/form-data with one part named file, which holds the zip of the pack files. The part is required, and the request is limited to 6 MiB.
Show optional properties
{
"file": "string"
}
{
"file": "<signed zip: manifest.json, rulepack.bin and the META-INF signature files>"
}
A zip of the pack: manifest.json, rulepack.bin and the three META-INF signature files of a signed JAR. An unsigned zip (the first two only) is refused while signature enforcement is on. The request is limited to 6 MiB.
200 OK successful response envelope. The stored review of the uploaded pack
{
"reviewId": "00000000-0000-4000-8000-000000000051",
"createdAt": "2026-01-15T09:30:00Z",
"expiresAt": "2026-01-22T09:30:00Z",
"packSequence": 2,
"packVersion": "1.1.0",
"artifactSha256": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"alreadyInstalled": false,
"verification": {
"signatureVerified": true,
"signerFingerprint": "0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
"signerSubject": "CN=Example Rule Pack Signer,O=Example Org",
"timestampVerified": true,
"signingTime": "2026-01-14T08:00:00Z"
},
"fleet": [
{
"groupId": 1,
"groupName": "Production Servers",
"agents": 2,
"belowMinAgentVersion": 0
},
{
"groupId": 2,
"groupName": "Staging Servers",
"agents": 0,
"belowMinAgentVersion": 0
}
],
"coverage": [
{
"groupId": 1,
"groupName": "Production Servers",
"agentsLosingRules": 0,
"agentsNotCovered": 0
},
{
"groupId": 2,
"groupName": "Staging Servers",
"agentsLosingRules": 0,
"agentsNotCovered": 0
}
],
"diff": {
"added": 1,
"updated": 1,
"retired": 0,
"retireNotPresent": 0,
"unchanged": 12
},
"builtInInUse": 13,
"retirementNeedsConfirmation": false,
"changes": [
{
"guid": "00000000-0000-4000-8000-000000000003",
"ruleId": 10000002,
"name": "Detect Reverse Shell",
"changeType": "ADDED",
"aspects": [],
"ruleType": "PATH_FILE_CMD",
"ruleRank": "VIRTUAL_PATCHING",
"action": "BLOCK",
"minAgentVersion": "1.0.0",
"revision": 1,
"attachedPolicyCount": 0
},
{
"guid": "00000000-0000-4000-8000-000000000002",
"ruleId": 10000001,
"name": "Block Credential Store Reads",
"changeType": "UPDATED",
"aspects": [
"BODY"
],
"ruleType": "PATH_FILE_CMD",
"ruleRank": "VIRTUAL_PATCHING",
"action": "BLOCK",
"minAgentVersion": "1.0.0",
"revision": 2,
"attachedPolicyCount": 2
}
]
}
Identifier of the stored review; pass it to the install and discard operations
When the review was made, as an ISO 8601 date-time in UTC
Seven days after createdAt, as an ISO 8601 date-time in UTC; installing a review past this time is refused with REVIEW_EXPIRED
Sequence number of the reviewed pack, from its manifest
Version text of the reviewed pack, from its manifest
SHA-256 of the reviewed rulepack.bin: pass it unchanged as the install request artifactSha256
True when the install ledger already records this exact pack; installing it then answers ALREADY_INSTALLED and writes nothing
What verified the pack. For an unsigned pack both flags are false and the three signer values are null.
One item per Security Group in id order, Groups without agents included: the Group's agents against the pack
One item per Security Group in id order, Groups without agents included: the Group's coverage change
The plan's counts as the review shows them.
Built-in Rules in use before the install
The pack retires more than half of the Built-in Rules in use: the install needs confirmRetirement true
The rules the install adds or updates, in pack entry order, then the rules it retires, in manifest order. Unchanged entries are only counted in diff
400 Bad Request: MISSING_PARAMETER (no file part) or MALFORMED_REQUEST
{
"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.
403 Forbidden: FORBIDDEN or CSRF_ERROR. CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)
{
"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.
413 Content Too Large: PACK_TOO_LARGE
"ApiErrorResponse Object"
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.
415 Unsupported Media Type: UNSUPPORTED_MEDIA_TYPE
"ApiErrorResponse Object"
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.
422 Unprocessable Content: a refused pack: a PACK_* code (PACK_FORMAT_UNSUPPORTED, PACK_HASH_MISMATCH, PACK_SIGNATURE_INVALID, PACK_SIGNER_NOT_TRUSTED, PACK_SIGNER_REVOKED, PACK_ALGORITHM_NOT_ALLOWED, PACK_TIMESTAMP_INVALID, PACK_ROLLBACK, PACK_SEQUENCE_CONFLICT, PACK_DECRYPT_FAILED, PACK_CONSOLE_TOO_OLD) or PACK_ENTRY_INVALID with the import code as reason
"ApiErrorResponse Object"
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.
503 Service Unavailable: TRUST_PROFILE_INVALID or CONSOLE_VERSION_UNKNOWN
"ApiErrorResponse Object"
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 -X POST -H 'Authorization: <value>' -H 'Content-Type: multipart/form-data' -d '{"file":"string"}' https://{api_host}/api/v1/rules/pack/review