Rule Pack Api Check Now

Rule Pack Api Check Now
Check the portal for a newer Rule Pack now

Runs the portal check at once, verify-only: it never stores a review and never installs. No request body. A check that fails still answers 200, with the failure in error. A check within 30 seconds of the last one is not repeated and the current feed is returned. Requires the ADMIN role.

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

200 OK successful response envelope. The portal check after this check; a check that fails is still answered 200 with the failure in error

Returns RulePackFeedStatusDto of type(s) application/json
{
    "enabled": true,
    "lastCheckedAt": "2026-01-15T09:00:00Z",
    "lastSuccessAt": "2026-01-14T09:00:00Z",
    "available": {
        "packSequence": 2,
        "packVersion": "1.1.0",
        "detectedAt": "2026-01-14T09:00:00Z",
        "signatureVerified": true
    },
    "error": {
        "code": "FEED_UNREACHABLE",
        "since": "2026-01-15T09:00:00Z"
    }
}
boolean
enabled
Required  

True when the portal download is enabled and a download URL is stored, so the check runs

string As date-time As date-time
lastCheckedAt
Required  

When the last portal check ran, successful or not, as an ISO 8601 date-time in UTC. Null when none ran

string As date-time As date-time
lastSuccessAt
Required  

When the last portal check succeeded, as an ISO 8601 date-time in UTC. Null when none succeeded

available
Required  

The verified pack above the installed one that the last check found. Null when there is none

error
Required  

The failure of the last check. Null when it succeeded or none ran


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 or FEED_CHECK_IN_PROGRESS

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.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/api/v1/rules/pack/check