List security groups

GET

/api/v1/security-group

curl --request GET \
  --url https://console.cloudlogics.com/api/v1/security-group \
  --header 'Authorization: <Authorization>'

List security groups in the authenticated user’s project. Pass all_projects=true to list security groups across every project the caller belongs to; each entry is tagged with its project name.

Authorizations

• BearerAuth

Parameters

Query Parameters

all_projects

boolean

List security groups across all of the caller’s projects

Responses

200

The project’s security groups, each with its rule counts.

Media typeapplication/json

object

data

Array<object>

A group in the list view. Note the capitalised field names.

object

ID

string

Name

string

Description

string

Project

string

ingress_rules

Number of inbound rules.

integer

egress_rules

Number of outbound rules.

integer

Example

{
  "data": [
    {
      "ID": "8f14e45f-ceea-467a-9f2c-1b1d3a5e77c2",
      "Name": "web-servers",
      "Description": "Public web tier",
      "Project": "my-project",
      "ingress_rules": 3,
      "egress_rules": 0
    }
  ]
}

400

Missing project in context

Media typeapplication/json

object

data

error

object

code

integer

message

string

page

object

next

string

prev

string

total_size

integer

Example^generated

{
  "data": "example",
  "error": {
    "code": 1,
    "message": "example"
  },
  "page": {
    "next": "example",
    "prev": "example",
    "total_size": 1
  }
}

500

Internal server error

Media typeapplication/json

object

data

error

object

code

integer

message

string

page

object

next

string

prev

string

total_size

integer

Example^generated

{
  "data": "example",
  "error": {
    "code": 1,
    "message": "example"
  },
  "page": {
    "next": "example",
    "prev": "example",
    "total_size": 1
  }
}