Get MSTP Instance (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/sites/:site_id/elements/:element_id/mstp_instances/:mstp_instance_id

List a MSTP instance for an element.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

The site ID.

element_id stringrequired

The element ID.

mstp_instance_id stringrequired

The MSTP instance ID.

Responses

200

Successful Operation

application/json

Schema

Schema

description

The MSTP instance description. Max limit = 256.

id string

The MSTP instance ID.

instance_number int32

The MSTP instance number. Valid values are 0-255.

instance_priority integer

The MSTP instance priority. Valid values are 0-15.

name stringrequired

The name of the MSTP instance. Max limit = 128.

tags string[]

A information field that can be added to identify the MSTP instance. Maximum 10 unique tags of length 128 each are allowed.

Example (from schema)

{
  "id": "string",
  "instance_number": 0,
  "instance_priority": 0,
  "name": "string",
  "tags": [
    "string"
  ]
}

404

Not Found

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "MSTP_INSTANCE_NOT_FOUND"
      }
    ]
  }
}

Loading...