Security Groups

Download schema

A security group is a set of firewall rules on a set of Instances. Security groups enable you to create rules that either drop or allow incoming traffic from certain ports of your Instances.

Security groups are stateful by default, which means that return traffic is automatically allowed, regardless of any rules. You can switch to a stateless mode if you want to only allow explicitly defined traffic. That mode may be difficult to use when filtering outgoing flows.

Set all rules of a security group

PUT

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-group-rules

Replace all rules of a specified security group with the provided rules.

Set all rules of a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Set all rules of a security group › Request Body

security_group_id

string

ID of the security group to set rules for.

scaleway.instance.v2alpha1.SecurityGroupRuleConfig[]

List of rules to set.

Set all rules of a security group › Responses

200

scaleway.instance.v2alpha1.SecurityGroup

id

string

Unique ID of the security group.

srn

string

The SRN of the security group.

name

string

Name of the security group.

description

string

Description of the security group.

project_id

string

Project ID the security group belongs to.

tags

string[]

Tags associated with the security group.

disable_default_rules

boolean

True if default rules are disabled.

project_default

boolean

True if this is the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean

True if the security group is stateless.

created_at

string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of default rules applied to the security group.

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of custom rules applied to the security group.

zone

string

Zone in which the security group is located.

PUT/instance/v2alpha1/zones/{zone}/security-group-rules

curl -X PUT \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"security_group_id":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-group-rules"

Example Request Body

{
  "security_group_id": "security_group_id",
  "security_group_rules": [
    {
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ]
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "description": "description",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "disable_default_rules": true,
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "default_rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "zone": "zone"
}

json

application/json

Add rules to a security group

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-group-rules

Add one or more rules to a security group.

Add rules to a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Add rules to a security group › Request Body

security_group_id

string

ID of the security group to add rules to.

scaleway.instance.v2alpha1.SecurityGroupRuleConfig[]

List of rules to add.

Add rules to a security group › Responses

200

scaleway.instance.v2alpha1.AddSecurityGroupRulesResponse

scaleway.instance.v2alpha1.SecurityGroup

Updated security group.

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of rules that were added.

POST/instance/v2alpha1/zones/{zone}/security-group-rules

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"security_group_id":"string"}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-group-rules"

Example Request Body

{
  "security_group_id": "security_group_id",
  "security_group_rules": [
    {
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ]
}

json

Example Responses

{
  "security_group": {
    "id": "id",
    "srn": "srn",
    "name": "name",
    "description": "description",
    "project_id": "project_id",
    "tags": [
      "string"
    ],
    "disable_default_rules": true,
    "project_default": true,
    "inbound_default_action": "unknown_action",
    "outbound_default_action": "unknown_action",
    "stateless": true,
    "created_at": "2022-03-22T12:34:56.123456Z",
    "updated_at": "2022-03-22T12:34:56.123456Z",
    "default_rules": [
      {
        "id": "id",
        "protocol": "unknown_protocol",
        "direction": "unknown_direction",
        "action": "unknown_action",
        "source_ip_range": "1.2.3.4/32",
        "destination_ip_range": "1.2.3.4/32",
        "source_ports": {
          "start": 0,
          "end": 0
        },
        "destination_ports": {
          "start": 0,
          "end": 0
        },
        "position": 0
      }
    ],
    "rules": [
      {
        "id": "id",
        "protocol": "unknown_protocol",
        "direction": "unknown_direction",
        "action": "unknown_action",
        "source_ip_range": "1.2.3.4/32",
        "destination_ip_range": "1.2.3.4/32",
        "source_ports": {
          "start": 0,
          "end": 0
        },
        "destination_ports": {
          "start": 0,
          "end": 0
        },
        "position": 0
      }
    ],
    "zone": "zone"
  },
  "added_rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ]
}

json

application/json

Delete rules from a security group

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-group-rules

Delete specified security groups.

Delete rules from a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Delete rules from a security group › Request Body

security_group_rule_ids

string[]

List of rule IDs to delete.

Delete rules from a security group › Responses

No data returned

Update a security group rule

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-group-rules/{security_group_rule_id}

Update the properties of a rule from a specified security group.

Update a security group rule › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

security_group_rule_id

string · required

ID of the rule to update.

Update a security group rule › Request Body

protocol

scaleway.instance.v2alpha1.SecurityGroupRule.Protocol · enum

New protocol for the rule.

Enum values:

unknown_protocol

tcp

udp

icmp

any

Default: unknown_protocol

direction

scaleway.instance.v2alpha1.SecurityGroupRule.Direction · enum

New direction for the rule.

Enum values:

unknown_direction

inbound

outbound

both

Default: unknown_direction

action

scaleway.instance.v2alpha1.SecurityGroupRule.Action · enum

New action for the rule.

Enum values:

unknown_action

drop

Default: unknown_action

source_ip_range

string | null

New source IP range for the rule. (IP network)

destination_ip_range

string | null

New destination IP range for the rule. (IP network)

scaleway.instance.v2alpha1.SecurityGroupRule.PortRange

New source port range for the rule.

scaleway.instance.v2alpha1.SecurityGroupRule.PortRange

New destination port range for the rule.

position

integer | null · int32

New position for the rule.

Update a security group rule › Responses

200

scaleway.instance.v2alpha1.SecurityGroup

id

string

Unique ID of the security group.

srn

string

The SRN of the security group.

name

string

Name of the security group.

description

string

Description of the security group.

project_id

string

Project ID the security group belongs to.

tags

string[]

Tags associated with the security group.

disable_default_rules

boolean

True if default rules are disabled.

project_default

boolean

True if this is the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean

True if the security group is stateless.

created_at

string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of default rules applied to the security group.

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of custom rules applied to the security group.

zone

string

Zone in which the security group is located.

PATCH/instance/v2alpha1/zones/{zone}/security-group-rules/{security_group_rule_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-group-rules/{security_group_rule_id}"

Example Request Body

{
  "protocol": "unknown_protocol",
  "direction": "unknown_direction",
  "action": "unknown_action",
  "source_ip_range": "1.2.3.4/32",
  "destination_ip_range": "1.2.3.4/32",
  "source_ports": {
    "start": 0,
    "end": 0
  },
  "destination_ports": {
    "start": 0,
    "end": 0
  },
  "position": 0
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "description": "description",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "disable_default_rules": true,
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "default_rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "zone": "zone"
}

json

application/json

List security groups

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-groups

List all security groups.

List security groups › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

List security groups › query Parameters

project_id

string · required

Filter by Project ID.

page_token

string

Token for pagination.

page_size

integer · uint32

Number of items to return per page.

order_by

scaleway.instance.v2alpha1.ListSecurityGroupsRequest.OrderBy · enum

Field and direction to sort by.

Enum values:

created_at_desc

created_at_asc

updated_at_desc

updated_at_asc

Default: created_at_desc

name

string

Filter by name.

tags

string[]

Filter by tags.

security_group_ids

string[]

Filter by specific security group IDs.

List security groups › Responses

200

scaleway.instance.v2alpha1.ListSecurityGroupsResponse

scaleway.instance.v2alpha1.SecurityGroupSummary[]

List of security groups.

next_page_token

string | null

Token for the next page.

total_count

integer · uint64

Total number of items.

GET/instance/v2alpha1/zones/{zone}/security-groups

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-groups?project_id=string"

Example Responses

{
  "security_groups": [
    {
      "id": "id",
      "srn": "srn",
      "name": "name",
      "description": "description",
      "project_id": "project_id",
      "tags": [
        "string"
      ],
      "disable_default_rules": true,
      "project_default": true,
      "inbound_default_action": "unknown_action",
      "outbound_default_action": "unknown_action",
      "stateless": true,
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "zone": "zone"
    }
  ],
  "next_page_token": "next_page_token",
  "total_count": 0
}

json

application/json

Create a security group

POST

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-groups

Create a security group with a specified name and description.

Create a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

Create a security group › Request Body

name

string

Name of the security group.

description

string

Description of the security group.

disable_default_rules

boolean

Whether to disable default rules.

project_id

string

Project ID the security group belongs to.

tags

string[]

Tags for the security group.

project_default

boolean

Whether this should be the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean

Whether the security group should be stateless.

Create a security group › Responses

200

scaleway.instance.v2alpha1.SecurityGroup

id

string

Unique ID of the security group.

srn

string

The SRN of the security group.

name

string

Name of the security group.

description

string

Description of the security group.

project_id

string

Project ID the security group belongs to.

tags

string[]

Tags associated with the security group.

disable_default_rules

boolean

True if default rules are disabled.

project_default

boolean

True if this is the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean

True if the security group is stateless.

created_at

string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of default rules applied to the security group.

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of custom rules applied to the security group.

zone

string

Zone in which the security group is located.

POST/instance/v2alpha1/zones/{zone}/security-groups

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "description": "string",
    "disable_default_rules": false,
    "name": "string",
    "project_default": false,
    "project_id": "string",
    "stateless": false
  }' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-groups"

Example Request Body

{
  "name": "name",
  "description": "description",
  "disable_default_rules": true,
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "description": "description",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "disable_default_rules": true,
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "default_rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "zone": "zone"
}

json

application/json

Get a security group

GET

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}

Get the details of a specified security group.

Get a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

security_group_id

string · required

ID of the security group to retrieve.

Get a security group › Responses

200

scaleway.instance.v2alpha1.SecurityGroup

id

string

Unique ID of the security group.

srn

string

The SRN of the security group.

name

string

Name of the security group.

description

string

Description of the security group.

project_id

string

Project ID the security group belongs to.

tags

string[]

Tags associated with the security group.

disable_default_rules

boolean

True if default rules are disabled.

project_default

boolean

True if this is the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean

True if the security group is stateless.

created_at

string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of default rules applied to the security group.

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of custom rules applied to the security group.

zone

string

Zone in which the security group is located.

GET/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}"

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "description": "description",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "disable_default_rules": true,
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "default_rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "zone": "zone"
}

json

application/json

Delete a security group

DELETE

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}

Delete a specified security group.

Delete a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

security_group_id

string · required

ID of the security group to delete.

Delete a security group › Responses

No data returned

Update a security group

PATCH

https://api.scaleway.com

/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}

Update the properties of a security group.

Update a security group › path Parameters

zone

string · enum · required

The zone you want to target

Enum values:

fr-par-1

fr-par-2

fr-par-3

nl-ams-1

nl-ams-2

nl-ams-3

pl-waw-1

pl-waw-2

security_group_id

string · required

ID of the security group to update.

Update a security group › Request Body

name

string | null

New name for the security group.

description

string | null

New description for the security group.

disable_default_rules

boolean | null

Whether to disable default rules.

tags

array | null

New tags for the security group.

project_default

boolean | null

Whether this should be the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

New default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

New default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean | null

Whether the security group should be stateless.

Update a security group › Responses

200

scaleway.instance.v2alpha1.SecurityGroup

id

string

Unique ID of the security group.

srn

string

The SRN of the security group.

name

string

Name of the security group.

description

string

Description of the security group.

project_id

string

Project ID the security group belongs to.

tags

string[]

Tags associated with the security group.

disable_default_rules

boolean

True if default rules are disabled.

project_default

boolean

True if this is the default security group for the project.

inbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for inbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

outbound_default_action

scaleway.instance.v2alpha1.SecurityGroup.Action · enum

Default action for outbound rules.

Enum values:

unknown_action

drop

Default: unknown_action

stateless

boolean

True if the security group is stateless.

created_at

string | null · date-time

Creation timestamp of the security group. (RFC 3339 format)

updated_at

string | null · date-time

Last update timestamp of the security group. (RFC 3339 format)

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of default rules applied to the security group.

scaleway.instance.v2alpha1.SecurityGroupRule[]

List of custom rules applied to the security group.

zone

string

Zone in which the security group is located.

PATCH/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/instance/v2alpha1/zones/{zone}/security-groups/{security_group_id}"

Example Request Body

{
  "name": "name",
  "description": "description",
  "disable_default_rules": true,
  "tags": [],
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true
}

json

Example Responses

{
  "id": "id",
  "srn": "srn",
  "name": "name",
  "description": "description",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "disable_default_rules": true,
  "project_default": true,
  "inbound_default_action": "unknown_action",
  "outbound_default_action": "unknown_action",
  "stateless": true,
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "default_rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "rules": [
    {
      "id": "id",
      "protocol": "unknown_protocol",
      "direction": "unknown_direction",
      "action": "unknown_action",
      "source_ip_range": "1.2.3.4/32",
      "destination_ip_range": "1.2.3.4/32",
      "source_ports": {
        "start": 0,
        "end": 0
      },
      "destination_ports": {
        "start": 0,
        "end": 0
      },
      "position": 0
    }
  ],
  "zone": "zone"
}

json

application/json

Placement Groups User Data