Security Group

Security groups act as virtual firewalls with ingress (firewall), egress and port-forwarding rules applied to instances.

Resource base path: /restapi/securitygroup

Method	Path	Description
`POST`	`/restapi/securitygroup/createSecurityGroup`	Create Security Group
`GET`	`/restapi/securitygroup/securityList`	Security Group List
`POST`	`/restapi/securitygroup/createSecurityGroupFirewallRule`	Create Security Group Firewall Rule
`POST`	`/restapi/securitygroup/createSecurityGroupEgressRule`	Create Security Group Egress Rule
`POST`	`/restapi/securitygroup/createSecurityGroupPortForwardingRule`	Create Security Group Port Forwarding Rule
`DELETE`	`/restapi/securitygroup/deleteSecurityGroupRule`	Delete Security Group Rule
`DELETE`	`/restapi/securitygroup/deleteSecurityGroup/{uuid}`	Delete Security Group

note

apikey and secretkey are required HTTP headers on every request and are omitted from the parameter tables below. See Authentication.

Create Security Group

Create Security Group.

POST /restapi/securitygroup/createSecurityGroup

Request body

Field	Type	Required	Description
`name`	string	No	Name of the resource.
`description`	string	No	Human-readable description.

{
  "name": "example-name",
  "description": "string"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/securitygroup/createSecurityGroup" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "description": "string"
}'

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "count": 1,
  "listSecurityGroupResponse": [
    {
      "securityGroupFirewallRule": [
        {}
      ],
      "name": "example-name",
      "securityGroupPortForwarding": [
        {}
      ],
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "securityGroupEgressRule": [
        {}
      ],
      "status": "Active"
    }
  ]
}

Security Group List

Security Group List.

GET /restapi/securitygroup/securityList

Parameters

Parameter	In	Type	Required	Description
`uuid`	query	string	No	UUID of the resource.

Example request

curl -X GET \
  "https://portal.your-domain.com/restapi/securitygroup/securityList" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "count": 1,
  "listSecurityGroupResponse": [
    {
      "securityGroupFirewallRule": [
        {}
      ],
      "name": "example-name",
      "securityGroupPortForwarding": [
        {}
      ],
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "securityGroupEgressRule": [
        {}
      ],
      "status": "Active"
    }
  ]
}

Create Security Group Firewall Rule

Create Security Group Firewall Rule.

POST /restapi/securitygroup/createSecurityGroupFirewallRule

Request body

Field	Type	Required	Description
`startPort`	string	No	First port in the range.
`icmpType`	string	No
`protocol`	string	No	FirewallRule protocol (TCP, UDP,ICMP) Example: `TCP`
`cidrList`	string	No	CIDR range the rule applies to (for example, 0.0.0.0/0).
`icmpCode`	string	No
`securityGroupUuid`	string	No	UUID of the security group.
`endPort`	string	No	Last port in the range.

{
  "startPort": "8080",
  "icmpType": "string",
  "protocol": "TCP",
  "cidrList": "0.0.0.0/0",
  "icmpCode": "string",
  "securityGroupUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "endPort": "8080"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/securitygroup/createSecurityGroupFirewallRule" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "startPort": "8080",
  "icmpType": "string",
  "protocol": "TCP",
  "cidrList": "0.0.0.0/0",
  "icmpCode": "string",
  "securityGroupUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "endPort": "8080"
}'

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "count": 1,
  "listSecurityGroupResponse": [
    {
      "securityGroupFirewallRule": [
        {}
      ],
      "name": "example-name",
      "securityGroupPortForwarding": [
        {}
      ],
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "securityGroupEgressRule": [
        {}
      ],
      "status": "Active"
    }
  ]
}

Create Security Group Egress Rule

Create Security Group Egress Rule.

POST /restapi/securitygroup/createSecurityGroupEgressRule

Request body

Field	Type	Required	Description
`startPort`	string	No	First port in the range.
`icmpType`	string	No
`protocol`	string	✅ Yes	EgressRule protocol (TCP, UDP,ICMP) Example: `TCP`
`icmpCode`	string	No
`securityGroupUuid`	string	No	UUID of the security group.
`endPort`	string	No	Last port in the range.

{
  "startPort": "8080",
  "icmpType": "string",
  "protocol": "TCP",
  "icmpCode": "string",
  "securityGroupUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "endPort": "8080"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/securitygroup/createSecurityGroupEgressRule" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "startPort": "8080",
  "icmpType": "string",
  "protocol": "TCP",
  "icmpCode": "string",
  "securityGroupUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "endPort": "8080"
}'

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "count": 1,
  "listSecurityGroupResponse": [
    {
      "securityGroupFirewallRule": [
        {}
      ],
      "name": "example-name",
      "securityGroupPortForwarding": [
        {}
      ],
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "securityGroupEgressRule": [
        {}
      ],
      "status": "Active"
    }
  ]
}

Create Security Group Port Forwarding Rule

Create Security Group Port Forwarding Rule.

POST /restapi/securitygroup/createSecurityGroupPortForwardingRule

Request body

Field	Type	Required	Description
`privateStartPort`	string	No
`publicStartPort`	string	No
`privateEndPort`	string	No
`securityGroupUuid`	string	No	UUID of the security group.
`publicEndPort`	string	No
`protocolType`	string	No	Load balancer algorithm (TCP, UDP) Example: `TCP`

{
  "privateStartPort": "8080",
  "publicStartPort": "8080",
  "privateEndPort": "8080",
  "securityGroupUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publicEndPort": "8080",
  "protocolType": "TCP"
}

Example request

curl -X POST \
  "https://portal.your-domain.com/restapi/securitygroup/createSecurityGroupPortForwardingRule" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "privateStartPort": "8080",
  "publicStartPort": "8080",
  "privateEndPort": "8080",
  "securityGroupUuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "publicEndPort": "8080",
  "protocolType": "TCP"
}'

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "count": 1,
  "listSecurityGroupResponse": [
    {
      "securityGroupFirewallRule": [
        {}
      ],
      "name": "example-name",
      "securityGroupPortForwarding": [
        {}
      ],
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "securityGroupEgressRule": [
        {}
      ],
      "status": "Active"
    }
  ]
}

Delete Security Group Rule

Delete Security Group Rule.

DELETE /restapi/securitygroup/deleteSecurityGroupRule

Parameters

Parameter	In	Type	Required	Description
`securityGroupUuid`	query	string	✅ Yes	UUID of the security group.
`ruleType`	query	string	✅ Yes	ruleType (EGRESSRULE, FIREWALLRULE, PORTFORWATDING).
`ruleUuid`	query	string	✅ Yes

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/securitygroup/deleteSecurityGroupRule?securityGroupUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890&ruleType=VALUE&ruleUuid=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

{
  "count": 1,
  "listSecurityGroupResponse": [
    {
      "securityGroupFirewallRule": [
        {}
      ],
      "name": "example-name",
      "securityGroupPortForwarding": [
        {}
      ],
      "description": "string",
      "isActive": true,
      "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "securityGroupEgressRule": [
        {}
      ],
      "status": "Active"
    }
  ]
}

Delete Security Group

Delete Security Group.

DELETE /restapi/securitygroup/deleteSecurityGroup/{uuid}

Parameters

Parameter	In	Type	Required	Description
`uuid`	path	string	✅ Yes	UUID of the resource.

Example request

curl -X DELETE \
  "https://portal.your-domain.com/restapi/securitygroup/deleteSecurityGroup/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "apikey: YOUR_API_KEY" \
  -H "secretkey: YOUR_SECRET_KEY"

Responses

Code	Description
`200`	Successful operation.
`401`	Invalid authentication credentials.
`550`	Permission denied.

true

Create Security Group​

Request body​

Example request​

Responses​

Security Group List​

Parameters​

Example request​

Responses​

Create Security Group Firewall Rule​

Request body​

Example request​

Responses​

Create Security Group Egress Rule​

Request body​

Example request​

Responses​

Create Security Group Port Forwarding Rule​

Request body​

Example request​

Responses​

Delete Security Group Rule​

Parameters​

Example request​

Responses​

Delete Security Group​

Parameters​

Example request​

Responses​

Create Security Group

Request body

Example request

Responses

Security Group List

Parameters

Example request

Responses

Create Security Group Firewall Rule

Request body

Example request

Responses

Create Security Group Egress Rule

Request body

Example request

Responses

Create Security Group Port Forwarding Rule

Request body

Example request

Responses

Delete Security Group Rule

Parameters

Example request

Responses

Delete Security Group

Parameters

Example request

Responses