Common Optimization Parameters

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Light and Include are common optimization parameters that can be applied to various API endpoints to tailor the response to your specific needs.

light

The light parameter allows you to request a lighter version of the response, often excluding some non-essential or resource-intensive data. This can help improve API performance and reduce the amount of data transferred.

Usage

  • light: A boolean parameter (usually true or false) that determines whether to enable the lightweight response mode.

  • Default value: false (i.e., the full response is returned).

  • Acceptable values: true to enable the lightweight response, false to get the full response.

include

The include parameter allows you to specify additional related data to include in the response. This can help reduce the number of subsequent API calls needed to retrieve related information.

Usage

  • include: A comma-separated list of related resources or fields that should be included in the response.

  • Acceptable values: A list of valid resource names or fields.