SOsodafoundation
Masking views

GET /v1/storages/{storage_id}/port-groups

Changed on

List all port groups.

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

storage_idstring required

Database ID created for a storage backend.

Query parameters

limitinteger

Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.

offsetinteger

Used in conjunction with limit to return a slice of items. offset is where to start in the list.

sortstring
Example:sort=name:desc,id:asc

Comma-separated list of sort keys and optional sort directions in the form of key:val

namestring

The port group name

idstring

Database ID created for a port group.

descriptionstring

The port group description

native_port_group_idstring

Actual ID of the port group in the storage backend.

Response

List port groups query was success

Example response

{
  "port_groups": [
    {
      "id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
      "created_at": "2017-07-10T14:36:58.014Z",
      "updated_at": "2017-07-10T14:36:58.014Z",
      "storage_id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
      "native_port_group_id": "port_group_0"
    }
  ]
}

Changes