Tech Support Reports

API used to manage Tech Support Report generation and status for an appliance.

Get list of Tech Support Report generation statuses.

get/techsupportreports

List the progress of Tech Support Report generation, beginning with the most current. If an appliance ID is not provided, Tech Support Reports for all appliances are returned.

Request
query Parameters
applianceId
integer <int64>

Appliance ID

cursor
string
Default: ""

String value pointing to the next page of results after the last request.

limit
integer <int32>
Default: 10

Limits the number of objects returned per page.

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

404

The appliance is not found.

Response samples
application/json
{
  • "totalCount": 0,
  • "next": "string",
  • "techsupportreports": [
    ]
}

Generate Tech Support Report

post/techsupportreports

Initiate Tech Support Report generation

Request
header Parameters
api-version
required
string

API Version

Value: "v1"
Request Body schema: application/json
applianceId
required
integer <int64>

Appliance ID

url
string

URL to use for locating the TSR

Responses
202

Accepted

400

Bad Request

401

Unauthorized

403

Forbidden

404

The appliance is not found.

409

Previous Tech Support Report generation is still in progress or provided URL is not unique

Request samples
application/json
{
  • "applianceId": 0,
  • "url": "string"
}
Response samples
application/json
{
  • "ID": 0,
  • "deviceId": 0,
  • "applianceId": 0,
  • "generationStatus": "string",
  • "url": "string"
}

Get status of Tech Support Report generation.

get/techsupportreports/{id}

Get current progress of Tech Support Report generation.

Request
path Parameters
id
required
integer <int64>

Tech Support Report ID

header Parameters
api-version
required
string

API Version

Value: "v1"
Responses
200

OK

400

Bad Request

401

Unauthorized

404

Tech Support Report not found

Response samples
application/json
{
  • "ID": 0,
  • "deviceId": 0,
  • "applianceId": 0,
  • "generationStatus": "string",
  • "url": "string"
}