Console API

Create Security Group

Developing

POST

/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

vpc_id

string

required

Header Params

OrgId

string

required

Example:

ed2dab76-61a9-4352-a7d6-64fe716f6795

Body Params application/json

name

string

required

network

string

required

field id - API Subnet (List)

ip_address

array[string]

required

rules

string

required

json encode
schema

destinationPorts: int (port) (ex: 80, 90, 92)

protocol: null

sources: array of string (ex: ["10.10.10.10"])

action: str (ALLOW | DENY)

direction: str (ingress: inbound | egress: outbound)

port: field id from API Rule Types

description: str

tag_ids

array[string]

required

Example

{
    "name": "security-group-5662",
    "network": "f09f9d6d-399e-42cc-bcfc-ec8e3e3fffad",
    "ip_address": [
        "10.0.1.232"
    ],
    "rules": "[{\"destinationPorts\":\"80\",\"protocol\":null,\"description\":\"description\",\"port\":\"ed55f780-6e33-4bb0-b04d-3010cab5afe4\",\"sources\":[\"10.10.10.10\"],\"action\":\"ALLOW\",\"direction\":\"ingress\"}]",
    "tag_ids": [
        "bea8782e-de99-46ac-b3c1-70dd8408728f"
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/v1/vmware/vpc//security-groups' \
--header 'OrgId: ed2dab76-61a9-4352-a7d6-64fe716f6795' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "security-group-5662",
    "network": "f09f9d6d-399e-42cc-bcfc-ec8e3e3fffad",
    "ip_address": [
        "10.0.1.232"
    ],
    "rules": "[{\"destinationPorts\":\"80\",\"protocol\":null,\"description\":\"description\",\"port\":\"ed55f780-6e33-4bb0-b04d-3010cab5afe4\",\"sources\":[\"10.10.10.10\"],\"action\":\"ALLOW\",\"direction\":\"ingress\"}]",
    "tag_ids": [
        "bea8782e-de99-46ac-b3c1-70dd8408728f"
    ]
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}

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

Rule Types

Create Rule