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

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The total number.

id string

The ID.

type string

The type.

items SDWANAppRelease[]
Array [
application_id string
The SD-WAN app ID.
auth_role string
The auth roles assigned to the SD-WAN app.
default_release boolean
The default release of the app.
description
The description of the SD-WAN app. Max length = 256.
disabled boolean
Indicates if the SD-WAN app is disabled.
disabled_reason string
The reason for the SD-WAN app to be disabled.
id string
The ID.
inactive boolean
Indicates if the SD-WAN app is inactive.
inactive_reason string
The reason for the SD-WAN app to be inactive.
name stringrequired
The name of the SD-WAN app.
parameters SDWANAppParameter[]required
The app parameters.
Array [
default_value string
The default value.
display_label string
The display label of the SD-WAN app.
help_text string
The help text in the app.
key stringrequired
The SD-WAN app config key.
list_values SDWANAppParameterListValue[]
The SD-WAN app parameters list value response.
Array [
display_label string
Display Label
is_default boolean
Is Default
value string
Value
]
max_length integer
The max length of the SD-WAN app parameters.
max_value string
The max value of the SD-WAN app parameters.
min_value string
The min value of the SD-WAN app parameters.
regex string
The regex values.
required boolean
The SD-WAN app required parameters.
sensitive boolean
The SD-WAN app sensitive parameters.
type stringrequired
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.
]
permissions string[]
The permissions of the SD-WAN app.
region string
The region of the SD-WAN app.
release_date int64
The release date of the SD-WAN app.
release_notes string
The release notes of the SD-WAN app.
state stringrequired
Possible values: [INIT, ALPHA, BETA, GA, DEPRECATED, TO_BE_DELETED]
The release state of the SD-WAN app.
tags string[]
A information field that can be added to identify the application. Maximum 10 unique tags of length 128 each are allowed.
tenant_id stringrequired
The tenant ID.
version stringrequired
The version of the SD-WAN app.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "type": "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"
    }
  ]
}

Loading...