Create Support Bundle

Description: Create a new support bundle.

Since: 4.3.0

Security: Requires an admin user

Notes: All bundle items are optional.

Usage:POST /artifactory/api/system/support/bundle/

Consumes: application/json

Produces: application/json

Sample Usage:

curl -X POST -u user:password -H "Content-Type: application/json" "http://ARTIFACTORY_SERVER_HOSTNAME:8082/artifactory/api/system/support/bundle/" \
--data '{  
   "name":"supportBundle1",
   "description":"Test support bundle",
   "parameters":{  
      "configuration":true,
      "system":true,
      "collectSlowQueriesFromDatabase":true,
      "logs":{  
         "include":true,
         "start_date":"2024-08-01",
         "end_date":"2024-08-01"
      },
      "thread_dump":{  
         "count": 2,
         "interval": 1000
      }
   }
}'

The request contains the following parameters:

Field	Type	Required	Default Value	Description
`name`	String	no	N/A	Support bundle name
`description`	String	no	N/A	Support bundle description
`parameters`	Object	no		Support bundle parameters
`parameters.configuration`	Boolean	no	`true`	Collect configuration files
`parameters.system`	Boolean	no	`true`	Information about your system including storage, system properties, CPU, and JVM information
`parameters.collectSlowQueriesFromDatabase`	Boolean	no	`false`	When set to `true`, collects information about the 10 slowest database queries and adds them to the support bundle in a file called database-slow-queries.json. If no slow queries are found, the following message appears inside the JSON file: `"Response":"There are no slow running queries at this moment"` Supported databases: PostgreSQL, MySQL, MariaDB, MS SQL
`parameters.logs`	Object	no		Collect all system logs. If this field is not specified, the support bundle will collect logs from the day before today until today.
`parameters.logs.include`	Boolean	no	`true`	Collect system logs.
`parameters.logs.start_date`	String	no	Day before `end_date`	Start date from which to fetch the logs. Required format: YYYY-MM-DD
`parameters.logs.end_date`	String	no	Today	End date until which to fetch the logs. Required format: YYYY-MM-DD
`thread_dump`	Object	no		Create a thread dump for all running threads
`thread_dump.count`	Integer	no	`1`	Number of thread dumps to collect
`thread_dump.interval`	Integer	no	`0`	The interval between times of thread dump collection in milliseconds

Sample Response:

{
    "id": "20240808-185648-592",
    "artifactory": {
        "service_id": "jfrt@...",
        "bundle_url": "http://ARTIFACTORY_SERVER_HOSTNAME:8082/artifactory/jfrog-support-bundle/20240808-185648-592/jfrt/jfrt@01j4ph0jnq22ha0733aft61ph1"
    }
}

Status Codes:

Code	Description
200	Support bundle created successfully