Skip to main content

Update security group

PATCH 

https://api.katapult.io/core/v1/security_groups/security_group

Updates a security group with new properties

Scopes

  • security_groups

OAuth2 Scopes

When using OAuth2 authentication, scopes are prefixed with api.katapult.io/core/v1/.

Request

Body

    security_group

    object

    required

    id string

    properties

    object

    required

    name string
    allow_all_inbound boolean
    allow_all_outbound boolean
    associations string[]

    annotations

    object[]

  • Array [

  • key stringrequired
    value string
  • ]

Responses

Updates a security group with new properties

Schema

    security_group

    object

    required

    id string
    name string
    allow_all_inbound boolean
    allow_all_outbound boolean
    associations string[]

    annotations

    object[]

    required

  • Array [

  • key stringrequired
    value string
  • ]

curl -L -X PATCH 'https://api.katapult.io/core/v1/security_groups/security_group' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"security_group": {
"id": "string"
},
"properties": {
"name": "string",
"allow_all_inbound": true,
"allow_all_outbound": true,
"associations": [
"string"
]
},
"annotations": [
{
"key": "string",
"value": "string"
}
]
}'
Request Collapse all
Base URL
https://api.katapult.io/core/v1
Auth
Body
{
  "security_group": {
    "id": "string"
  },
  "properties": {
    "name": "string",
    "allow_all_inbound": true,
    "allow_all_outbound": true,
    "associations": [
      "string"
    ]
  },
  "annotations": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
ResponseClear

Click the Send API Request button above and see the response here!