Rule Pack Api Update Feed Settings
The token is write-only and is stored encrypted. The download URL cannot be set through the API. Requires the ADMIN role.
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.
Show optional properties
{
"enabled": false
}
{
"enabled": true,
"token": "<redacted>",
"tokenExpiresOn": "2026-03-01"
}
True enables the portal download and false disables it; required, applied as given
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.
True removes the saved token; true together with a token is VALIDATION_FAILED
Absent clears the date. Reported as the token status only, never enforced.
200 OK successful response envelope. The saved portal download settings
{
"enabled": true,
"downloadAvailable": true,
"tokenConfigured": true,
"tokenExpiresOn": "2026-03-01",
"tokenStatus": "VALID"
}
Whether the portal download is enabled
A download URL is stored; it is set in the database only
True when a token is stored; the token itself is never returned
Expiry date of the stored token, a calendar date compared with the server date in UTC. Null when none is set
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 storedVALID: A token is stored with no expiry date, or with one more than 14 days after todayEXPIRING_SOON: A token is stored and expires today or within the next 14 daysEXPIRED: A token is stored and its expiry date is before today
400 Bad Request: MALFORMED_REQUEST (a body or date that does not parse) or VALIDATION_FAILED
{
"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.
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.
503 Service Unavailable: CREDENTIAL_PROTECTION_UNAVAILABLE (a token is sent and the credential key is not configured)
"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 PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"enabled":"boolean"}' https://{api_host}/api/v1/rules/pack/feed