Networking

Preview — pending review

This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.

Create a security group

POST
/scopes/{scopeId}/network/security-groups

Provisions a new security group in the active scope from the security group creation form submission (entered via the list view's "Add" / "Create security group" button). Visible inputs are the group name, an optional description, a set of common-service ingress presets (SSH and HTTPS pre-selected; HTTP, MySQL, PostgreSQL, RDP and DNS available), zero or more custom rule rows (direction, protocol, port, source CIDR) and cost tags. Each selected preset is expanded server-side into a concrete ingress rule (e.g. SSH → tcp 22/22 from 0.0.0.0/0); a default allow-all egress rule is attached. On acceptance the group becomes discoverable in the scoped list with attachedPorts: 0. Validation: name must match ^[a-z0-9-]{1,63}$ (lowercase letters, numbers, hyphens) → 422 VALIDATION_FAILED on format violation, 409 CONFLICT on duplicate name in the project; every commonServices entry must be a known preset label → 422; each custom rule row needs a valid protocol and, for tcp/udp, a parsable port → 422; source must be valid CIDR notation → 422; the per-subscription security-group quota must not be exhausted → 409 QUOTA_EXCEEDED. Async & state: Asynchronous — returns 202 with an Operation handle. The group is created in a provisioning state and reaches the terminal state ACTIVE; resource.updated SSE frames are emitted for the security-group resource (rule materialization patches) plus operation.updated frames for the returned operation. Errors: 401 unauthenticated; 403 caller lacks contributor rights on the scope; 409 QUOTA_EXCEEDED when the security-group quota is exhausted (duplicate name → 409 CONFLICT); 422 on any field validation failure; 500 on provisioning workflow errors. Idempotency/Concurrency: Idempotency-Key is required; replaying the same key returns the original 202 Operation without creating a duplicate group.

Authorization

bearerToken
headerAuthorizationBearer <token>

An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.

Path Parameters

scopeId*string

Opaque ownership+authorization scope resolving to tenant + subscription + project.

Header Parameters

Idempotency-Key*string

Required: this operation creates a new resource asynchronously, so a retry without the key would create a second one. Same key+body within 24h replays the original result; the same key with a different body is 409 CONFLICT. Keys are unique per tenant (the same key in two tenants is two different requests). An API token or service-account (bearer) caller MUST send it -- a request without it is refused with 400 IDEMPOTENCY_KEY_REQUIRED (ErrIdempotencyKeyRequired); reuse the same key on every retry of one logical request. A console session gets one from the edge.

Formatuuid

Request Body

application/json
  1. body

Payload of the security group creation form submission.

name*string

Group name; lowercase letters, numbers and hyphens, up to 63 chars (e.g. web-sg).

Match^[a-z0-9-]{1,63}$
description?string

Optional free-text description (e.g. "Public web tier").

Lengthlength <= 255
commonServices?array<>

Selected common-service preset labels, each expanded into a concrete ingress rule (defaults in the UI are SSH and HTTPS).

rules?array<>

Custom rule rows defined inline in the create form.

tags?array<>

Key-value pairs used in Cost Explorer and budgets.

Itemsitems <= 50

Response Body

Creation accepted; the security group is provisioning. Track via the returned operation and resource.updated SSE frames.

application/json
  1. response

A long-running operation record. GET /operations/{operationId} returns its current state.

id*string

Operation identifier, unique platform-wide.

action*string

Canonical action id that started this operation, e.g. compute.instance.create.

state*OperationState

State machine for long-running operations. PENDING and RUNNING are transitional; the rest are terminal.

Value in"PENDING""RUNNING""SUCCEEDED""FAILED""CANCELLED"
resourceKind?|

Kind of the target resource (matches RealtimeEvent.kind), null for resource-less actions.

resourceId?|

Identifier of the target resource; null until the resource is allocated.

resourceName?|

Human-readable name of the target resource captured when the operation was opened; null when unknown or the resource has been deleted (clients fall back to resourceId).

principalId?|

Subject id (user id/email or service-account id) of the actor that initiated this operation, captured at the create chokepoint; null on internal/worker paths with no request-scoped principal or for historical rows. This is the real actor the Activity feed renders.

sourceIp?|

Source IP address of the request that initiated this operation; null when unavailable (internal/worker paths, historical rows).

progressPercent?|

Best-effort progress; null when the action does not report progress.

Range0 <= value <= 100
error?|null

Populated only when state is FAILED (or CANCELLED with partial rollback notes).

warning?|null

Non-fatal degradation recorded on an operation that still SUCCEEDED - the primary action completed but something explicitly requested could not be delivered (e.g. publicIp was requested at instance create but no floating IP could be assigned). On a CANCELLED create it reports that the provider resource had already been created and was kept (live and billed until deleted; details.disposition = left_in_place). Same code+message shape as error so clients render both uniformly; null when the operation ran without degradation.

startedAt?|

When the worker began executing; null while PENDING.

finishedAt?|

When a terminal state was reached; null while transitional.

createdAt*string
updatedAt*string
curl -X POST "https://example.com/scopes/string/network/security-groups" \  -H "Idempotency-Key: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "id": "string",  "action": "string",  "state": "PENDING",  "resourceKind": "string",  "resourceId": "string",  "resourceName": "string",  "principalId": "string",  "sourceIp": "string",  "progressPercent": 0,  "error": {    "code": "string",    "message": "string",    "field": "string",    "details": {},    "retryable": false  },  "warning": {    "code": "string",    "message": "string",    "field": "string",    "details": {},    "retryable": false  },  "startedAt": "string",  "finishedAt": "string",  "createdAt": "string",  "updatedAt": "string"}