Rule Pack Api Feed Settings

Rule Pack Api Feed Settings
Get the portal download settings

Never returns the download URL or the token. Requires the ADMIN role.

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

200 OK successful response envelope. The portal download settings, without the download URL or the token

Returns RulePackFeedSettingsDto of type(s) application/json
{
    "enabled": true,
    "downloadAvailable": true,
    "tokenConfigured": true,
    "tokenExpiresOn": "2026-03-01",
    "tokenStatus": "VALID"
}
boolean
enabled
Required  

Whether the portal download is enabled

boolean
downloadAvailable
Required  

A download URL is stored; it is set in the database only

boolean
tokenConfigured
Required  

True when a token is stored; the token itself is never returned

string As date As date
tokenExpiresOn
Required  

Expiry date of the stored token, a calendar date compared with the server date in UTC. Null when none is set

string
tokenStatus
Required  

The token status, derived from tokenExpiresOn and the server date (UTC). Reported only: an expired date does not block the download.

  • NONE: No token is stored
  • VALID: A token is stored with no expiry date, or with one more than 14 days after today
  • EXPIRING_SOON: A token is stored and expires today or within the next 14 days
  • EXPIRED: A token is stored and its expiry date is before today
Enumeration: NONE, VALID, EXPIRING_SOON, EXPIRED

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

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 -H 'Authorization: <value>' https://{api_host}/api/v1/rules/pack/feed