Download the support bundle
Download the support bundle
Downloads the generated support bundle. When the check_only parameter is set to true, then status of the generation process is returned without downloading the file.
Request
URI
GET
https://{opsmanager-installation}/api/v0/support_bundle/{id}
COPY
Path Parameters
string
id
Required
id
Query Parameters
boolean
check_only
Optional
Only returns the status of the generation process without attempting to download the file.
Responses
200
Generation status or file download
Returns
SupportBundle
of type(s)
application/json
{
"process": {
"id": 0,
"status": "string",
"start_time": "string",
"finish_time": "string",
"message": "string"
}
}
process
Optional
process
400
Setup is not completed
Returns
RequireSetupCompleted
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
401
Unauthorized
Returns
UnauthorizedResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
403
Forbidden
Returns
ForbiddenResponse
of type(s)
application/json
{
"errors": {
"errors": [
"string"
]
}
}
404
Not found or generation failed
OneOf
{
"0": "S",
"1": "u",
"2": "p",
"3": "p",
"4": "o",
"5": "r",
"6": "t",
"7": "B",
"8": "u",
"9": "n",
"10": "d",
"11": "l",
"12": "e",
"13": " ",
"14": "O",
"15": "b",
"16": "j",
"17": "e",
"18": "c",
"19": "t"
}
423
Support bundle generation has not started yet
Returns
SupportBundle
of type(s)
application/json
"SupportBundle Object"
process
Optional
process
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/api/v0/support_bundle/{id}
Support Bundle Operations
GET
Download the support bundle
GET
Generate and download the support bundle
POST
Generate the support bundle