Create Specific Support Bundle

JFrog REST APIs

Products

JFrog Xray

Content Type

REST API

ft:sourceType

Paligo

Description: Creates a new support bundle and assigns it a specific ID

Since: 1.6

Security: Admin only

Usage: PUT /api/v1/system/support/bundle/:bundle_id

Request headers: N/A

Consumes: application/json

Produces: application/json

cURL Example

$ curl -X PUT -u user:password -H "Content-Type: application/json" "http://ARTIFACTORY_SERVER_HOSTNAME:8082/distribution/api/v1/system/support/bundle/:bundle_id" -T create_support_bundle.json

create_support_bundle.json

{
 "parameters": {
                "configuration": true|false,
                "logs": {
                         "include":  true|false,
                         "start_date": ISO8601 based date in the pattern: YYYY-MM-DD,
                         "end_date": ISO8601 based date in the pattern: YYYY-MM-DD,
                        },
                "system": true|false,
                "thread_dump": {
                                "count": 1,
                                "interval" :0
                               }
                    },
  "description": "",
  "name": ""
}

Field	Type	Required	Default Value	Since	Description
`parameters`	Object	no	N/A	1.6	Support bundle parameters
`parameters.configuration`	Boolean	no	true	1.6	Collect configuration files
`parameters.logs`	Object	no	N/A	1.6	Collect all system logs, if this field is not specified support bundle will collect logs from day before today until today.
`parameters.logs.include`	Boolean	no	true	1.6	Collect system logs.
`parameters.logs.start_date`	String	no	`Day before end_date`	1.6	Start date from which to fetch the logs
`parameters.logs.end_date`	String	no	Today	1.6	End date until which to fetch the logs
`system`	Boolean	no	true	1.6	Information about your system including storage, system properties, cpu, and JVM information
`thread_dump`	Object	no	N/A	1.6	Create a thread dump for all running threads
`thread_dump.count`	Integer	no	1	1.6	Number of thread dumps to collect
`thread_dump.interval`	Integer	no	0	1.6	Interval between times of collect thread dump in milliseconds
`description`	String	no	N/A	1.6	Support bundle description
`name`	String	no	N/A	1.6	Support bundle name

Response status codes:

200 - Successfully create support bundle

400 - Corresponding repository does not exist in Artifactory. Support bundle will be persisted to the file system in each Distribution Edge.

404 - Artifactory authentication provider could not be found

Response headers: N/A

Produces: application/json

response.json

{
 "id": 20181230145474-53666747,
  "artifactory": { 
                 "service_id": "jfds@...",
                 "bundle_url":
                      http://<artifactory host>:<artifactory port>/artifactory/support-bundles/<bundle id>/jfds/<service id>
                 }
}