- Method:
GET
- Path:
/v1/orgs/{org}/compute/vms/{vm_id}/firewall
- Operation ID:
getVmFirewall
- Tag: Compute
Send Authorization: Bearer <credential>. The credential is either an API key (vsk_…) created for an organization, or an OIDC access token obtained by signing in to VirtScale.
| Name |
Type |
Required |
Description |
vm_id |
string (uuid) |
Yes |
VirtScale instance id |
org |
string (uuid) |
Yes |
The organization’s id. |
| Field |
Type |
Required |
Enum |
Description |
error |
string, nullable |
Yes |
|
|
rules |
array of FirewallRuleOut |
Yes |
|
|
rules.description |
string |
Yes |
|
|
rules.direction |
string |
Yes |
|
ingress | egress. |
rules.id |
string (uuid) |
Yes |
|
|
rules.port_max |
integer, nullable |
Yes |
|
|
rules.port_min |
integer, nullable |
Yes |
|
|
rules.protocol |
string |
Yes |
|
tcp | udp | icmp | any. |
rules.remote_cidr |
string |
Yes |
|
|
state |
string |
Yes |
|
pending | applied | error. |
vm_id |
string (uuid) |
Yes |
|
|
Every error response is application/problem+json (schema Problem).
| Status |
Meaning |
| 401 |
The credential is missing or invalid. |
| 404 |
The resource does not exist. |
| default |
Any other status is possible; the code field identifies the error. |
curl "https://api.virtscale.nl/v1/orgs/$ORG_ID/compute/vms/$VM_ID/firewall" \
-H "Authorization: Bearer $VIRTSCALE_API_KEY"