Skip to main content
PATCH
Update security group

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Path Parameters

project_id
integer
required

Project ID

Example:

1

region_id
integer
required

Region ID

Example:

1

group_id
string<uuid4>
required

Group ID

Example:

"024a29e9-b4b7-4c91-9a46-505be123d9f8"

Body

application/json
changed_rules
(CreateSecurityGroupRuleActionSerializer · object | DeleteSecurityGroupRuleSerializer · object)[]

List of rules to create or delete

Maximum array length: 500
name
string

Name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
Example:

"some_name"

tags
UpdateTagsSerializer · object | null

Update key-value tags using JSON Merge Patch semantics (RFC 7386). Provide key-value pairs to add or update tags. Set tag values to null to remove tags. Unspecified tags remain unchanged. Read-only tags are always preserved and cannot be modified.

Examples:

  • Add/update tags: {'tags': {'environment': 'production', 'team': 'backend'}} adds new tags or updates existing ones.
  • Delete tags: {'tags': {'old_tag': null}} removes specific tags.
  • Remove all tags: {'tags': null} removes all user-managed tags (read-only tags are preserved).
  • Partial update: {'tags': {'environment': 'staging'}} only updates specified tags.
  • Mixed operations: {'tags': {'environment': 'production', 'cost_center': 'engineering', 'deprecated_tag': null}} adds/updates 'environment' and 'cost_center' while removing 'deprecated_tag', preserving other existing tags.
  • Replace all: first delete existing tags with null values, then add new ones in the same request.
Example:

Response

200 - application/json

OK

created_at
string<date-time>
required

Datetime when the security group was created

Example:

"2019-06-18T11:56:16+0000"

description
string
required

Security group description

Example:

"Some description"

id
string<uuid4>
required

Security group ID

Example:

"00000000-0000-4000-8000-000000000000"

name
string
required

Security group name

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
Example:

"my_security_group"

project_id
integer
required

Project ID

Example:

1337

region
string
required

Region name

Example:

"Luxembourg 1"

region_id
integer
required

Region ID

Example:

7

revision_number
integer
required

The number of revisions

Example:

1

tags_v2
TagSerializer · object[]
required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Example:
updated_at
string<date-time>
required

Datetime when the security group was last updated

Example:

"2019-06-18T11:57:00+0000"

security_group_rules
SecurityGroupRuleSerializer · object[]

Security group rules