Bind a firewall to a VM
curl --request POST \
--url https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vmId": "<string>"
}
'import requests
url = "https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings"
payload = { "vmId": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({vmId: '<string>'})
};
fetch('https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vmId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings"
payload := strings.NewReader("{\n \"vmId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vmId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vmId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"firewallId": "<string>",
"vmId": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Firewalls
Bind a firewall to a VM
Binds the firewall’s security group to the named VM and re-syncs the VM’s group references upstream.
POST
/
api
/
public
/
v1
/
firewalls
/
{id}
/
bindings
Bind a firewall to a VM
curl --request POST \
--url https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"vmId": "<string>"
}
'import requests
url = "https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings"
payload = { "vmId": "<string>" }
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({vmId: '<string>'})
};
fetch('https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'vmId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings"
payload := strings.NewReader("{\n \"vmId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"vmId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.vmarea.com/api/v1/api/public/v1/firewalls/{id}/bindings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"vmId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"firewallId": "<string>",
"vmId": "<string>"
}
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}{
"success": false,
"error": "<string>"
}Authorizations
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
Body
application/json
Pattern:
^[cC][^\s-]{8,}$⌘I