Add instance security rule

POST

/instances/{vm_id}/security-rules/

Adds a security rule directly to a virtual machine instance. Supports TCP, UDP, and ICMP protocols with configurable port ranges and IP address filtering. Instance must be in RUNNING state. Only available for legacy tier instances.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Security rule added successfully

Body

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://barrack.ai/api/instances//security-rules/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "direction": "ingress",
    "protocol": "tcp",
    "ethertype": "IPv4",
    "remote_ip_prefix": "string",
    "port_range_min": 1,
    "port_range_max": 1
}'

Response Example

200 - TCP Rule Added

{
    "success": true,
    "message": "Security rule added successfully",
    "security_rule": {
        "id": "sg-rule-123",
        "direction": "ingress",
        "protocol": "tcp",
        "ethertype": "IPv4",
        "remote_ip_prefix": "203.0.113.0/24",
        "port_range_min": 3306,
        "port_range_max": 3306
    },
    "instance_id": "BRK-123456D",
    "tier": "legacy",
    "request_id": "i7j8k9l0"
}

Toggle public IP for instance

Remove instance security rule