Skip to main content
GET
/
api
/
public
/
v1
/
firewalls
/
{id}
Get a firewall
curl --request GET \
  --url https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id} \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "rules": [
      {
        "id": "<string>",
        "firewallId": "<string>",
        "position": 123,
        "port": "<string>",
        "sourceIps": [
          "<string>"
        ],
        "destIps": [
          "<string>"
        ],
        "description": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "bindings": [
      {
        "vmId": "<string>",
        "attachedAt": "2023-11-07T05:31:56Z",
        "vm": {
          "id": "<string>",
          "name": "<string>",
          "hostname": "<string>",
          "status": "<string>"
        }
      }
    ],
    "bindingCount": 123,
    "ruleCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
x-api-key
string
header
required

Long-lived API token created at https://vmarea.com/dashboard/settings/api-keys. Tokens are scope-restricted; this spec lists the scope each endpoint requires.

Path Parameters

​
id
string
required

Response

Default Response

​
success
enum<boolean>
required
Available options:
true
​
data
object
required