Get SD-WAN Applications with Release Information (v2.2)
GET/v2.2/api/tenants/:tenant_id/sdwanapps
List an existing tenant's SD-WAN applications with release information.
Request
Path Parameters
The tenant ID.
Responses
- 200
Successful Operation
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- Array [
- Array [
- ]
- ]
- ]
The total number.
The ID.
items SDWANAppRelease[]
The SD-WAN app ID.
The auth roles assigned to the SD-WAN app.
The default release of the app.
The description of the SD-WAN app. Max length = 256.
Indicates if the SD-WAN app is disabled.
The reason for the SD-WAN app to be disabled.
The ID.
Indicates if the SD-WAN app is inactive.
The reason for the SD-WAN app to be inactive.
The name of the SD-WAN app.
parameters SDWANAppParameter[]required
The app parameters.
The default value.
The display label of the SD-WAN app.
The help text in the app.
The SD-WAN app config key.
list_values SDWANAppParameterListValue[]
The SD-WAN app parameters list value response.
Display Label
Is Default
Value
The max length of the SD-WAN app parameters.
The max value of the SD-WAN app parameters.
The min value of the SD-WAN app parameters.
The regex values.
The SD-WAN app required parameters.
The SD-WAN app sensitive parameters.
Possible values: [INTEGER
, FLOAT
, STRING
, TEXT
, EMAIL
, LIST_INTEGER
, LIST_FLOAT
, LIST_STRING
, LIST_INTEGER_MULTI_SELECT
, LIST_FLOAT_MULTI_SELECT
, LIST_STRING_MULTI_SELECT
, BOOLEAN
]
The SD-WAN app parameters type.
The permissions of the SD-WAN app.
The region of the SD-WAN app.
The release date of the SD-WAN app.
The release notes of the SD-WAN app.
Possible values: [INIT
, ALPHA
, BETA
, GA
, DEPRECATED
, TO_BE_DELETED
]
The release state of the SD-WAN app.
A information field that can be added to identify the application. Maximum 10 unique tags of length 128 each are allowed.
The tenant ID.
The version of the SD-WAN app.
{
"count": 0,
"id": "string",
"items": [
{
"application_id": "string",
"auth_role": "string",
"default_release": true,
"disabled": true,
"disabled_reason": "string",
"id": "string",
"inactive": true,
"inactive_reason": "string",
"name": "string",
"parameters": [
{
"default_value": "string",
"display_label": "string",
"help_text": "string",
"key": "string",
"list_values": [
{
"display_label": "string",
"is_default": true,
"value": "string"
}
],
"max_length": 0,
"max_value": "string",
"min_value": "string",
"regex": "string",
"required": true,
"sensitive": true,
"type": "INTEGER"
}
],
"permissions": [
"string"
],
"region": "string",
"release_date": 0,
"release_notes": "string",
"state": "INIT",
"tags": [
"string"
],
"tenant_id": "string",
"version": "string"
}
]
}