Get SD-WAN Application with Release Information (v2.2)

GET 
/sdwan/v2.2/api/sdwanapps/:app_id

List an existing tenant's SD-WAN application with release information.

Request

Path Parameters

app_id stringrequired

The SD-WAN tenant's app ID.

Responses

200

Successful Operation

application/json

Schema

Schema

author Author

Details of the SD-WAN app owner.

email stringrequired

The email address of the SD-WAN app author.

name stringrequired

The name of the SD-WAN app author.

description

The description of the SD-WAN app. Max length = 256.

id string

The SD-WAN app ID.

name string

The name of the SD-WAN app.

releases SDWANAppReleaseInfoV2N2[]
The release information of the SD-WAN apps.
Array [
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.
name string
The name of the SD-WAN app.
parameters SDWANAppParameterResponse[]
The app parameters.
Array [
default_value object
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 ParameterListValueResponse[]
The SD-WAN app parameters list value response.
Array [
display_label string
The display label of the SD-WAN app.
is_default boolean
The default parameters.
value object
The value of the parameters.
]
max_length integer
The max length of the SD-WAN app parameters.
max_value object
The max value of the SD-WAN app parameters.
min_value object
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.
release_date int64
The release date of the SD-WAN app.
release_notes string
The release notes of the SD-WAN app.
state string
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.
version string
The version 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.

Example (from schema)

{
  "author": {
    "email": "string",
    "name": "string"
  },
  "id": "string",
  "name": "string",
  "releases": [
    {
      "auth_role": "string",
      "default_release": true,
      "name": "string",
      "parameters": [
        {
          "default_value": {},
          "display_label": "string",
          "help_text": "string",
          "key": "string",
          "list_values": [
            {
              "display_label": "string",
              "is_default": true,
              "value": {}
            }
          ],
          "max_length": 0,
          "max_value": {},
          "min_value": {},
          "regex": "string",
          "required": true,
          "sensitive": true,
          "type": "INTEGER"
        }
      ],
      "permissions": [
        "string"
      ],
      "release_date": 0,
      "release_notes": "string",
      "state": "INIT",
      "tags": [
        "string"
      ],
      "version": "string"
    }
  ],
  "tags": [
    "string"
  ]
}

Loading...