Topics Discussed
Request Methods
The API follows basic RESTful conventions and uses HTTP methods to describe the type of request that is being submitted.
In general, endpoints follow these guidelines:
|
Method |
Description |
|---|---|
|
GET |
Use this method to receive an array of objects from a collection. You can also use this method to receive a specific item from the collection. |
|
POST |
Use this method to create an object. |
|
PUT |
Use this method to update an object. Here, you will update the entire object. |
|
PATCH |
Use this method to update an object. Here, you will only submit the specific properties that should be updated. |
|
DELETE |
Use this method to delete an object. |
Object-Type Definitions
Firewall Rules
|
Name |
Description |
Type |
Required |
|---|---|---|---|
|
id |
The ID of the firewall rule |
Integer |
Optional |
|
destinations |
Array of RuleMember objects |
Array |
Required |
|
sources |
Array of RuleMember objects |
Array |
Required |
|
services |
Array of Service objects |
Array |
Required |
|
action |
Allow, block |
Enumeration |
Required |
|
name |
Name of the firewall rule |
String |
Required |
|
description |
Description of the firewall rule |
String |
Optional |
|
sortOrder |
Sort Order for the firewall rule |
Integer |
Required |
|
isEnabled |
Specifies whether the rule is enabled |
Boolean |
Required |
|
readonly |
Reserved for Armor defined rules, should always be false |
Boolean |
Required |
Rule Member
|
Name |
Description |
Type |
Required |
|---|---|---|---|
|
id |
The ID of the rule member |
Integer |
Required |
|
name |
The Name of the rule member |
String |
Required |
|
type |
"group," "any" |
Enumeration |
Required |
|
values |
Array of network addresses |
Array |
Optional (Only if type is group) |
Service
|
Name |
Description |
Type |
Required |
|---|---|---|---|
|
id |
ID of the service |
Integer |
Required |
|
deviceId |
ID of the device the service belongs to |
Integer |
Required |
|
location |
Name of the location |
String |
Required |
|
name |
Name of the service |
String |
Required |
|
description |
Name of the description |
String |
Optional |
|
values |
Array of ServiceValue |
Array |
Required |
Service Value
|
Name |
Description |
Type |
Required |
|---|---|---|---|
|
port |
Port of the service to open. Eithis this or minimum/maximum port ranges must be specified. |
Integer |
Optional |
|
protocol |
tcp, udp, icmp |
Enumeration |
Required |
|
subprotocol |
ICMP protocol only. Available enum values:
|
Enumeration |
Optional |
|
minimum |
The minimumport range for the service. If this is specified, maximum is required. Either this or "port" should be specified.
|
Integer |
Optional |
|
maximum |
The maximum port range for the service. If this is specified, minimum is required. Either this or "port" should be specified. |
Integer |
Optional |
Return Definitions
|
Return |
Description |
|---|---|
|
200 |
Your request is successful. |
|
202 |
Your request is accepted, but may take longer than usual to complete. |
|
400 |
Your request failed. |
|
404 |
Your resource does not exist. For example, the virtual machine you specified does not exist. |
|
500 |
An error occurred on the server side and cannot process the request. |