This is the multi-page printable view of this section. Click here to print.

Return to the regular view of this page.

Firewall

Overview

Provides an Application Programming Interface (API) that supports programmatic use of IaaS/PaaS products provided by SCP. This guide provides a brief description of Firewall service and how to call API. The API is provided as a RESTful API, and it responds in JSON format.

Version

Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.

VersionStatusNot Before
1.1CURRENT-
1.0SUPPORTED20270131

OpenAPI URL

https://firewall.{region}.{environment}.samsungsdscloud.com

Environment and Region List

environmentregion
skr-west1
skr-east1
gkr-south1
gkr-south2
gkr-south3
ekr-west1
ekr-east1

API Version History

1.1

Firewall API version 1.1 has been released.

Changes

  • [Changed] GET /v1/firewalls - List Firewalls API has been changed.
    • Response model has been changed to FirewallListResponseV1Dot1.
      • The following fields have been added to the response.
        • zone_resources
      • The following fields have been removed from the response.
        • fw_resource_id
  • [Changed] GET /v1/firewalls/{firewall_id} - Show Firewall API has been changed.
    • Response model has been changed to FirewallShowResponseV1Dot1.
      • The following fields have been added to the response.
        • zone_resources
      • The following fields have been removed from the response.
        • fw_resource_id
  • [Changed] PUT /v1/firewalls/{firewall_id} - Set Firewall API has been changed.
    • Response model has been changed to FirewallShowResponseV1Dot1.
      • The following fields have been added to the response.
        • zone_resources
      • The following fields have been removed from the response.
        • fw_resource_id
  • [Changed] GET /v1/firewalls/rules - List Firewall Rules API has been changed.
    • The following query parameter has been removed from the request.
      • fetch_all
    • Response model has been changed to FirewallRuleListResponseV1Dot1.
      • The following fields have been removed from the response.
        • destination_interface, name, source_interface, vendor_rule_id
  • [Changed] GET /v1/firewalls/rules/{firewall_rule_id} - Show Firewall Rule API has been changed.
    • Response model has been changed to FirewallRuleShowResponseV1Dot1.
      • The following fields have been removed from the response.
        • destination_interface, name, source_interface, vendor_rule_id
  • [Changed] POST /v1/firewalls/rules - Create Firewall Rule API has been changed.
    • Changed to asynchronous processing.
    • Response code has been changed from 201 Created to 202 Accepted, and response body is not returned.
    • Request model has been changed to FirewallRuleCreateSingleRequest.
      • The following fields have been removed from the request.
        • destination_interface, name, source_interface
  • [Changed] PUT /v1/firewalls/rules/{firewall_rule_id} - Set Firewall Rule API has been changed.
    • Changed to asynchronous processing.
    • Response code has been changed from 200 OK to 202 Accepted, and response body is not returned.
    • Request model has been changed to FirewallRuleUpdateSingleRequest.
      • The following fields have been added to the request.
        • order_direction, order_rule_id, status
  • [Changed] DELETE /v1/firewalls/rules/{firewall_rule_id} - Delete Firewall Rule API has been changed.
    • Changed to asynchronous processing.
    • Response code has been changed from 204 No Content to 202 Accepted.

1.0

Firewall API has been released.

Changes

  • [New] GET /v1/firewalls - API has been added.
  • [New] GET /v1/firewalls/{firewall_id} - API has been added.
  • [New] PUT /v1/firewalls/{firewall_id} - API has been added.
  • [New] GET /v1/firewalls/rules - API has been added.
  • [New] POST /v1/firewalls/rules - API has been added.
  • [New] GET /v1/firewalls/rules/{firewall_rule_id} - API has been added.
  • [New] PUT /v1/firewalls/rules/{firewall_rule_id} - API has been added.
  • [New] DELETE /v1/firewalls/rules/{firewall_rule_id} - API has been added.

1 - APIs

1.1 - Create Firewall Rule

1.1.1 - 1.1

post /v1/firewalls/rules

Description

Create firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
FirewallRuleCreateSingleRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Request body

{
    "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 202

1.1.2 - 1.0

post /v1/firewalls/rules

Description

Create firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
bodybody
required
FirewallRuleCreateSingleRequest

Responses

HTTP CodeDescriptionSchema
201CreatedFirewallRuleShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 201

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

1.2 - Delete Firewall Rule

1.2.1 - 1.1

delete /v1/firewalls/rules/{firewall_rule_id}

Description

Delete firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 202

1.2.2 - 1.0

delete /v1/firewalls/rules/{firewall_rule_id}

Description

Delete firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
204No ContentNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 204

1.3 - List Firewall Rules

1.3.1 - 1.1

get /v1/firewalls/rules

Description

Get firewall rule list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
querysrc_ip
optional		Source IP
Example : 192.168.1.1
stringNone
querydst_ip
optional		Destination IP
Example : 192.168.1.1
stringNone
querydescription
optional		Firewall Rule Description
Example : Firewall rule description example
stringNone
querystate
optional		Firewall Rule State
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)][]
querystatus
optional		Firewall Rule Status
Example :
enum (ENABLE, DISABLE)None

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "state": "CREATING",
            "status": "ENABLE"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.3.2 - 1.0

get /v1/firewalls/rules

Description

Get firewall rule list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
querysrc_ip
optional		Source IP
Example : 192.168.1.1
stringNone
querydst_ip
optional		Destination IP
Example : 192.168.1.1
stringNone
querydescription
optional		Firewall Rule Description
Example : Firewall rule description example
stringNone
querystate
optional		Firewall Rule State
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)][]
querystatus
optional		Firewall Rule Status
Example :
enum (ENABLE, DISABLE)None
queryfetch_all
optional		Firewall Rule Fetch ALL
Example : False
booleanFalse

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls/rules?firewall_id={firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewall_rules": [
        {
            "action": "ALLOW",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "description": "Firewall rule description example",
            "destination_address": [
                "10.0.0.1",
                "10.0.0.2"
            ],
            "destination_interface": "IFW1-v1001dn",
            "direction": "INBOUND",
            "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "b156740b6335468d8354eb9ef8eddf5a",
            "sequence": 100,
            "service": [
                {
                    "service_type": "TCP",
                    "service_value": "443"
                }
            ],
            "source_address": [
                "192.168.1.1",
                "192.168.1.2"
            ],
            "source_interface": "IFW1-v2501up",
            "state": "CREATING",
            "status": "ENABLE",
            "vendor_rule_id": "72"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.4 - List Firewalls

1.4.1 - 1.1

get /v1/firewalls

Description

Get firewall list.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		Firewall Name
Example : FW_IGW_secuVPC
stringNone
queryvpc_name
optional		VPC Name
Example : secuVPC
stringNone
queryproduct_type
optional		Firewall Product Type
array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)][]
querystate
optional		Firewall State
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)][]

Responses

HTTP CodeDescriptionSchema
200OKFirewallListResponseV1Dot1
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "count": 20,
    "firewalls": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "flavor_name": "SMALL",
            "flavor_rule_quota": 100,
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "FW_IGW_secuVPC",
            "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
            "product_type": "IGW",
            "state": "CREATING",
            "status": "ENABLE",
            "total_rule_count": 8,
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "secuVPC",
            "zone_resources": [
                {
                    "allocate_state": "SUCCESS",
                    "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
                    "zone": "kr-west1-a"
                }
            ]
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.4.2 - 1.0

get /v1/firewalls

Description

Get firewall list.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
querysize
optional		size
Example : 20
any of [integer, null]20
querypage
optional		page
Example : 0
any of [integer, null]0
querysort
optional		sort
Example : created_at:desc
any of [string, null]None
queryname
optional		Firewall Name
Example : FW_IGW_secuVPC
stringNone
queryvpc_name
optional		VPC Name
Example : secuVPC
stringNone
queryproduct_type
optional		Firewall Product Type
array[enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)][]
querystate
optional		Firewall State
array[enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)][]

Responses

HTTP CodeDescriptionSchema
200OKFirewallListResponse
400Bad RequestNone
403ForbiddenNone

Example HTTP request

Request path

/v1/firewalls

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "count": 20,
    "firewalls": [
        {
            "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
            "created_at": "2024-05-17T00:23:17Z",
            "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "flavor_name": "SMALL",
            "flavor_rule_quota": 100,
            "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
            "id": "b156740b6335468d8354eb9ef8eddf5a",
            "loggable": false,
            "modified_at": "2024-05-17T00:23:17Z",
            "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
            "name": "FW_IGW_secuVPC",
            "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
            "product_type": "IGW",
            "state": "CREATING",
            "status": "ENABLE",
            "total_rule_count": 8,
            "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
            "vpc_name": "secuVPC"
        }
    ],
    "page": 0,
    "size": 20,
    "sort": [
        "created_at:asc"
    ]
}

1.5 - Set Firewall

1.5.1 - 1.1

put /v1/firewalls/{firewall_id}

Description

Set firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallSetRequest

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponseV1Dot1
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Request body

{
    "flavor_name": "EXSMALL",
    "loggable": false
}

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC",
        "zone_resources": [
            {
                "allocate_state": "SUCCESS",
                "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
                "zone": "kr-west1-a"
            }
        ]
    }
}

1.5.2 - 1.0

put /v1/firewalls/{firewall_id}

Description

Set firewall.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallSetRequest

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "flavor_name": "EXSMALL",
    "loggable": false
}

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

1.6 - Set Firewall Rule

1.6.1 - 1.1

put /v1/firewalls/rules/{firewall_rule_id}

Description

Set firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallRuleUpdateSingleRequest

Responses

HTTP CodeDescriptionSchema
202AcceptedNone
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Request body

{
    "firewall_rule": {
        "action": "ALLOW",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "order_direction": "BEFORE",
        "order_rule_id": "043aa63459da466faad71fe4fe587031",
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "status": "ENABLE"
    }
}

Example HTTP response

Response 202

1.6.2 - 1.0

put /v1/firewalls/rules/{firewall_rule_id}

Description

Set firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone
bodybody
required
FirewallRuleSetRequest

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleShowResponse
400Bad RequestNone
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Request body

{
    "action": "ALLOW",
    "description": "Firewall rule description example",
    "destination_address": [
        "10.0.0.1",
        "10.0.0.2"
    ],
    "direction": "INBOUND",
    "service": [
        {
            "service_type": "TCP",
            "service_value": "443"
        }
    ],
    "source_address": [
        "192.168.1.1",
        "192.168.1.2"
    ]
}

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

1.7 - Show Firewall

1.7.1 - 1.1

get /v1/firewalls/{firewall_id}

Description

Show firewall.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponseV1Dot1
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC",
        "zone_resources": [
            {
                "allocate_state": "SUCCESS",
                "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
                "zone": "kr-west1-a"
            }
        ]
    }
}

1.7.2 - 1.0

get /v1/firewalls/{firewall_id}

Description

Show firewall.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/{firewall_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall": {
        "account_id": "0e3dffc50eb247a1adf4f2e5c82c4f99",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "flavor_name": "SMALL",
        "flavor_rule_quota": 100,
        "fw_resource_id": "005fd1d30dea11f08a2c56773bef875b",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "loggable": false,
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "FW_IGW_secuVPC",
        "pre_product_id": "76479b7ffee1431198d9beb4502cda08",
        "product_type": "IGW",
        "state": "CREATING",
        "status": "ENABLE",
        "total_rule_count": 8,
        "vpc_id": "ceb44ea5ecb34a49b16495f9a63b0718",
        "vpc_name": "secuVPC"
    }
}

1.8 - Show Firewall Rule

1.8.1 - 1.1

get /v1/firewalls/rules/{firewall_rule_id}

Description

Show firewall rule.

State ACTIVE (CURRENT)

VersionNot Before
1.1-

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleShowResponseV1Dot1
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.1"

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "state": "CREATING",
        "status": "ENABLE"
    }
}

1.8.2 - 1.0

get /v1/firewalls/rules/{firewall_rule_id}

Description

Show firewall rule.

State ACTIVE (SUPPORTED)

VersionNot Before
1.020270131

Parameters

TypeNameDescriptionSchemaDefault
pathfirewall_rule_id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
stringNone

Responses

HTTP CodeDescriptionSchema
200OKFirewallRuleShowResponse
403ForbiddenNone
404Not FoundNone

Example HTTP request

Request path

/v1/firewalls/rules/{firewall_rule_id}

Request header

"Scp-Accesskey = 2sd2gg=2agbdSD26svcD",
"Scp-Signature = fsfsdf235f9U35sdgf35Xsf/qgsdgsdg326=sfsdr23rsef=",
"Scp-Timestamp = 1605290625682",
"Scp-ClientType = Openapi",
"Accept-Language = en-US",
"Scp-Api-Version = firewall 1.0"

Example HTTP response

Response 200

{
    "firewall_rule": {
        "action": "ALLOW",
        "created_at": "2024-05-17T00:23:17Z",
        "created_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "description": "Firewall rule description example",
        "destination_address": [
            "10.0.0.1",
            "10.0.0.2"
        ],
        "destination_interface": "IFW1-v1001dn",
        "direction": "INBOUND",
        "firewall_id": "b156740b6335468d8354eb9ef8eddf5a",
        "id": "b156740b6335468d8354eb9ef8eddf5a",
        "modified_at": "2024-05-17T00:23:17Z",
        "modified_by": "90dddfc2b1e04edba54ba2b41539a9ac",
        "name": "b156740b6335468d8354eb9ef8eddf5a",
        "sequence": 100,
        "service": [
            {
                "service_type": "TCP",
                "service_value": "443"
            }
        ],
        "source_address": [
            "192.168.1.1",
            "192.168.1.2"
        ],
        "source_interface": "IFW1-v2501up",
        "state": "CREATING",
        "status": "ENABLE",
        "vendor_rule_id": "72"
    }
}

2 - Models

2.1 - Firewall

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
flavor_name
optional		Firewall Size Name
Example : SMALL
string
flavor_rule_quota
optional		Firewall Rule Quota
Example : 100
integer
fw_resource_id
required		Fw Resource ID
Example : 005fd1d30dea11f08a2c56773bef875b
string
id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
loggable
required		Logging Use
Example : False
boolean
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Firewall Name
Example : FW_IGW_secuVPC
string
pre_product_id
optional		Pre Product ID
Example : 76479b7ffee1431198d9beb4502cda08
string
product_type
required		Firewall Product Type
Example : IGW
enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state
required		Firewall State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status
required		Firewall Status
Example : ENABLE
enum (ENABLE, DISABLE)
total_rule_count
optional		Total Rule Count
Example : 8
integer
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
vpc_name
required		VPC Name
Example : secuVPC
any of [string, null]

2.2 - FirewallListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewalls
required
array[Firewall]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.3 - FirewallListResponseV1Dot1

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewalls
required
array[FirewallV1Dot1]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.4 - FirewallPort

NameDescriptionSchemaDefault
service_type
required		Service Protocol Type
Example : TCP
enum (TCP, UDP, ICMP, IP, TCP_ALL, UDP_ALL, ICMP_ALL, ALL)
service_value
optional		Service Port Value
Example : 443
string

2.5 - FirewallRule

NameDescriptionSchemaDefault
action
required		Firewall Rule Action
Example : ALLOW
enum (ALLOW, DENY)
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional		Firewall Rule Description
Example : Firewall rule description example
any of [string, null]
destination_address
required		Destination Address
Example : ['10.0.0.1', '10.0.0.2']
array[string]
destination_interface
required		Destination Interface Name
Example : IFW1-v1001dn
string
direction
required		Firewall Rule Direction
Example : INBOUND
enum (INBOUND, OUTBOUND)
firewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
optional		Firewall Rule Name
Example : b156740b6335468d8354eb9ef8eddf5a
any of [string, null]
sequence
required		Firewall Rule Sequence
Example : 100
integer
service
required		Service Port
array[FirewallPort]
source_address
required		Source Address
Example : ['192.168.1.1', '192.168.1.2']
array[string]
source_interface
required		Source Interface Name
Example : IFW1-v2501up
string
state
required		Firewall Rule State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required		Firewall Rule Status
Example : ENABLE
enum (ENABLE, DISABLE)
vendor_rule_id
required		Vendor Rule ID
Example : 72
string

2.6 - FirewallRuleCreateRequest

NameDescriptionSchemaDefault
action
required		Firewall Rule Action
Example : ALLOW
enum (ALLOW, DENY)
description
optional		Firewall Rule Description
Example : Firewall rule description example
any of [string, null]
destination_address
required		Destination Address
Example : ['10.0.0.1', '10.0.0.2']
array[string]
direction
required		Firewall Rule Direction
Example : INBOUND
enum (INBOUND, OUTBOUND)
order_direction
optional		Order Direction
Example : BEFORE
enum (BEFORE, AFTER, BOTTOM)
order_rule_id
optional		Order Rule ID
Example : 043aa63459da466faad71fe4fe587031
string
service
required		Service Port
array[FirewallPort]
source_address
required		Source Address
Example : ['192.168.1.1', '192.168.1.2']
array[string]
status
required		Firewall Rule Status
Example : ENABLE
enum (ENABLE, DISABLE)

2.7 - FirewallRuleCreateSingleRequest

NameDescriptionSchemaDefault
firewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
firewall_rule
required		Firewall Request Rule
FirewallRuleCreateRequest

2.8 - FirewallRuleListResponse

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewall_rules
required
array[FirewallRule]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.9 - FirewallRuleListResponseV1Dot1

NameDescriptionSchemaDefault
count
required		count
Example : 20
integer
firewall_rules
required
array[FirewallRuleV1Dot1]
page
required		page
Example : 0
integer
size
required		size
Example : 20
integer
sort
optional		sort
Example : ['created_at:asc']
any of [array[string], null]

2.10 - FirewallRuleSetRequest

NameDescriptionSchemaDefault
action
required		Firewall Rule Action
Example : ALLOW
enum (ALLOW, DENY)
description
optional		Firewall Rule Description
Example : Firewall rule description example
any of [string, null]
destination_address
required		Destination Address
Example : ['10.0.0.1', '10.0.0.2']
array[string]
direction
required		Firewall Rule Direction
Example : INBOUND
enum (INBOUND, OUTBOUND)
service
required		Service Port
array[FirewallPort]
source_address
required		Source Address
Example : ['192.168.1.1', '192.168.1.2']
array[string]

2.11 - FirewallRuleShowResponse

NameDescriptionSchemaDefault
firewall_rule
required
FirewallRule

2.12 - FirewallRuleShowResponseV1Dot1

NameDescriptionSchemaDefault
firewall_rule
required
FirewallRuleV1Dot1

2.13 - FirewallRuleUpdateSingleRequest

NameDescriptionSchemaDefault
firewall_rule
required		Firewall Request Rule
FirewallRuleCreateRequest

2.14 - FirewallRuleV1Dot1

NameDescriptionSchemaDefault
action
required		Firewall Rule Action
Example : ALLOW
enum (ALLOW, DENY)
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
description
optional		Firewall Rule Description
Example : Firewall rule description example
any of [string, null]
destination_address
required		Destination Address
Example : ['10.0.0.1', '10.0.0.2']
array[string]
direction
required		Firewall Rule Direction
Example : INBOUND
enum (INBOUND, OUTBOUND)
firewall_id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
id
required		Firewall Rule ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
sequence
required		Firewall Rule Sequence
Example : 100
integer
service
required		Service Port
array[FirewallPort]
source_address
required		Source Address
Example : ['192.168.1.1', '192.168.1.2']
array[string]
state
required		Firewall Rule State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR)
status
required		Firewall Rule Status
Example : ENABLE
enum (ENABLE, DISABLE)

2.15 - FirewallSetRequest

NameDescriptionSchemaDefault
flavor_name
optional		Firewall Size Name
Example : EXSMALL
enum (EXSMALL, SMALL, MEDIUM, LARGE, EXLARGE)
loggable
optional		Logging Use
Example : False
boolean

2.16 - FirewallShowResponse

NameDescriptionSchemaDefault
firewall
required
Firewall

2.17 - FirewallShowResponseV1Dot1

NameDescriptionSchemaDefault
firewall
required
FirewallV1Dot1

2.18 - FirewallV1Dot1

NameDescriptionSchemaDefault
account_id
required		Account ID
Example : 0e3dffc50eb247a1adf4f2e5c82c4f99
string
created_at
required		Created At
Example : 2024-05-17T00:23:17Z
string (date-time)
created_by
required		Created By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
flavor_name
optional		Firewall Size Name
Example : SMALL
string
flavor_rule_quota
optional		Firewall Rule Quota
Example : 100
integer
id
required		Firewall ID
Example : b156740b6335468d8354eb9ef8eddf5a
string
loggable
required		Logging Use
Example : False
boolean
modified_at
required		Modified At
Example : 2024-05-17T00:23:17Z
string (date-time)
modified_by
required		Modified By
Example : 90dddfc2b1e04edba54ba2b41539a9ac
string
name
required		Firewall Name
Example : FW_IGW_secuVPC
string
pre_product_id
optional		Pre Product ID
Example : 76479b7ffee1431198d9beb4502cda08
string
product_type
required		Firewall Product Type
Example : IGW
enum (IGW, GGW, DGW, LB, SIGW, TGW_IGW, TGW_GGW, TGW_DGW, TGW_SIGW, TGW_BM)
state
required		Firewall State
Example : CREATING
enum (CREATING, ACTIVE, DELETING, DELETED, EDITING, ERROR, DEPLOYING)
status
required		Firewall Status
Example : ENABLE
enum (ENABLE, DISABLE)
total_rule_count
optional		Total Rule Count
Example : 8
integer
vpc_id
required		VPC Id
Example : ceb44ea5ecb34a49b16495f9a63b0718
any of [string, null]
vpc_name
required		VPC Name
Example : secuVPC
any of [string, null]
zone_resources
required		Firewall Zone Resources
array[ZoneResource]

2.19 - ZoneResource

NameDescriptionSchemaDefault
allocate_state
required		Firewall Allocate Type
Example : SUCCESS
enum (SUCCESS, FAIL, DELETED)
fw_resource_id
required		Fw Resource ID
Example : 005fd1d30dea11f08a2c56773bef875b
string
zone
required		Firewall Zone
Example : kr-west1-a
string