Export Bringup Detail Report

Export Bringup Detail Report

Returns the bringup report. Reports are generated in PDF and CSV formats.

Request
URI
GET
https://{api_host}/v1/sddcs/{id}/detail-report
COPY
Path Parameters
string
id
Required

SDDC ID

id example
123e4567-e89b-42d3-a456-556642440000
Query Parameters
string
format
Optional
Constraints: default: pdf

One among: PDF, CSV

Possible values are : pdf, csv,

Responses
200

OK

Operation doesn't return any data structure

500

Internal Server Error

Returns Error of type(s) application/json
{
    "errorCode": "string",
    "errorType": "string",
    "arguments": [
        "string"
    ],
    "context": {
        "context": "string"
    },
    "message": "string",
    "remediationMessage": "string",
    "causes": [
        {
            "type": "string",
            "message": "string"
        }
    ],
    "nestedErrors": [
        "Error Object"
    ],
    "referenceToken": "string"
}
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/sddcs/{id}/detail-report