Skip to main content
GET
/
api
/
v2
/
securitygroups
/
{securityGroupID}
Get security group
curl --request GET \
  --url https://region.nks.europe-west4.nscale.com/api/v2/securitygroups/{securityGroupID} \
  --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": "john.doe@acme.com",
    "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.nscale.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Operation requires OAuth 2.0 bearer token authentication.

Path Parameters

​
securityGroupID
string
required

The security group ID. A Kubernetes name. Must be a valid DNS containing only lower case characters, numbers or hyphens, start and end with a character or number, and be at most 63 characters in length.

Required string length: 1 - 63

Response

A security group.

A security group.

​
metadata
object
required

Metadata required by project scoped resource reads.

​
spec
object
required

A security group's specification.

​
status
object
required

Read only status information about a security group.