Enable Log Collection

JFrog REST APIs

Products
JFrog Xray
Content Type
REST API
ft:sourceType
Paligo

Description: Enables log collection into a dedicated Logs Artifactory System Repository, to improve auditing capabilities.

  • Logs are collected in a dedicated system repository called jfrog-logs.

    Note

    The repository will be created upon calling the API.

  • Logs are collected in a cycle that may take up to 24 hours.

  • By default, the log types collected are audit and request logs.

Note

Available for Cloud subscriptions only.

Important

The data transfer and storage you consume for downloading or storing the logs will apply against your standard cloud usage, and may incur costs.

Since: 7.27.6

Security: Requires a valid admin-scoped token.

Authorization: Bearer

Usage: POST/access/api/v1/logshipping/config

Content-Type: application/json

Sample Usage

{"enabled": true/false}

Example

curl -XPOST  -H "Content-Type: application/json" -d'{"enabled": true}' -H "Authorization: Bearer <ADMIN ACCESS-TOKEN>" -v https://<JFROG_PLAFORM_URL>/access/api/v1/logshipping/config 

Response Codes:

200 OK

201 Created

400 / 401 Failure or unauthorized