Update Basic Xray Settings

Xray REST APIs

Products
JFrog Xray
Content Type
REST API

Description: Enables administrators to configure a set of basic Xray settings.

Note

Some of these settings can also be configured individually using specific APIs, as described below.

Since: 7.37

Security: Requires an admin user

Usage: POST /artifactory/api/xrayRepo/updateXrayBasicSettings

Sample Request:

{
    "xrayEnabled": true,
    "allowOperationsXrayUnavailable": false,
    "allowBlockedArtifactsDownload": false,
    "blockUnscannedTimeoutSeconds": 60,
    "blockUnfinishedScansTimeoutSeconds": 1800
}

The request includes the following information:

Property

Required

Type

Description

xrayEnabled

required

boolean

Enables or disables Xray integration.

The default is true (enabled).

allowDownloadsXrayUnavailable

required

boolean

Deprecated

Use allowOperationsXrayUnavailable instead.

When set to true, allows downloads when the Xray service is unavailable.

The default is false.

allowOperationsXrayUnavailable

required

boolean

When set to true, allows artifact operations (downloads etc.) when the Xray service is unavailable. Replaces allowDownloadsXrayUnavailable.

The default is false.

allowBlockedArtifactsDownload

required

boolean

When set to true, allows the downloading of artifacts that have been blocked by Xray policies.

The default is false.

blockUnscannedTimeoutSeconds

required

integer

The timeout in seconds to wait for unscanned artifacts before allowing/blocking the download.

The default is 60 seconds.

blockUnfinishedScansTimeoutSeconds

required

integer

The timeout in seconds to wait for scans in progress to complete before allowing/blocking the download.

The default is 1800 seconds.

Response (success): 200 OK