Get VPS firewall

GET

/vps/{id}/firewall

Get the IPv4 firewall state for a VPS (enabled flag, default policy and rules).

Request

Authorization

API Key

Add parameter in header

API-key

Example:

API-key: ********************

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://mijn.host/api/v2/vps/12345/firewall' \
--header 'Accept: application/json' \
--header 'User-Agent: my-application/1.0.0' \
--header 'API-key: <api-key>' \
--header 'Content-Type: application/json'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "status": 200,
    "status_description": "Request successful.",
    "data": {
        "enabled": true,
        "default_policy": "DROP",
        "rules": [
            { "direction": "OUT", "decision": "ACCEPT", "protocol": "TCP", "port": "ALL", "source_ip": "0.0.0.0/0" },
            { "direction": "IN", "decision": "ACCEPT", "protocol": "TCP", "port": "22,80,443", "source_ip": "0.0.0.0/0" }
        ],
        "locked": null
    }
}

🟠400Wrong request method

🟠400SSL connection is required

🟠400No valid VPS ID provided

🟠400No access to this VPS

🟠401No valid API key set

🟠401API key has expired

🟠401Remote IP address is not found in the API key whitelist

🔴500Error

Modified at 2026-09-07 15:03:25

Add SSH key

Update VPS firewall