Create Waiver Request

JFrog REST APIs

Content Type
REST API

Description: Create a waiver request to unblock a package that was blocked by a JFrog Curation policy.

Since: 3.138.0

Applicable Environment: JFrog SaaS, JFrog Self-Hosted

Security: Requires a valid user with the REQUEST_WAIVER permission.

UsagePOST /xray/api/v1/curation/waiver_requests

Consumes: application/json

Produces: application/json

Request Body:

Name

Type

Mandatory/Optional

Description

pkg_name

string

mandatory

Name of the package for which the waiver is requested.

pkg_version

string

mandatory

Version of the package.

pkg_type

string

mandatory

Package type (for example: npm, pypi, maven).

reason

string

mandatory

Reason for requesting the waiver.

Response Body:

Name

Type

Description

waiver_id

int

Unique identifier of the newly created waiver request.

status

string

Initial status of the waiver request (for example: pending).

created_at

timestamp

Time when the waiver request was created.

Response Codes:

Status Code

Description

200

Waiver request created successfully

400

Invalid request body or missing mandatory fields

403

Permission denied

500

Failed to create waiver request

Sample Request:

POST /xray/api/v1/curation/waiver_requests
Content-Type: application/json
Accept: application/json

{
  "pkg_name": "lodash",
  "pkg_version": "4.17.21",
  "pkg_type": "npm",
  "reason": "Required for backward compatibility"
}

Sample Response:

{
  "waiver_id": 42,
  "status": "pending",
  "created_at": "2025-01-03T10:12:44+00:00"
}