Skip to main content
POST
/
api
/
v2
/
securitygroups
Create security group
curl --request POST \
  --url https://region.nks.europe-west4.nscale.com/api/v2/securitygroups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "metadata": {
    "name": "security-group-name",
    "description": "A verbose description",
    "tags": [
      {
        "name": "cluster-id",
        "value": "9361402c-f998-49cc-ab21-9bb99afcfde8"
      }
    ]
  },
  "spec": {
    "networkId": "61f0ad85-3001-41cb-824a-e6a047668dfe",
    "rules": [
      {
        "direction": "ingress",
        "protocol": "tcp",
        "port": 80,
        "cidr": "172.16.0.0/12"
      }
    ]
  }
}
'
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Operation requires OAuth 2.0 bearer token authentication.

Body

application/json

A request for a security group.

A security group request.

​
metadata
object
required

Metadata required for all API resource reads and writes.

​
spec
object
required

A security group's specification.

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.