List security groups

curl --request GET \
  --url https://api.example.com/api/v2/securitygroups \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "a64f9269-36e0-4312-b8d1-52d93d569b7b",
      "name": "undefined",
      "organizationId": "9a8c6370-4065-4d4a-9da0-7678df40cd9d",
      "projectId": "e36c058a-8eba-4f5b-91f4-f6ffb983795c",
      "creationTime": "2024-05-31T14:11:00Z",
      "createdBy": "[email protected]",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "rules": [
        {
          "direction": "ingress",
          "protocol": "tcp",
          "port": 80,
          "cidr": "172.16.0.0/12"
        }
      ]
    },
    "status": {
      "regionId": "ba39bff5-b0d8-4c60-89e5-ed1104356b4a",
      "networkId": "61f0ad85-3001-41cb-824a-e6a047668dfe"
    }
  }
]

GET

api

securitygroups

List security groups

curl --request GET \
  --url https://api.example.com/api/v2/securitygroups \
  --header 'Authorization: Bearer <token>'

[
  {
    "metadata": {
      "id": "a64f9269-36e0-4312-b8d1-52d93d569b7b",
      "name": "undefined",
      "organizationId": "9a8c6370-4065-4d4a-9da0-7678df40cd9d",
      "projectId": "e36c058a-8eba-4f5b-91f4-f6ffb983795c",
      "creationTime": "2024-05-31T14:11:00Z",
      "createdBy": "[email protected]",
      "provisioningStatus": "provisioned",
      "healthStatus": "healthy"
    },
    "spec": {
      "rules": [
        {
          "direction": "ingress",
          "protocol": "tcp",
          "port": 80,
          "cidr": "172.16.0.0/12"
        }
      ]
    },
    "status": {
      "regionId": "ba39bff5-b0d8-4c60-89e5-ed1104356b4a",
      "networkId": "61f0ad85-3001-41cb-824a-e6a047668dfe"
    }
  }
]

Authorizations

Authorization

string

header

required

Operation requires OAuth 2.0 bearer token authentication.

Query Parameters

tag

string[]

A set of tags to match against resources in the form "name=value", thus when encoded you get "?tag=foo%3Dcat&tag=bar%3Ddog".

organizationID

string[]

Allows resources to be filtered by organization.

projectID

string[]

Allows resources to be filtered by project.

regionID

string[]

Allows resources to be filtered by region.

networkID

string[]

Allows resources to be filtered by network.

Response

A list of security groups.

metadata

object

required

Metadata required by project scoped resource reads.

Show child attributes

metadata.name

string

required

A valid Kubernetes label value, typically used for resource names that can be indexed in the database.

metadata.id

string

required

The unique resource ID.

metadata.creationTime

string<date-time>

required

The time the resource was created.

metadata.provisioningStatus

enum<string>

required

The provisioning state of a resource.

Available options:

unknown,

provisioning,

provisioned,

deprovisioning,

error

metadata.healthStatus

enum<string>

required

The health state of a resource.

Available options:

unknown,

healthy,

degraded,

error

metadata.organizationId

string

required

The organization identifier the resource belongs to.

metadata.projectId

string

required

The project identifier the resource belongs to.

metadata.description

string

The resource description, this optionally augments the name with more context.

metadata.tags

object[]

A list of tags.

Show child attributes

metadata.tags.name

string

required

A unique tag name.

metadata.tags.value

string

required

The value of the tag.

metadata.createdBy

string

The user who created the resource.

metadata.modifiedTime

string<date-time>

The time a resource was updated.

metadata.modifiedBy

string

The user who updated the resource.

metadata.deletionTime

string<date-time>

The time the resource was deleted.

spec

object

required

A security group's specification.

Show child attributes

spec.rules

object[]

required

A set of security group rules to apply.

Show child attributes

spec.rules.direction

enum<string>

required

The direction of the rule.

Available options:

ingress,

egress

spec.rules.protocol

enum<string>

required

The layer 3+ protocol to allow.

Available options:

any,

icmp,

tcp,

udp,

vrrp

spec.rules.port

integer

Port number for layer 4 protocols, if not specified matches all ports.

Required range: 1 <= x <= 65535

spec.rules.portMax

integer

maxumum port number for layer 4 protocols to include a range.

Required range: 1 <= x <= 65535

spec.rules.prefix

string<ipv4>

An IPv4 address.

status

object

required

Read only status information about a security group.

Show child attributes

status.regionId

string

required

The region a security group belongs to.

status.networkId

string

required

The network a security group belongs to.

Delete network Create security group

⌘I

Serverless Inference

Fine Tuning

Compute

Networking and Storage

Organization

List security groups

Authorizations

Query Parameters

Response