Update security group

PATCH

/api/v1/security-group/{id}

curl --request PATCH \
  --url https://console.cloudlogics.com/api/v1/security-group/8f14e45f-ceea-467a-9f2c-1b1d3a5e77c2 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "name": "example" }'

Update a security group’s name and/or description. At least one field must be supplied; an omitted field is left unchanged. Members may update only security groups they own (created); project owners/admins and system admins may update any security group in the project. Platform-managed groups (“default” and the project’s own “_security_group”) cannot be renamed, and a rename cannot collide with another security group’s existing name in the project.

Authorizations

• BearerAuth

Parameters

Path Parameters

id

required

string

Security group ID

Request Body

Fields to update

Media typeapplication/json

object

description

string

name

string

Example^generated

{
  "description": "example",
  "name": "example"
}

Responses

200

Updated security group details

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

400

Invalid request, or no fields supplied

Media typeapplication/json

object

data

error

object

code

integer

message

string

page

object

next

string

prev

string

total_size

integer

Example^generated

{
  "data": "example",
  "error": {
    "code": 1,
    "message": "example"
  },
  "page": {
    "next": "example",
    "prev": "example",
    "total_size": 1
  }
}

403

Not permitted to manage this security group, or it is platform-managed

Media typeapplication/json

object

data

error

object

code

integer

message

string

page

object

next

string

prev

string

total_size

integer

Example^generated

{
  "data": "example",
  "error": {
    "code": 1,
    "message": "example"
  },
  "page": {
    "next": "example",
    "prev": "example",
    "total_size": 1
  }
}

409

Requested name already used by another security group in this project

Media typeapplication/json

object

data

error

object

code

integer

message

string

page

object

next

string

prev

string

total_size

integer

Example^generated

{
  "data": "example",
  "error": {
    "code": 1,
    "message": "example"
  },
  "page": {
    "next": "example",
    "prev": "example",
    "total_size": 1
  }
}

500

Internal server error

Media typeapplication/json

object

data

error

object

code

integer

message

string

page

object

next

string

prev

string

total_size

integer

Example^generated

{
  "data": "example",
  "error": {
    "code": 1,
    "message": "example"
  },
  "page": {
    "next": "example",
    "prev": "example",
    "total_size": 1
  }
}