REST API - list
  1. Operations
  2. appliance
  3. support bundle

appliance support bundle: list

Get list of support-bundles generated. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/api/appliance/support-bundle

?size={42}
&available={true}
&creation_status={value}

Query Parameters:

Name Type Description
bold = required
size long Size specifies the maximum number of results to return. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset defaults to 50.
available boolean Filter only downloadable details. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

creation_status string Filter by task status. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional.

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "supportbundle_operations" : [
        {
            "downloadable" : true,
            "size" : 1,
            "expiration_time" : "2015-01-01T22:13:05.651Z",
            "description" : "string",
            "generation_time" : "2015-01-01T22:13:05.651Z",
            "failure_reason" : {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : {
                    "<string>" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : {
                                "<string>" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "url" : "http://myurl.com",
            "status" : "SUCCEEDED"
        },
        {
            "downloadable" : true,
            "size" : 1,
            "expiration_time" : "2015-01-01T22:13:05.651Z",
            "description" : "string",
            "generation_time" : "2015-01-01T22:13:05.651Z",
            "failure_reason" : {
                "args" : [
                    "string",
                    "string"
                ],
                "default_message" : "string",
                "localized" : "string",
                "id" : "string",
                "params" : {
                    "<string>" : {
                        "dt" : "2015-01-01T22:13:05.651Z",
                        "s" : "string",
                        "d" : 1.5,
                        "precision" : 1,
                        "format" : "SHORT_DATE",
                        "i" : 1,
                        "l" : {
                            "id" : "string",
                            "params" : {
                                "<string>" : {
                                    "dt" : "2015-01-01T22:13:05.651Z",
                                    "s" : "string",
                                    "d" : 1.5,
                                    "precision" : 1,
                                    "format" : "SHORT_DATE",
                                    "i" : 1,
                                    "l" : {
                                        "id" : "string",
                                        "params" : {}
                                    }
                                }
                            }
                        }
                    }
                }
            },
            "url" : "http://myurl.com",
            "status" : "SUCCEEDED"
        }
    ]
}

Headers:

None

Type:

Name Type Description
bold = required
- list_result List of support bundle details.
-.supportbundle_operations info[] Information about all support bundle requests. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.supportbundle_operations[].description string Support bundle creation description. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.supportbundle_operations[].status string Status of the task. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of:
SUCCEEDED: Support bundle creation task succeeded. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
FAILED: Support bundle creation task Failed. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
CANCELLED: Support bundle creation task Cancelled. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
-.supportbundle_operations[].generation_time date_time Support bundle generation time. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED.
-.supportbundle_operations[].url URI Support bundle downlooad URL. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED.
-.supportbundle_operations[].expiration_time date_time Download expiration time. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED.
-.supportbundle_operations[].downloadable boolean Support bundle availability for download. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED.
-.supportbundle_operations[].size long Support bundle file size in KBs. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value SUCCEEDED. This field is optional and it is only relevant when the value of status is SUCCEEDED.
-.supportbundle_operations[].failure_reason localizable_message Reason for failure. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. It is only relevant when status has value FAILED. This field is optional and it is only relevant when the value of status is FAILED.
-.supportbundle_operations[].failure_reason.id string Unique identifier of the localizable string or message template.

This identifier is typically used to retrieve a locale-specific string or message template from a message catalog.
-.supportbundle_operations[].failure_reason.default_message string The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog.
-.supportbundle_operations[].failure_reason.args string[] Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments.

Errors:

HTTP Status Code Type Description
500 error Generic error