Rule Pack Api Download

Rule Pack Api Download
Download and review the Rule Pack from the portal

Downloads the pack from the portal URL stored in the database and reviews it as an upload, with source FEED. No request body. The saved token, if any, is sent as a Bearer token to the portal host only. Requires the ADMIN role.

Request
URI
POST
https://{api_host}/api/v1/rules/pack/download
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The stored review of the downloaded pack

Returns RulePackReviewDto of type(s) application/json
{
    "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
        }
    ]
}
string As uuid As uuid
reviewId
Required  

Identifier of the stored review; pass it to the install and discard operations

string As date-time As date-time
createdAt
Required  

When the review was made, as an ISO 8601 date-time in UTC

string As date-time As date-time
expiresAt
Required  

Seven days after createdAt, as an ISO 8601 date-time in UTC; installing a review past this time is refused with REVIEW_EXPIRED

integer As int64 As int64
packSequence
Required  

Sequence number of the reviewed pack, from its manifest

string
packVersion
Required  

Version text of the reviewed pack, from its manifest

string As ^[0-9a-f]{64}$
artifactSha256
Required  

SHA-256 of the reviewed rulepack.bin: pass it unchanged as the install request artifactSha256

boolean
alreadyInstalled
Required  

True when the install ledger already records this exact pack; installing it then answers ALREADY_INSTALLED and writes nothing

object
verification
Required  

What verified the pack. For an unsigned pack both flags are false and the three signer values are null.

array of object
fleet
Required  

One item per Security Group in id order, Groups without agents included: the Group's agents against the pack

array of object
coverage
Required  

One item per Security Group in id order, Groups without agents included: the Group's coverage change

object
diff
Required  

The plan's counts as the review shows them.

integer As int64 As int64
builtInInUse
Required  

Built-in Rules in use before the install

boolean
retirementNeedsConfirmation
Required  

The pack retires more than half of the Built-in Rules in use: the install needs confirmRetirement true

array of object
changes
Required  

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


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.


403

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)

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.


409

409 Conflict: FEED_NOT_CONFIGURED (the download is disabled, or no usable https URL is stored)

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.


413

413 Content Too Large: PACK_TOO_LARGE

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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.


422

422 Unprocessable Content: a refused pack: a PACK_* code, or PACK_ENTRY_INVALID with the import code as reason

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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.


502

502 Bad Gateway: FEED_UNAUTHORIZED (the portal answered 401 or 403) or FEED_UNREACHABLE

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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.


503

503 Service Unavailable: CREDENTIAL_PROTECTION_UNAVAILABLE, TRUST_PROFILE_INVALID or CONSOLE_VERSION_UNKNOWN

Returns ApiErrorResponse of type(s) application/json
"ApiErrorResponse Object"
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 -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/rules/pack/download