Get Service Label List (v2.0)

GET 
/v2.0/api/tenants/:tenant_id/servicelabels

List all the service labels.

Request

Path Parameters

tenant_id stringrequired

The ID of the tenant.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items ServiceLabel[]
Array [
description string
Description: Size(max = 256, error = DESCRIPTION_SIZE_EXCEEDED: Description size exceeded., min = 0) Valid
id string
Id
name stringrequired
Name: Required(error = SERVICELABEL_NAME_REQD: Service label name required.) Size(max = 128, error = SERVICELABEL_NAME_EXCEEDS_LIMIT: Service label name exceeds limit., min = 0) Valid
tags string[]
Tags: ListString(allowDuplicate = false, allowEmpty = true, allowNull = true, length = 128, listMaxSize = 10, error = INVALID_TAG: Maximum 10 Unique tags of length 1024 each are allowed, noTrim = false, regex = [^,\s]+, required = false)
type stringrequired
Possible values: [CG_TRANSIT, NON_CG_TRANSIT, SASE]
Type: ValidateEnum(enumClass = classOf[NetworkServiceType], message = Invalid enum string., nullAllowed = false)
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "description": "string",
      "id": "string",
      "name": "string",
      "tags": [
        "string"
      ],
      "type": "CG_TRANSIT"
    }
  ]
}

400

Bad Request

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": "INVALID_JSON"
      }
    ]
  }
}

Loading...