Rule Pack Api Update Feed Settings

Rule Pack Api Update Feed Settings
Save the portal download settings

The token is write-only and is stored encrypted. The download URL cannot be set through the API. Requires the ADMIN role.

Request
URI
PUT
https://{api_host}/api/v1/rules/pack/feed
COPY
Request Body

The portal download settings to save: enabled, and optionally the write-only token, clearToken and the token expiry date. The download URL cannot be set through the API.

RulePackFeedUpdateRequest of type(s) application/json
Required  

Show optional properties

{
    "enabled": false
}
{
    "enabled": true,
    "token": "<redacted>",
    "tokenExpiresOn": "2026-03-01"
}
boolean
enabled
Required  

True enables the portal download and false disables it; required, applied as given

string As password As password
token
Optional
Constraints: minLength: 8 maxLength: 4096

Write-only. Absent keeps the saved token. Otherwise it is trimmed and must be 8 to 4096 visible ASCII characters without whitespace; anything else is VALIDATION_FAILED.

boolean
clearToken
Optional

True removes the saved token; true together with a token is VALIDATION_FAILED

string As date As date
tokenExpiresOn
Optional

Absent clears the date. Reported as the token status only, never enforced.

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The saved portal download settings

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

400

400 Bad Request: MALFORMED_REQUEST (a body or date that does not parse) or VALIDATION_FAILED

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.


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.


415

415 Unsupported Media Type: UNSUPPORTED_MEDIA_TYPE

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 (a token is sent and the credential key is not configured)

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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"enabled":"boolean"}' https://{api_host}/api/v1/rules/pack/feed