Update Security Group
Update a security group
Update a security group.
Request
URI
PATCH
https://api.example.local/v3/security_groups/{guid}
COPY
Path Parameters
string
guid
Required
The unique identifier for the resource
Request Body
SecurityGroupUpdate
of type(s)
application/json
Optional
{
"name": "string",
"globally_enabled": {
"running": false,
"staging": false
},
"rules": [
{
"protocol": "string",
"destination": "string",
"ports": "string",
"type": 0,
"code": 0,
"description": "string"
}
],
"metadata": {
"labels": {
"labels": "string"
},
"annotations": {
"annotations": "string"
}
}
}
string
name
Optional
Name of the security group
object
globally_enabled
Optional
globally_enabled
array of
object
rules
Optional
Rules for the security group
object
metadata
Optional
Metadata is a JSON object that contains information about a resource. It includes the GUID of the resource, the time the resource was created, the time the resource was last updated, and links to the resource. Metadata is included in the response body of a request to retrieve a resource.
Responses
200
OK
Returns
SecurityGroup
of type(s)
application/json
This response body class contains all of the following:
BaseSchema
{
"guid": "string",
"created_at": "string",
"updated_at": "string",
"name": "string",
"globally_enabled": {
"running": false,
"staging": false
},
"rules": [
{
"protocol": "string",
"destination": "string",
"ports": "string",
"type": 0,
"code": 0,
"description": "string"
}
],
"running_spaces": {
"data": [
{
"guid": "string"
}
]
},
"staging_spaces": {
"data": [
{
"guid": "string"
}
]
},
"links": {
"self": {
"href": "string",
"method": "string"
},
"running_spaces": {
"href": "string",
"method": "string"
},
"staging_spaces": {
"href": "string",
"method": "string"
}
},
"metadata": {
"labels": {
"labels": "string"
},
"annotations": {
"annotations": "string"
}
}
}
400
Bad Request
Returns
BadRequest
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
401
Unauthorized
Returns
Unauthorized
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
403
Forbidden
Returns
Forbidden
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
404
Not Found
Returns
NotFound
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
409
Conflict
Returns
Conflict
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
422
Unprocessable Entity
Returns
UnprocessableEntity
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
500
Internal Server Error
Returns
500
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
503
Service Unavailable
Returns
ServiceUnavailable
of type(s)
application/json
{
"errors": [
{
"code": 0,
"detail": "string",
"title": "string"
}
]
}
array of
object
errors
Optional
errors
Code Samples
COPY
curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Security Groups Operations
GET
List Security Groups
POST
Create Security Group
GET
Get Security Group
PATCH
Update Security Group
DELETE
Delete Security Group
POST
Bind Running Security Group
DELETE
Unbind Running Security Group
POST
Bind Staging Security Group
DELETE
Unbind Staging Security Group