Security Group List

Developing

GET

/api/v1/vmware/vpc/{vpc_id}/security-groups

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/api/v1/vmware/vpc//security-groups?page=1&page_size=25&sort_field=&sort_order=' \
--header 'OrgId;' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Body

Example

{
    "data": [
        {
            "id": "56be9054-69a4-47e4-be72-16ab58acb1d0",
            "name": "default",
            "display_name": "Default security group",
            "ip_addresses": [
                "10.155.194.147",
                "10.155.194.147",
                "10.155.194.223",
                "10.155.194.44"
            ],
            "instances": [
                {
                    "id": "9b589916-c643-4dd8-a010-3ce247cb11a4",
                    "name": "vm-24010294556",
                    "status": "POWERED_OFF",
                    "ip_address": "10.155.194.44",
                    "type": "instance"
                },
                {
                    "id": "ca5c5fbb-d1f8-4982-8ceb-8e9860f5da70",
                    "name": "vm-24010294556",
                    "status": "POWERED_OFF",
                    "ip_address": "10.155.194.223",
                    "type": "instance"
                },
                {
                    "id": "9d5b5f9a-9d8b-495b-992b-70e32ae23f85",
                    "name": "vm-24011025449-202411",
                    "status": "POWERED_ON",
                    "ip_address": "10.155.194.147",
                    "type": "instance"
                }
            ],
            "created_at": "2024-01-02T13:57:22",
            "edge_gateway": null,
            "is_vdc_group": false,
            "rules": [
                {
                    "id": "9f5f9cf3-c4d6-4db6-a1cf-1f920ff7f8b7",
                    "firewall_rule_id": "6d54d92ab5834cefa3b78098bcbb548e",
                    "vpc_id": "aa0e66e0-3486-4724-a670-b5a4a758484e",
                    "edge_gateway_id": "fb410b57180a45c0ba02e240088ceec7",
                    "name": "6d54d92a-b583-4cef-a3b7-8098bcbb548e",
                    "enabled": "True",
                    "action": "ALLOW",
                    "source_firewall_group_id": "56be9054-69a4-47e4-be72-16ab58acb1d0",
                    "destination_firewall_group_id": "56be9054-69a4-47e4-be72-16ab58acb1d0",
                    "application_port_profile_id": "None",
                    "created_at": "2024-01-02 13:57:26",
                    "updated_at": "2024-01-10 08:29:51",
                    "is_deleted": "False",
                    "status": "REALIZED",
                    "description": "",
                    "source": "None",
                    "index": "None",
                    "comment": "None"
                },
                {
                    "id": "c5b13d56-57fe-435e-981e-cfbc85e94dad",
                    "firewall_rule_id": "df4111388ab243ba92293c899cdce096",
                    "vpc_id": "aa0e66e0-3486-4724-a670-b5a4a758484e",
                    "edge_gateway_id": "fb410b57180a45c0ba02e240088ceec7",
                    "name": "df411138-8ab2-43ba-9229-3c899cdce096",
                    "enabled": "True",
                    "action": "ALLOW",
                    "source_firewall_group_id": "56be9054-69a4-47e4-be72-16ab58acb1d0",
                    "destination_firewall_group_id": "56be9054-69a4-47e4-be72-16ab58acb1d0",
                    "application_port_profile_id": "None",
                    "created_at": "2024-01-02 13:57:26",
                    "updated_at": "2024-01-10 08:29:51",
                    "is_deleted": "False",
                    "status": "REALIZED",
                    "description": "",
                    "source": "None",
                    "index": "None",
                    "comment": "None"
                }
            ],
            "status": "REALIZED",
            "firewall_group_id": "a4fcaa451cbb4ed3a8e1ff7e923f6390",
            "has_firewall_ip_address": true,
            "tags": [
                {
                    "id": "bea8782e-de99-46ac-b3c1-70dd8408728f",
                    "key": "Test_tagging2",
                    "value": "123457!@#$%&*abc",
                    "color": "#e7a600",
                    "tenant_org_id": "59409b9c-a19d-4b84-abae-aff8de042ded",
                    "created_by": "6c73d2db-5782-4373-a766-a190a2748858",
                    "updated_by": "6c73d2db-5782-4373-a766-a190a2748858",
                    "created_at": "2024-05-17T15:57:14",
                    "updated_at": "2024-05-20T08:32:00",
                    "is_deleted": false
                }
            ]
        },
        {
            "id": "97edd52a-67c5-4668-92af-0a568c599afe",
            "name": "security-group-1288-0v12zm88",
            "display_name": "security-group-1288",
            "ip_addresses": [
                "10.155.194.44"
            ],
            "instances": [
                {
                    "id": "9b589916-c643-4dd8-a010-3ce247cb11a4",
                    "name": "vm-24010294556",
                    "status": "POWERED_OFF",
                    "ip_address": "10.155.194.44",
                    "type": "instance"
                }
            ],
            "created_at": "2024-01-02T18:20:01",
            "edge_gateway": null,
            "is_vdc_group": false,
            "rules": [
                {
                    "id": "fc2ff3b4-cb0a-4b23-bcb3-04665f1f4a67",
                    "firewall_rule_id": "ad3b6981638241d587701b230fe7f223",
                    "vpc_id": "aa0e66e0-3486-4724-a670-b5a4a758484e",
                    "edge_gateway_id": "fb410b57180a45c0ba02e240088ceec7",
                    "name": "portal__empty_name_oo0eo7cr",
                    "enabled": "True",
                    "action": "ALLOW",
                    "source_firewall_group_id": "c1695859-df93-4fa2-bc6f-409142b521f1",
                    "destination_firewall_group_id": "97edd52a-67c5-4668-92af-0a568c599afe",
                    "application_port_profile_id": "4eb99d82-3558-459a-bfdc-f50653b8c6fc",
                    "created_at": "2024-01-02 18:35:21",
                    "updated_at": "2024-01-10 08:29:51",
                    "is_deleted": "False",
                    "status": "REALIZED",
                    "description": "00",
                    "source": "123.21.99.143",
                    "index": "-99",
                    "comment": "None"
                }
            ],
            "status": "REALIZED",
            "firewall_group_id": "5cc654b4c8c04b86b476769dece70bdb",
            "has_firewall_ip_address": true,
            "tags": []
        }
    ],
    "total": 2
}

Modified at 2024-05-24 07:26:00

Manage tags

Security Group Detail