FWCloud API (2.5.1)

Download OpenAPI specification:

FWCloud-API

This documentation describes the FWCloud REST API, the backend module responsible for executing management operations on firewalls, policies, IP objects, VPNs, and other platform resources.

What you can do with the API

Operate FWCloud without depending on FWCloud-UI.
Integrate automations (for example, dynamic blocking rules).
Query operational status (for example, connectivity or service information).
Manage resources programmatically (FWClouds, firewalls, clusters, etc.).

Usage requirements

To call the API, you need:

API base URL (IP/DNS + listening port).
Secure communication over HTTPS.
A valid Origin header (it must be allowed in the server's CORS configuration).
Valid credentials (customer, username, password).

Recommended authentication flow

Login
Send POST /user/login with JSON credentials.
Session
The API returns a session cookie; you must reuse it in subsequent calls.
Mutating Operations
In operations that modify data, the API may require additional confirmation through the X-FWC-Confirm-Token header.

General request structure

A request is composed of:

METHOD: POST, GET, PUT, DELETE, etc.
URL: resource endpoint.
JSON BODY: operation parameters (especially on legacy endpoints).
HEADERS: Content-Type, Origin, session cookie, and confirmation token when applicable.

Security and best practices

Always use HTTPS in real environments.
Properly restrict allowed CORS origins.
Do not reuse default credentials in production.
Manage session expiration/rotation and protect cookie/token storage.

Official reference

This introduction is aligned with the official FWCloud-API usage guide:

https://fwcloud.net/en/documentation/fwcloud-api/

user

Legacy endpoints under src/routes/user

Log into the API.

Validate the user credentials and initialize data in the session file.

Request Body schema: application/json
optional

customer required	number <double>
username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"customer": 1,
"username": "fwcadmin",
"password": "fwcadmin"
}

Response samples

200
401

Content type

application/json

{"user": 1,
"role": 1
}

Log out the API.

Close a previous created user session.

Authorizations:

(sessionCookieconfirmToken)

Responses

New user.

Create new user.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

customer required	number <double>
name required	string
email required	string
username required	string
password required	string
enabled required	number <double>
role required	number <double>
allowed_from required	string

Responses

Request samples

Payload

Content type

application/json

{"customer": 2,
"name": "My Personal Name",
"email": "info@fwcloud.net",
"username": "fwcusr",
"password": "mysecret",
"enabled": 1,
"role": 1,
"allowed_from": "10.99.4.10,192.168.1.1"
}

Response samples

200
400
default

Content type

application/json

{"user": 5
}

Update user.

Update user's data.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

customer required	number <double>
name required	string
email required	string
username required	string
password required	string
enabled required	number <double>
role required	number <double>
allowed_from required	string

Responses

Request samples

Payload

Content type

application/json

{"customer": 2,
"name": "My Personal Name",
"email": "info@fwcloud.net",
"username": "fwcloud",
"password": "mysecret",
"enabled": 1,
"role": 1,
"allowed_from": "10.99.4.10,192.168.1.1"
}

Response samples

400

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

Modify logged user password.

Modify the password of the logged user.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

password

required

string

Responses

Request samples

Payload

Content type

application/json

{"password": "mynewsecrec"
}

Response samples

400

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

Get user data.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

customer required	number <double>
user required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"customer": 2,
"user": 1
}

Response samples

200
400

Content type

application/json

{"id": 2,
"customer": 2,
"name": "My Personal Name",
"email": "info@fwcloud.net",
"username": "fwcusr",
"password": "mysecret",
"enabled": 1,
"role": 1,
"allowed_from": "10.99.4.10,192.168.1.1",
"last_login": null,
"confirmation_token": null,
"created_at": "2019-05-13T15:11:20.000Z",
"updated_at": "2019-05-13T15:11:20.000Z",
"created_by": 0,
"updated_by": 0
}

Delete user.

Delete user from the database.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

customer

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"customer": 2
}

Response samples

400

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

Restrictions for user deletion.

Check that there are no restrictions for user deletion.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

customer required	number <double>
user required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"customer": 10,
"user": 5
}

Response samples

200
403

Content type

application/json

{"response": {"respStatus": true,
"respCode": "ACR_OK",
"respCodeMsg": "Ok",
"respMsg": "",
"errorCode": "",
"errorMsg": ""
},
"data": { }
}

Enable cloud access.

Allow a user the access to a fwcloud.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

user required	number <double>
fwcloud required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"user": 5,
"fwcloud": 2
}

Disable cloud access.

Disable user access to a fwcloud.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

user required	number <double>
fwcloud required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"user": 5,
"fwcloud": 2
}

List of fwclouds with access.

List of fwclouds to which the indicated user has access to.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

user

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"user": 5
}

Response samples

200

Content type

application/json

[{"id": 4,
"name": "FWCloud-02",
"created_at": "2019-05-14T11:37:19.000Z",
"updated_at": "2019-05-14T11:37:19.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": null,
"locked_by": null,
"locked": 0,
"image": "",
"comment": ""
},
{"id": 5,
"name": "FWCloud-03",
"created_at": "2019-05-14T11:37:24.000Z",
"updated_at": "2019-05-14T11:57:06.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": "2019-05-14T11:57:06.000Z",
"locked_by": 1,
"locked": 1,
"image": "",
"comment": ""
}
]

customer

Legacy endpoints under src/routes/user/customer.js

New customer.

Create new customer. Customers allow group users.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

customer required	number <double>
name required	string
addr required	string
phone required	string
email required	string
web required	string

Responses

Request samples

Payload

Content type

application/json

{"customer": 1,
"name": "FWCloud.net",
"addr": "C/Carrasca, 7 - 03590 Altea (Alicante) - Spain",
"phone": "+34 966 446 046",
"email": "info@fwcloud.net",
"web": "https://fwcloud.net"
}

Response samples

400
default

Content type

application/json

{"fwcErr": 1004,
"msg": "Already exists with the same id"
}

Update customer.

Update customer's information.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

customer required	number <double>
name required	string
addr required	string
phone required	string
email required	string
web required	string

Responses

Request samples

Payload

Content type

application/json

{"customer": 2,
"name": "FWCloud.net",
"addr": "C/Carrasca, 7 - 03590 Altea (Alicante) - Spain",
"phone": "+34 966 446 046",
"email": "info@fwcloud.net",
"web": "https://www.fwcloud.net"
}

Response samples

400
default

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

Get customer data.

Get customer data. If customer is empty, returns all customers with id and name.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

customer

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"customer": 2
}

Response samples

200
400

Content type

application/json

{"id": 2,
"name": "FWCloud.net",
"addr": "C/Carrasca, 7 - 03590 Altea (Alicante) - Spain",
"phone": "+34 966 446 046",
"email": "info@fwcloud.net",
"web": "https://fwcloud.net",
"created_at": "2019-05-13T10:40:36.000Z",
"updated_at": "2019-05-13T10:40:36.000Z",
"created_by": 0,
"updated_by": 0
}

Delete customer.

Delete customer from the database.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

customer

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"customer": 1
}

Response samples

400
403

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

Restrictions for customer deletion.

Check that there are no restrictions for customer deletion.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

customer

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"customer": 10
}

Response samples

403

Content type

application/json

{"result": true,
"restrictions": {"CustomerHasUsers": true
}
}

firewall

Firewall endpoints under src/routes/firewall plus src/controllers/firewalls/firewall.controller.ts

Compile firewall routing rules.

Authorizations:

sessionCookie

path Parameters

fwcloud required	number <double>
firewall required	number <double>

query Parameters

rules

Array of numbers <double> [ items <double > ]

Responses

Response samples

200
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": [{"id": 31,
"active": true,
"comment": "Route traffic from DMZ network through table 200",
"cs": "$IP rule add priority 1001 from 172.16.10.0/24 table 200\n"
}
]
}

Compile firewall HAProxy rules.

Authorizations:

sessionCookie

path Parameters

fwcloud required	number <double>
firewall required	number <double>

query Parameters

rules

Array of numbers <double> [ items <double > ]

Responses

Response samples

200
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": [{"id": 12,
"active": true,
"cs": "# Publish HTTPS\nfrontend front_public_https\n\tmode\ttcp\n"
}
]
}

Compile firewall DHCP rules.

Authorizations:

sessionCookie

path Parameters

fwcloud required	number <double>
firewall required	number <double>

query Parameters

rules

Array of numbers <double> [ items <double > ]

Responses

Response samples

200
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": [{"id": 8,
"active": true,
"cs": "subnet 10.0.10.0 netmask 255.255.255.0 {\n\toption routers 10.0.10.1;\n}\n"
}
]
}

Compile firewall Keepalived rules.

Authorizations:

sessionCookie

path Parameters

fwcloud required	number <double>
firewall required	number <double>

query Parameters

rules

Array of numbers <double> [ items <double > ]

Responses

Response samples

200
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": [{"id": 21,
"active": true,
"cs": "# Keepalived rule\nvrrp_script VI_eth0 {\n\tinterface eth0\n\tstate BACKUP\n}\n"
}
]
}

Ping firewall communication.

Authorizations:

(sessionCookieconfirmToken)

path Parameters

fwcloud

required

number <double>

Request Body schema: application/json
required

communication required	string (FirewallInstallCommunication) Enum: "ssh" "agent"
host required	string
port required	number <double>
username	string
password	string
protocol	string (FirewallInstallProtocol) Enum: "https" "http"
apikey	string

Responses

Request samples

Payload

Content type

application/json

{"communication": "ssh",
"host": "string",
"port": 0.1,
"username": "string",
"password": "string",
"protocol": "https",
"apikey": "string"
}

Response samples

200
501
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": {"status": "OK"
}
}

Get firewall communication info.

Authorizations:

(sessionCookieconfirmToken)

path Parameters

fwcloud

required

number <double>

Request Body schema: application/json
required

communication required	string (FirewallInstallCommunication) Enum: "ssh" "agent"
host required	string
port required	number <double>
username	string
password	string
protocol	string (FirewallInstallProtocol) Enum: "https" "http"
apikey	string

Responses

Request samples

Payload

Content type

application/json

{"communication": "ssh",
"host": "string",
"port": 0.1,
"username": "string",
"password": "string",
"protocol": "https",
"apikey": "string"
}

Response samples

200
501
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": {"fwc_agent_version": "2.5.0",
"host_name": "fw-edge-01",
"system_name": "Debian GNU/Linux",
"os_version": "12",
"kernel_version": "6.1.0-25-amd64"
}
}

Install or uninstall firewall plugin.

Authorizations:

(sessionCookieconfirmToken)

path Parameters

fwcloud

required

number <double>

Request Body schema: application/json
required

firewallId	number <double>
communication required	string (FirewallInstallCommunication) Enum: "ssh" "agent"
host required	string
port required	number <double>
username	string
password	string
protocol	string (FirewallInstallProtocol) Enum: "https" "http"
apikey	string
plugin required	string (PluginsFlags) Enum: "openvpn" "geoip" "crowdsec" "ntopng" "suricata" "keepalived" "zeek" "elasticsearch" "filebeat" "websafety" "kibana" "logstash" "dnssafety" "isc-bind9" "isc-dhcp" "haproxy" "wireguard" "ipsec" "irqbalance"
enable required	boolean

Responses

Request samples

Payload

Content type

application/json

{"firewallId": 0.1,
"communication": "ssh",
"host": "string",
"port": 0.1,
"username": "string",
"password": "string",
"protocol": "https",
"apikey": "string",
"plugin": "openvpn",
"enable": true
}

Response samples

200
501
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": ""
}

New firewall.

Create a new firewall.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
name required	string
save_user_pass required	number <double>
install_port required	number <double>
fwmaster required	number <double>
options required	number <double>
node_id required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1,
"name": "Firewall-01",
"save_user_pass": 0,
"install_port": 22,
"fwmaster": 0,
"options": 0,
"node_id": 1
}

Response samples

200
400
default

Content type

application/json

{"insertId": 1
}

Update firewall.

Update firewall information.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
firewall required	number <double>
name required	string
comment required	string
save_user_pass required	number <double>
install_port required	number <double>
fwmaster required	number <double>
options required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1,
"firewall": 5,
"name": "Firewall-UPDATED",
"comment": "Comment for the updated firewall.",
"save_user_pass": 0,
"install_port": 22,
"fwmaster": 0,
"options": 3
}

Response samples

400

Content type

application/json

{"fwcErr": 7001,
"msg": "Firewall access not allowed"
}

Get firewall data.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud required	number <double>
firewall required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1,
"firewall": 5
}

Response samples

200
400

Content type

application/json

{"id": 5,
"cluster": null,
"fwcloud": 1,
"name": "Firewall-05",
"comment": null,
"created_at": "2019-05-15T10:34:46.000Z",
"updated_at": "2019-05-15T10:34:47.000Z",
"compiled_at": null,
"installed_at": null,
"by_user": 1,
"status": 3,
"install_user": "",
"install_pass": "",
"save_user_pass": 0,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 0,
"install_port": 22,
"options": 0,
"interface_name": null,
"ip_name": null,
"ip": null,
"id_fwmaster": null
}

Get firewalls in cloud.

Get firewalls data by fwcloud.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1
}

Response samples

200
400

Content type

application/json

[{"id": 1,
"cluster": null,
"fwcloud": 1,
"name": "Firewall-01",
"comment": null,
"created_at": "2019-05-15T10:34:46.000Z",
"updated_at": "2019-05-15T10:34:47.000Z",
"compiled_at": null,
"installed_at": null,
"by_user": 1,
"status": 3,
"install_user": "",
"install_pass": "",
"save_user_pass": 0,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 0,
"install_port": 22,
"options": 0,
"interface_name": null,
"ip_name": null,
"ip": null,
"id_fwmaster": null
},
{"id": 2,
"cluster": null,
"fwcloud": 1,
"name": "Firewall-02",
"comment": null,
"created_at": "2019-05-15T10:34:46.000Z",
"updated_at": "2019-05-15T10:34:47.000Z",
"compiled_at": null,
"installed_at": null,
"by_user": 1,
"status": 3,
"install_user": "",
"install_pass": "",
"save_user_pass": 0,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 0,
"install_port": 22,
"options": 0,
"interface_name": null,
"ip_name": null,
"ip": null,
"id_fwmaster": null
}
]

Get firewalls in cluster.

Get firewalls data by cluster.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud required	number <double>
cluster required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1,
"cluster": 2
}

Response samples

200
400

Content type

application/json

[{"id": 1,
"cluster": 2,
"fwcloud": 1,
"name": "Firewall-01",
"comment": null,
"created_at": "2019-05-15T10:34:46.000Z",
"updated_at": "2019-05-15T10:34:47.000Z",
"compiled_at": null,
"installed_at": null,
"by_user": 1,
"status": 3,
"install_user": "",
"install_pass": "",
"save_user_pass": 0,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 1,
"install_port": 22,
"options": 0,
"interface_name": null,
"ip_name": null,
"ip": null,
"id_fwmaster": null
},
{"id": 2,
"cluster": 2,
"fwcloud": 1,
"name": "Firewall-02",
"comment": null,
"created_at": "2019-05-15T10:34:46.000Z",
"updated_at": "2019-05-15T10:34:47.000Z",
"compiled_at": null,
"installed_at": null,
"by_user": 1,
"status": 3,
"install_user": "",
"install_pass": "",
"save_user_pass": 0,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 0,
"install_port": 22,
"options": 0,
"interface_name": null,
"ip_name": null,
"ip": null,
"id_fwmaster": null
}
]

Clone firewall.

Create a new firewall cloning the one indicated in the request's parameters.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
firewall required	number <double>
name required	string
comment required	string
node_id required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1,
"firewall": 5,
"name": "Firewall-CLONED",
"comment": "Comment for the cloned firewall.",
"node_id": 1
}

Response samples

200
400

Content type

application/json

{"insertId": 7
}

Delete firewall.

Delete a firewall.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
firewall required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 1,
"firewall": 7
}

Response samples

400

Content type

application/json

{"fwcErr": 7001,
"msg": "Firewall access not allowed"
}

cluster

Legacy endpoints under src/routes/firewall/cluster.js

New cluster.

Create a new cluster of firewalls.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
node_id required	number <double>
required	object

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 3,
"node_id": 391,
"clusterData": {"name": "Cluster-01",
"options": 3,
"fwnodes": [{"name": "node1",
"comment": null,
"install_user": null,
"install_pass": null,
"save_user_pass": 1,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 1,
"install_port": 22
},
{"name": "node2",
"comment": null,
"install_user": null,
"install_pass": null,
"save_user_pass": 1,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 0,
"install_port": 22
},
{"name": "node3",
"comment": null,
"install_user": null,
"install_pass": null,
"save_user_pass": 1,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 0,
"install_port": 22
}
]
}
}

Response samples

200
400
default

Content type

application/json

{"insertId": 1,
"loData": { }
}

Update cluster.

Update cluster data.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
required	object

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"clusterData": {"cluster": 5,
"name": "Cluster-UPDATED",
"options": 3
}
}

Response samples

400

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

Get cluster data.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud required	number <double>
cluster required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"cluster": 5
}

Response samples

200
400

Content type

application/json

{"id": 2,
"fwcloud": 2,
"name": "Cluster-02",
"comment": null,
"created_at": "2019-05-17T11:47:00.000Z",
"updated_at": "2019-05-17T11:47:00.000Z",
"created_by": 0,
"updated_by": 0,
"nodes": [{"id": 10,
"cluster": 2,
"name": "node1",
"comment": null,
"status": 3,
"install_user": "",
"install_pass": "",
"save_user_pass": 1,
"install_interface": null,
"install_ipobj": null,
"fwmaster": 1,
"install_port": 22,
"interface_name": null,
"ip_name": null,
"ip": null,
"options": 3
}
]
}

Get cloud clusters.

Get all the cluster data for the indicated fwcloud.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2
}

Response samples

200
400

Content type

application/json

[{"id": 1,
"fwcloud": 2,
"name": "Cluster-01",
"comment": null,
"created_at": "2019-05-17T11:46:57.000Z",
"updated_at": "2019-05-17T11:46:57.000Z",
"created_by": 0,
"updated_by": 0
},
{"id": 2,
"fwcloud": 2,
"name": "Cluster-02",
"comment": null,
"created_at": "2019-05-17T11:47:00.000Z",
"updated_at": "2019-05-17T11:47:00.000Z",
"created_by": 0,
"updated_by": 0
}
]

Firewall to cluster.

Convert a firewall into a new cluster.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
firewall required	number <double>
node_id required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"firewall": 5,
"node_id": 391
}

Response samples

200
400

Content type

application/json

{"result": true,
"insertId": 6
}

Cluster to firewall.

Convert a cluster into a single firewall.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
cluster required	number <double>
node_id required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"cluster": 6,
"node_id": 391
}

Response samples

200
400

Content type

application/json

{"result": true,
"insertId": 12
}

Clone cluster.

Clone an existing cluster.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
cluster required	number <double>
name required	string
comment required	string
node_id required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"cluster": 5,
"name": "Cluster-CLONED",
"comment": "Comment for cloned cluster.",
"node_id": 391
}

Response samples

200
400

Content type

application/json

{"insertId": 7
}

Restrictions for cluster deletion.

Check if there are restrictions for cluster deletion.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud required	number <double>
cluster required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"cluster": 5
}

Response samples

403

Content type

application/json

{"result": true,
"restrictions": {"FirewallHasInterfaces": true
}
}

Delete cluster.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud required	number <double>
cluster required	number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2,
"cluster": 5
}

Response samples

400

Content type

application/json

{"fwcErr": 1002,
"msg": "Not found"
}

fwclouds

Endpoints under src/controllers/fwclouds/fwcloud.controller.ts

New FwCloud.

Create a new FWCloud.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
required

name required	string
image required	string
comment required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "FWCloud-01",
"image": "",
"comment": "Main customer cloud"
}

Response samples

201
403

Content type

application/json

{"status": 201,
"response": "Created",
"message": "",
"data": {"id": 1,
"name": "FWCloud-01",
"created_at": "2019-05-14T11:37:19.000Z",
"updated_at": "2019-05-14T11:37:19.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": null,
"locked_by": null,
"locked": 0,
"image": "",
"comment": "Main customer cloud"
}
}

Update FwCloud.

Update an existing FWCloud.

Authorizations:

(sessionCookieconfirmToken)

path Parameters

fwcloud

required

number <double>

Request Body schema: application/json
required

name required	string
image required	string
comment required	string

Responses

Request samples

Payload

Content type

application/json

{"name": "FWCloud-01-Updated",
"image": "",
"comment": "Updated description"
}

Response samples

200
404

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": {"id": 1,
"name": "FWCloud-01-Updated",
"created_at": "2019-05-14T11:37:19.000Z",
"updated_at": "2019-05-14T11:57:06.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": null,
"locked_by": null,
"locked": 0,
"image": "",
"comment": "Updated description"
}
}

Get FwCloud Colors.

Get FWCloud color usage details.

Authorizations:

sessionCookie

path Parameters

fwcloud

required

number <double>

Responses

Response samples

200
404

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": [{"color": "#4CAF50",
"count": 14
},
{"color": "#2196F3",
"count": 6
},
{"color": "#FF9800",
"count": 2
}
]
}

Get FwCloud Config.

Get global FWCloud-related configuration.

Authorizations:

sessionCookie

Responses

Response samples

200

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": {"availablecommunications": ["agent",
"ssh"
],
"auditLogs": {"internal": {"enabled": true,
"cron": {"enabled": true
},
"worker": {"enabled": true
},
"importer": {"enabled": true
}
}
}
}
}

fwcloud

Legacy endpoints under src/routes/fwcloud

Get allowed fwclouds.

Get fwcloud data for all the fwclouds to which the logged user has access.

Authorizations:

sessionCookie

Responses

Response samples

200
400

Content type

application/json

[{"id": 4,
"name": "FWCloud-02",
"created_at": "2019-05-14T11:37:19.000Z",
"updated_at": "2019-05-14T11:37:19.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": null,
"locked_by": null,
"locked": 0,
"image": "",
"comment": ""
},
{"id": 5,
"name": "FWCloud-03",
"created_at": "2019-05-14T11:37:24.000Z",
"updated_at": "2019-05-14T11:57:06.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": "2019-05-14T11:57:06.000Z",
"locked_by": 1,
"locked": 1,
"image": "",
"comment": ""
}
]

Get fwcloud data.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 3
}

Response samples

200
400

Content type

application/json

{"id": 3,
"name": "FWCloud-Updated",
"created_at": "2019-05-14T11:37:15.000Z",
"updated_at": "2019-05-14T11:37:54.000Z",
"created_by": 0,
"updated_by": 0,
"locked_at": "2019-05-14T11:37:51.000Z",
"locked_by": 1,
"locked": 1,
"image": "",
"comment": "Comment for the updated fwcloud."
}

Check delete restrictions.

Check if the fwcloud indicated as a parameter has any deletion restriction.

Authorizations:

sessionCookie

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2
}

Response samples

400

Content type

application/json

{"fwcErr": 7000,
"msg": "FWCloud access not allowed"
}

Delete fwcloud.

Delete the firewall cloud indicated in the request body.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2
}

Response samples

400

Content type

application/json

{"fwcErr": 7000,
"msg": "FWCloud access not allowed"
}

Lock fwcloud.

Lock fwcloud status.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2
}

Response samples

200

Content type

application/json

{"result": true,
"message": "FWCLOUD LOCKED OK"
}

Unlock fwcloud.

Unlock fwcloud status.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2
}

Response samples

200

Content type

application/json

{"result": true,
"message": "FWCLOUD UNLOCKED OK"
}

Force unlock fwcloud.

Force unlock fwcloud status.

Authorizations:

(sessionCookieconfirmToken)

Request Body schema: application/json
optional

fwcloud

required

number <double>

Responses

Request samples

Payload

Content type

application/json

{"fwcloud": 2
}

Response samples

200

Content type

application/json

{"result": true,
"message": "FWCLOUD FORCE UNLOCKED OK"
}

ping

Non-legacy ping endpoint

Session keepalive ping.

Keep current authenticated session alive.

Authorizations:

sessionCookie

Responses

Response samples

200
default

Content type

application/json

{"status": 200,
"response": "OK",
"message": "",
"data": null
}

FWCloud API (2.5.1)

FWCloud-API

What you can do with the API

Usage requirements

Recommended authentication flow

General request structure

Security and best practices

Official reference

user

Log into the API.

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Log out the API.

Authorizations:

Responses

New user.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Update user.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Modify logged user password.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Get user data.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Delete user.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Restrictions for user deletion.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Enable cloud access.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Disable cloud access.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

List of fwclouds with access.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

customer

New customer.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request samples

Response samples

Update customer.

Authorizations:

Request Body schema: application/jsonoptional

Responses

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
optional

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
optional