List location groups

GET/v1/l2_segments/location_groups

To show a list of location groups, you can send a GET request to /v1/l2_segments/location_groups. If it is necessary, modify the command with query parameters.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

group_type?string

A group type specifies what type of L2 Segments will be displayed: public or private.

Value in

  • "public"
  • "private"
per_page?integer

The number of results [ 1 .. 100 ] displayed on a page. By default, 20 results are shown.

Range1 <= value <= 100
Default20
page?integer

The number of a page (>= 1) that will be returned. By default, it's 1.

Range1 <= value
Default1
sorting?string

This parameter sorts items. By default, it's id. Also, it's possible to sort by updated_at and created_at.

Default"id"

Value in

  • "id"
  • "name"
  • "group_type"
direction?string

This parameter defines if items are sorted in an ascending ASC or descending DESC order. By default, ASC is set up.

Default"ASC"

Value in

  • "ASC"
  • "DESC"

Response Body

application/json

curl -X GET "https://example.com/v1/l2_segments/location_groups"
[  {    "id": 76,    "name": "location2031",    "code": "location2031",    "group_type": "public",    "location_ids": [      982    ],    "location_codes": [      "location2029"    ],    "hyperscalers": [      "AWS",      "Azure",      "GCP"    ]  }]