Skip to main content
POST
Create a security group

Authorizations

Authorization
string
header
required

JWT token from authentication service

Headers

x-account-id
string

Account ID from authentication (must match path accountId)

x-user-id
string

User ID performing the action

X-Request-ID
string

Unique request ID for tracing

Path Parameters

accountId
string
required

Account external ID

Pattern: ^acct-[a-zA-Z0-9]+-v1$
projectId
string
required

Project external ID

Pattern: ^proj-[a-zA-Z0-9]+-v1$

Body

application/json
project_id
string
required

Project external ID

Example:

"proj-abc123xyz-v1"

name
string
required

Security group name

Required string length: 1 - 255
Example:

"web-servers-sg"

description
string

Optional description

Example:

"Security group for web server instances"

rules
object[]

Initial firewall rules

metadata
object

Optional metadata key-value pairs

Response

Security group created successfully

security_group
object
message
string
Example:

"Security group created successfully"