Download OpenAPI specification:Download
For authorization of all API requests you must send headers including your API Access Application ID as X-API-Client-ID
and your API token as X-API-Token
.
Note: Our product naming has changed, but in order to provide a stable API for our users the endpoints still reflect the old naming conventions. For example, many Airwall endpoints will use a path containing 'hipservice' and may expect a 'hipservice_id' these terms refer to the Airwall and the related Airwall ID.
Delete multiple alerts by ID, level, or both
An array of ID strings
alert_ids | object (alert_ids) |
level | string Delete all alerts of a specified level (valid: all, info, warning, error) |
Success
Unprocessable Entity
{- "alert_ids": [
- "bc50db3b-bb3d-4db2-a404-5a511c36228b",
- "9d063868-eba4-49e0-bdf8-f616ba68780d"
], - "level": "warning"
}
Returns a paginated list of alerts
limit | integer <int32> limit |
offset | integer <int32> offset |
order | string order |
ascending | boolean ascending |
filter | string Enum: "pending" "acknowledged" "info" "warning" "error" Filter alerts based on state |
search_term | string Filter alerts based on the search term |
Success
Unprocessable Entity
{- "data": [
- {
- "acknowledged_at": "2018-08-29T22:25:57.767Z",
- "acknowledged_by": "Local Administrator",
- "comment": null,
- "created_at": "2018-08-29T20:02:58.605Z",
- "event_action_id": null,
- "id": "bc50db3b-bb3d-4db2-a404-5a511c36228b",
- "level": "info",
- "message": "Airwall 'test-airwall-2' has gone back offline after being online.\n<div>\n <span class='label label-success'>\n Offline at: 2018-08-29 20:02:58 UTC\n </span>\n <span class='label label-warning indented-sm'>\n Online since: 2018-08-29 18:55:38 UTC\n </span>\n</div>\n",
- "monitorable_id": null,
- "monitorable_name": "test-airwall-2",
- "monitorable_type": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "subject": "Airwall has gone back offline"
}, - {
- "acknowledged_at": "2018-08-29T19:09:54.074Z",
- "acknowledged_by": "Local Administrator",
- "comment": null,
- "created_at": "2018-08-29T19:08:58.110Z",
- "event_action_id": "3c0e6d32-1664-4dba-9856-80f9cc7156aa",
- "id": "9d063868-eba4-49e0-bdf8-f616ba68780d",
- "level": "warning",
- "message": "<div>\n Airwall 'test-airwall1' has gone offline.\n</div>\n<div>\n <span class='label label-warning'>\n Offline at: 2018-08-29 19:08:58 UTC\n </span>\n</div>\n",
- "monitorable_id": "fd582c1c-2fc5-411f-8cd3-bc75f98779d9",
- "monitorable_name": "test-airwall1",
- "monitorable_type": "Endbox",
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "subject": "Airwall has gone offline"
}
], - "metadata": {
- "limit": 20,
- "next_offset": 2,
- "offset": 0,
- "total": 2
}
}
Acknowledge that you have seen multiple alerts
An array of ID strings
alert_ids required | Array of strings An array of ID strings |
Success
Not Found
Unprocessable Entity
{- "alert_ids": [
- "bc50db3b-bb3d-4db2-a404-5a511c36228b",
- "9d063868-eba4-49e0-bdf8-f616ba68780d"
]
}
[- {
- "acknowledged_at": "2018-08-29T22:33:08.202Z",
- "acknowledged_by": "Local Administrator",
- "comment": null,
- "created_at": "2018-08-29T19:08:58.110Z",
- "event_action_id": "3c0e6d32-1664-4dba-9856-80f9cc7156aa",
- "id": "9d063868-eba4-49e0-bdf8-f616ba68780d",
- "level": "warning",
- "message": "<div>\n Airwall 'test-airwall1' has gone offline.\n</div>\n<div>\n <span class='label label-warning'>\n Offline at: 2018-08-29 19:08:58 UTC\n </span>\n</div>\n",
- "monitorable_id": "fd582c1c-2fc5-411f-8cd3-bc75f98779d9",
- "monitorable_name": "test-airwall1",
- "monitorable_type": "Endbox",
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "subject": "Airwall has gone offline"
}, - {
- "acknowledged_at": "2018-08-29T22:33:08.202Z",
- "acknowledged_by": "Local Administrator",
- "comment": null,
- "created_at": "2018-08-29T20:02:58.605Z",
- "event_action_id": null,
- "id": "bc50db3b-bb3d-4db2-a404-5a511c36228b",
- "level": "info",
- "message": "Airwall 'test-airwall-2' has gone back offline after being online.\n<div>\n <span class='label label-success'>\n Offline at: 2018-08-29 20:02:58 UTC\n </span>\n <span class='label label-warning indented-sm'>\n Online since: 2018-08-29 18:55:38 UTC\n </span>\n</div>\n",
- "monitorable_id": null,
- "monitorable_name": "test-airwall-2",
- "monitorable_type": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "subject": "Airwall has gone back offline"
}
]
Returns a single alert
id required | string |
Success
Not Found
Unprocessable Entity
{- "acknowledged_at": "2018-08-29T22:25:57.767Z",
- "acknowledged_by": "Local Administrator",
- "comment": null,
- "created_at": "2018-08-29T20:02:58.605Z",
- "event_action_id": null,
- "id": "bc50db3b-bb3d-4db2-a404-5a511c36228b",
- "level": "info",
- "message": "Airwall 'test-airwall-2' has gone back offline after being online.\n<div>\n <span class='label label-success'>\n Offline at: 2018-08-29 20:02:58 UTC\n </span>\n <span class='label label-warning indented-sm'>\n Online since: 2018-08-29 18:55:38 UTC\n </span>\n</div>\n",
- "monitorable_id": null,
- "monitorable_name": "test-airwall-2",
- "monitorable_type": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "subject": "Airwall has gone back offline"
}
Acknowledge that you have seen and optionally leave a comment for an alert
id required | string |
Comment that will be seen by all people who have received this alert
Success
Not Found
Unprocessable Entity
"This alert is acknowledged"
{- "acknowledged_at": "2018-08-29T22:25:57.767Z",
- "acknowledged_by": "Local Administrator",
- "comment": null,
- "created_at": "2018-08-29T20:02:58.605Z",
- "event_action_id": null,
- "id": "bc50db3b-bb3d-4db2-a404-5a511c36228b",
- "level": "info",
- "message": "Airwall 'test-airwall-2' has gone back offline after being online.\n<div>\n <span class='label label-success'>\n Offline at: 2018-08-29 20:02:58 UTC\n </span>\n <span class='label label-warning indented-sm'>\n Online since: 2018-08-29 18:55:38 UTC\n </span>\n</div>\n",
- "monitorable_id": null,
- "monitorable_name": "test-airwall-2",
- "monitorable_type": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "subject": "Airwall has gone back offline"
}
Starts a job to create a database backup
Accepted
Bad Request
Forbidden
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to restore a database backup
backup required | string <binary> |
Accepted
Bad Request
Forbidden
Unprocessable Entity
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
[- {
- "id": "fbb60952-99fd-4e6a-9259-e816407ed3e0",
- "uuid": "fbb60952-99fd-4e6a-9259-e816407ed3e0",
- "provider_id": "azure",
- "creds": {
- "client_id": "aaaa1111-2222-3333-bbbb-cccc12345678",
- "tenant_id": "[filtered]",
- "default_region": "westus",
- "subscription_id": "aaaaaaaa-bbbb-0000-1111-87654321cccc",
- "client_secret_key": "[filtered]",
- "enable_route_injection": "alltraffic"
}
}, - {
- "id": "7933588b-c54d-4b9f-b61e-5fb489d181d4",
- "uuid": "7933588b-c54d-4b9f-b61e-5fb489d181d4",
- "provider_id": "google",
- "creds": {
- "private_key": "[filtered]",
- "client_email": "example@test-00000000.iam.gserviceaccount.com",
- "default_region": "us-central1",
- "google_project": "test-00000000",
- "enable_route_injection": "disabled"
}
}, - {
- "id": "4c527289-e551-45c3-96aa-5750854aacd8",
- "uuid": "4c527289-e551-45c3-96aa-5750854aacd8",
- "provider_id": "aws",
- "creds": {
- "aws_access_key": "[filtered]",
- "aws_secret_key": "[filtered]",
- "default_region": "us-west-1",
- "enable_route_injection": "individual"
}
}
]
Create a new cloud provider
default_region required | string [AWS, Azure, Google] Default Region |
aws_access_key | string [AWS] Access Key |
aws_secret_key | string [AWS] Secret Key |
client_id | string [Azure] Application ID |
tenant_id | string [Azure] Tenant ID |
subscription_id | string [Azure] Subscription ID |
client_secret_key | string [Azure] Application Key |
private_key | string [Google] Private Key |
client_email | string [Google] Client Email |
google_project | string [Google] Project ID |
enable_route_injection | string [AWS, Azure, Google] Route injection option (Optional) |
provider_id required | string [AWS, Azure, Google] Provider ID |
Created
Bad Request
Forbidden
Unprocessable Entity
{- "creds": {
- "aws_access_key": "AKIAIOSFODNN7EXAMPLE",
- "aws_secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
- "default_region": "us-west-1",
- "enable_route_injection": "individual"
}, - "provider_id": "aws"
}
{- "id": "fbb60952-99fd-4e6a-9259-e816407ed3e0",
- "uuid": "fbb60952-99fd-4e6a-9259-e816407ed3e0",
- "provider_id": "aws",
- "creds": {
- "aws_access_key": "[filtered]",
- "aws_secret_key": "[filtered]",
- "default_region": "us-west-1",
- "enable_route_injection": "individual"
}
}
Returns a cloud provider
providerId required | string Cloud Provider ID |
Ok
Not Found
{- "id": "4c527289-e551-45c3-96aa-5750854aacd8",
- "uuid": "4c527289-e551-45c3-96aa-5750854aacd8",
- "provider_id": "aws",
- "creds": {
- "aws_access_key": "[filtered]",
- "aws_secret_key": "[filtered]",
- "default_region": "us-west-1",
- "enable_route_injection": "individual"
}
}
Update the existing cloud provider credential (All fields are optional)
providerId required | string Cloud Provider ID |
default_region | string [AWS, Azure, Google] Default Region |
aws_access_key | string [AWS] Access Key |
aws_secret_key | string [AWS] Secret Key |
client_id | string [Azure] Application ID |
tenant_id | string [Azure] Tenant ID |
subscription_id | string [Azure] Subscription ID |
client_secret_key | string [Azure] Application Key |
private_key | string [Google] Private Key |
client_email | string [Google] Client Email |
google_project | string [Google] Project ID |
enable_route_injection | string [AWS, Azure, Google] Route injection option (Optional) |
Ok
Bad Request
Forbidden
Not Found
{- "creds": {
- "aws_access_key": "AKIAIOSFODNN7EXAMPLE",
- "aws_secret_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
- "default_region": "us-west-1",
- "enable_route_injection": "individual"
}
}
{- "id": "4c527289-e551-45c3-96aa-5750854aacd8",
- "uuid": "4c527289-e551-45c3-96aa-5750854aacd8",
- "provider_id": "aws",
- "creds": {
- "aws_access_key": "[filtered]",
- "aws_secret_key": "[filtered]",
- "default_region": "us-west-1",
- "enable_route_injection": "individual"
}
}
Delete an existing cloud provider credential
providerId required | string Cloud Provider ID |
Ok
Forbidden
Not Found
null
Starts a job to get a list of regions. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
Accepted
Forbidden
Not Found
{- "regions": [
- {
- "id": "ap-south-1",
- "name": "ap-south-1"
}, - {
- "id": "eu-west-3",
- "name": "eu-west-3"
}, - {
- "id": "eu-west-2",
- "name": "eu-west-2"
}, - {
- "id": "eu-west-1",
- "name": "eu-west-1"
}, - {
- "id": "ap-northeast-2",
- "name": "ap-northeast-2"
}, - {
- "id": "ap-northeast-1",
- "name": "ap-northeast-1"
}
], - "status": "complete"
}
Starts a job to get a region. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider Id |
regionId required | string Region Id |
Accepted
Forbidden
Not Found
{- "regions": {
- "id": "ap-south-1",
- "name": "ap-south-1"
}, - "status": "complete"
}
Starts a job to get a list of availability zones. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Availability Zone List: /api/v1/cloud_providers/aws/availability_zones?region=us-west-1 |
Accepted
Forbidden
Not Found
{- "availability_zones": [
- {
- "id": "us-west-1b",
- "state": "available"
}, - {
- "id": "us-west-1c",
- "state": "available"
}
], - "status": "complete"
}
Starts a job to get a availability zone. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider Id |
zoneId required | string Availability Zone Id |
region | string Availability Zone Get: /api/v1/cloud_providers/aws/availability_zones/us-west-1b?region=us-west-1 |
Accepted
Forbidden
Not Found
{- "availability_zone": {
- "id": "us-west-1b",
- "state": "available"
}, - "status": "complete"
}
Starts a job to get a list of networks or a single network. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Network List: /api/v1/cloud_providers/aws/networks?region=us-west-1 |
network_id | string Network Get: /api/v1/cloud_providers/aws/networks?region=us-west-1&network_id=vpc-1234abcde12345678 |
Accepted
Forbidden
Not Found
{- "networks": [
- {
- "id": "vpc-1234abcde12345678",
- "name": "test-net-vpc"
}, - {
- "id": "vpc-4567abcde87654321",
- "name": "test-net-vpc2"
}, - {
- "id": "vpc-abcd0000",
- "name": null
}
], - "status": "complete"
}
Starts a job to create a new network. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
Create a new network
type | string [AWS, Azure, Google] Network Type |
name required | string [AWS, Azure, Google] Network Name |
network_cidr | string [AWS, Azure] Network CIDR |
subnet_public_cidr required | string [AWS, Azure, Google] Public Subnet CIDR |
subnet_private_cidr | string [AWS, Azure, Google] Protected Subnet CIDR |
region | string [Google] Network Region |
zone | string [AWS] Network Subnet Availability Zone |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "name": "test-network",
- "network_cidr": "172.25.0.0/16",
- "subnet_public_cidr": "172.25.1.0/24",
- "subnet_private_cidr": "172.25.2.0/24",
- "region": "us-west-1",
- "zone": "us-west-1b"
}
{- "messages": [
- {
- "id": 24,
- "timestamp": "2018-11-01 22:49:24 UTC",
- "message_status": "running",
- "message": "CREATE_IN_PROGRESS AWS::EC2::SubnetRouteTableAssociation "
}, - {
- "id": 25,
- "timestamp": "2018-11-01 22:49:38 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::EC2::Route defaultroute"
}, - {
- "id": 26,
- "timestamp": "2018-11-01 22:49:40 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::EC2::SubnetRouteTableAssociation ProtectedSubnetRouteTableAssociation"
}, - {
- "id": 27,
- "timestamp": "2018-11-01 22:49:40 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::EC2::SubnetRouteTableAssociation PublicSubnetRouteTableAssociation"
}, - {
- "id": 28,
- "timestamp": "2018-11-01 22:49:41 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::CloudFormation::Stack test-net"
}
], - "status": "complete"
}
Starts a job to get a list of subnets or a single subnet. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Network Region |
network_id | string Subnet List: /api/v1/cloud_providers/aws/networks/subnets?region=us-west-1&network_id=vpc-1234abcde12345678 |
subnet_id | string Subnet Get: /api/v1/cloud_providers/aws/networks/subnets?region=us-west-1&network_id=vpc-1234abcde12345678&subnet_id=subnet-11110000aaaa67891 |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "subnets": [
- {
- "id": "subnet-01230000aaaa12345",
- "name": "test-net-ProtectedSubnet",
- "availability_zone": "us-west-1b"
}, - {
- "id": "subnet-11110000aaaa67891",
- "name": "test-net-PublicSubnet",
- "availability_zone": "us-west-1b"
}
], - "status": "complete"
}
Starts a job to get a list of routers or a single router. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Network Region |
network_id | string Router List (network_id is required for router list): /api/v1/cloud_providers/aws/networks/routers?region=us-west-1&network_id=vpc-1234abcde12345678 |
router_id | string Router Get (router_id is required for router get): /api/v1/cloud_providers/aws/networks/routers?region=us-west-1&router_id=rtb-11110000aaaa67891 |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "routers": [
- {
- "id": "rtb-01230000aaaa12345",
- "name": "test-net-PublicRouteTable",
- "subnet_id": [
- "subnet-00000000aaaa12345"
]
}, - {
- "id": "rtb-11110000aaaa67891",
- "name": "test-net-ProtectedRouteTable",
- "subnet_id": [
- "subnet-00000000aaaa12345"
]
}
], - "status": "complete"
}
Starts a job to get a list of routes in route table. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Network Region |
router_id | string Route List: /api/v1/cloud_providers/aws/networks/routes?region=us-west-1&router_id=rtb-11110000aaaa67891 |
subnet_id | string Route List (subnet_id is only required in Google): /api/v1/cloud_providers/aws/networks/routes?region=us-central1&router_id=rtb-11110000aaaa67891&subnet_id=test-net-pro-sub-uc1 |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "routes": [
- {
- "id": null,
- "router_id": "rtb-11110000aaaa67891",
- "destination_mask": "172.29.2.226/32",
- "target": "eni-0f77f42dece436f6e"
}, - {
- "id": null,
- "router_id": "rtb-11110000aaaa67891",
- "destination_mask": "192.168.7.77/32",
- "target": "eni-0f77f42dece436f6e"
}, - {
- "id": null,
- "router_id": "rtb-11110000aaaa67891",
- "destination_mask": "192.168.172.25/32",
- "target": "eni-0f77f42dece436f6e"
}, - {
- "id": null,
- "router_id": "rtb-11110000aaaa67891",
- "destination_mask": "172.21.0.0/16",
- "target": "local"
}
], - "status": "complete"
}
Starts a job to get a list of security groups or a single security group. Use GET /jobs/{id} to get the actual response.
Supported query parameters for security group list:
AWS:region=us-west-1&level=interface&instance_id=i-00000000abcd12345
Azure:region=westus&level=interface&instance_id=tn-azure-hs/tn-azure-hsVm
region=westus&level=subnet&instance_id=tn-azure-hs/tn-azure-hsVm
Google:region=us-central1&level=interface&instance_id=tn-google-hs-vm
region=us-central1&level=network&instance_id=tn-google-hs-vm
region=us-central1&level=account&instance_id=tn-google-hs-vm
providerId required | string Cloud Provider ID |
region | string Network Region |
level | string Security Group List (level is required for security group list): /api/v1/cloud_providers/aws/security_groups?region=us-west-1&level=interface&instance_id=i-00000000abcd12345 |
instance_id | string Security Group List (instance_id is required for security group list): /api/v1/cloud_providers/aws/security_groups?level=interface&instance_id=i-00000000abcd12345 |
security_group_id | string Security Group Get (security_group_id is required for security group get): /api/v1/cloud_providers/aws/security_groups?region=us-west-1&security_group_id=sg-00000000000000000 |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "security_groups": [
- {
- "id": "sg-02321fdbea12132e0",
- "name": "test-sg-instancesg-ABCDABCDABCD",
- "inbound": [
- {
- "protocol": "tcp",
- "port_range": [
- 8096
], - "source": [
- "0.0.0.0/0"
]
}, - {
- "protocol": "udp",
- "port_range": [
- 10500
], - "source": [
- "0.0.0.0/0"
]
}, - {
- "protocol": "icmp",
- "port_range": [
- -1
], - "source": [
- "0.0.0.0/0"
]
}
], - "outbound": [
- {
- "protocol": "-1",
- "port_range": [
- "*"
], - "destination": [
- "0.0.0.0/0"
]
}
]
}
], - "status": "complete"
}
Starts a job to get a list of images or a single image. Use GET /jobs/{id} to get the actual response.
List Airwall images:/api/v1/cloud_providers/aws/images?region=us-west-1
List Ubuntu images:/api/v1/cloud_providers/aws/images?region=us-west-1&os_id=ubuntu
List CentOS images:/api/v1/cloud_providers/aws/images?region=us-west-1&os_id=centos
Get an image:/api/v1/cloud_providers/aws/images?region=us-west-1&image_id=ami-00000000000000000
providerId required | string Cloud Provider ID |
region | string Image List: /api/v1/cloud_providers/aws/images?region=us-west-1 |
os_id | string Image List: /api/v1/cloud_providers/aws/images?region=us-west-1&os_id=ubuntu |
image_id | string Image Get: /api/v1/cloud_providers/aws/images?region=us-west-1&image_id=ami-00000000000000000 |
Accepted
Forbidden
Not Found
{- "images": [
- {
- "id": "ami-00000000000000000",
- "name": "Airwall-300v-hvm-r2.1.6-1357"
}, - {
- "id": "ami-00000000000000001",
- "name": "Airwall-300v-hvm-r2.1.5-1249"
}
], - "status": "complete"
}
Starts a job to get a list of cloud instance operating systems or a single cloud instance operating system. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
os_id | string Operating System Get: /api/v1/cloud_providers/aws/operating_systems?os_id=ubuntu Operating System List: /api/v1/cloud_providers/aws/operating_systems |
Accepted
Forbidden
Not Found
{- "operating_systems": [
- {
- "id": "ubuntu",
- "name": "ubuntu"
}, - {
- "id": "centos",
- "name": "centos"
}, - {
- "id": "redhat",
- "name": "redhat"
}
], - "status": "complete"
}
Starts a job to get a list of packages or a single package. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
os_id required | string Package List: /api/v1/cloud_providers/aws/packages?os_id=ubuntu |
package_id | string Package Get: /api/v1/cloud_providers/aws/packages?package_id=hipserver_2.2.1-226_amd64.deb&os_id=ubuntu |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "packages": [
- {
- "id": "hipserver_2.2.1-226_amd64.deb",
- "name": "ubuntu16:hipserver_2.2.1-226_amd64.deb"
}, - {
- "id": "hipserver_2.2.0-147_amd64.deb",
- "name": "ubuntu16:hipserver_2.2.0-147_amd64.deb"
}, - {
- "id": "hipserver_2.2.1-130_amd64.deb",
- "name": "ubuntu18:hipserver_2.2.1-130_amd64.deb"
}, - {
- "id": "hipserver_2.2.0-59_amd64.deb",
- "name": "ubuntu18:hipserver_2.2.0-59_amd64.deb"
}
], - "status": "complete"
}
Starts a job to get a list of keypairs or a single keypair. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Keypair List: /api/v1/cloud_providers/aws/keypairs?region=us-west-1 |
keypair_id | string Keypair Get: /api/v1/cloud_providers/aws/keypairs?region=us-west-1&keypair_id=mykeypair |
Accepted
Forbidden
Not Found
{- "keypairs": [
- {
- "id": "testkeypair",
- "name": "testkeypair"
}, - {
- "id": "mykeypair",
- "name": "mykeypair"
}, - {
- "id": "demokeypair",
- "name": "demokeypair"
}
], - "status": "complete"
}
Starts a job to get a list of flavors. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
region | string Flavor List: /api/v1/cloud_providers/aws/flavors?region=us-west-1 |
Accepted
Forbidden
Not Found
{- "flavors": [
- {
- "id": "t2.nano",
- "name": "T2 Nano Instance"
}, - {
- "id": "t2.micro",
- "name": "T2 Micro Instance"
}, - {
- "id": "t2.small",
- "name": "T2 Small Instance"
}, - {
- "id": "t2.medium",
- "name": "T2 Medium Instance"
}, - {
- "id": "t2.large",
- "name": "T2 Large Instance"
}, - {
- "id": "t2.xlarge",
- "name": "T2 Extra Large Instance"
}, - {
- "id": "t2.2xlarge",
- "name": "T2 Double Extra Large Instance"
}
], - "status": "complete"
}
Starts a job to get a flavor. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider Id |
flavorId required | string Flavor Id |
region | string Flavor Get: /api/v1/cloud_providers/aws/flavors/t2.medium?region=us-west-1 |
Accepted
Forbidden
Not Found
{- "flavor": {
- "id": "t2.medium",
- "name": "T2 Medium Instance"
}, - "status": "complete"
}
Starts a job to create a new cloud HIPservice. Use GET /jobs/{id} to get the actual response.
Example) Airwall server
{
"name": "test-hipserver-ubuntu",
"type": "hipserver",
"network_vpc",: "vpc-1234abcde12345678",
"subnet_public": "subnet-11110000aaaa67891",
"image_id": "ami-0dbf5ea29a7fc7e05",
"machine_type": "t2.medium",
"default_region": "us-west-1",
"conductor_url": "conductor.example.com",
"key_name": "demokeypair",
"package_url": "'https://temperedsoftware.s3.amazonaws.com/servers'",
"package_name": "airwall-ubuntu16_2.2.3-latest_amd64.deb",
"activation_code": "",
"custom_apps": ""
}
providerId required | string Cloud Provider ID |
Create a new cloud Airwall
type | string [HIPswitch, HIPserver][AWS, Azure, Google] HIPservice Type ('hipswitch' or 'hipserver') |
name required | string [HIPswitch, HIPserver][AWS, Azure, Google] HIPservice Name |
network_vpc | string [HIPswitch, HIPserver][AWS, Google] Network ID for AWS and Public Network ID for Google |
network_vpc_2 | string [HIPswitch][Google] Protected Network ID |
subnet_public required | string [HIPswitch, HIPserver][AWS, Azure, Google] Public Subnet ID |
subnet_private required | string [HIPswitch][AWS, Azure, Google] Protected Subnet ID |
image_id required | string [HIPswitch, HIPserver][AWS, Azure, Google] Image ID |
machine_type required | string [HIPswitch, HIPserver][AWS, Azure, Google] Machine Type |
conductor_url required | string [HIPswitch, HIPserver][AWS, Azure, Google] Conductor IP |
default_region required | string [HIPswitch, HIPserver][AWS, Azure, Google] Default Region |
availability_zone | string [HIPswitch, HIPserver][Google] Instance Zone |
key_name | string [HIPserver][AWS] Keypair Name |
admin_username | string [HIPserver][Azure] VM admin username |
admin_password | string [HIPserver][Azure] VM admin password |
ssh_username | string [HIPserver][Google] VM ssh key username |
ssh_key_data | string [HIPserver][Google] VM ssh key data |
package_url | string [HIPserver][AWS, Azure, Google] HIPserver package url |
package_name | string [HIPserver][AWS, Azure, Google] HIPserver package name |
activation_code | string [HIPserver][AWS, Azure, Google] HIPserver activation code |
custom_apps | string [HIPserver][AWS, Azure, Google] HIPserver custom apps |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "name": "test-hipswitch",
- "network_vpc": "vpc-1234abcde12345678",
- "subnet_public": "subnet-11110000aaaa67891",
- "subnet_private": "subnet-01230000aaaa12345",
- "image_id": "ami-cccc12345678bbbb0",
- "machine_type": "t2.medium",
- "conductor_url": "conductor.example.com",
- "default_region": "us-west-1"
}
{- "messages": [
- {
- "id": 19,
- "timestamp": "2018-11-05 19:27:36 UTC",
- "message_status": "running",
- "message": "CREATE_IN_PROGRESS AWS::EC2::EIPAssociation "
}, - {
- "id": 20,
- "timestamp": "2018-11-05 19:27:36 UTC",
- "message_status": "running",
- "message": "CREATE_IN_PROGRESS AWS::EC2::Instance "
}, - {
- "id": 21,
- "timestamp": "2018-11-05 19:27:51 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::EC2::EIPAssociation associateip"
}, - {
- "id": 22,
- "timestamp": "2018-11-05 19:27:52 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::EC2::Instance instance"
}, - {
- "id": 23,
- "timestamp": "2018-11-05 19:27:54 UTC",
- "message_status": "success",
- "message": "CREATE_COMPLETE AWS::CloudFormation::Stack test-airwall"
}
], - "status": "complete"
}
Returns a list of cloud Airwalls.
providerId required | string Cloud Provider ID |
Ok
Forbidden
Not Found
[- {
- "id": "a0000410-864c-4119-a933-32789f922608",
- "uuid": "a0000410-864c-4119-a933-32789f922608",
- "type": "HIPswitch",
- "description": null,
- "location": null,
- "active": false,
- "connected": false,
- "uid": "BHI@40130#EC2123ABC123",
- "underlay_ip": "172.21.1.179",
- "unassigned": true,
- "model": "Airwall-300v",
- "serial_number": "EC2123ABC123",
- "firmware_revision": "Airwall-x86_64_r2.2.0-311",
- "factory_reset_at": null,
- "managed": true,
- "firmware_install_at": "2019-06-03T15:26:35.000Z",
- "device_activity_reporting_interval": 300,
- "hit": "2001:11:1234:abcd:1234:abcd:abcd:1234",
- "lsi": "1.2.3.4",
- "tagged_by": [ ],
- "local_devices": [ ],
- "can_edit": true,
- "offline_at": "2019-06-12T23:52:33.597Z",
- "online_at": "2019-06-03T15:26:47.148Z",
- "packet_capture_started_at": null,
- "diagnostic_requested_at": null,
- "support_bundle_requested_at": null,
- "ha_compatible": false,
- "ha_available": false,
- "remote_session": null,
- "capabilities": [
- "lm",
- "m2",
- "eth",
- "data",
- "dhcp",
- "pcap",
- "soip",
- "block",
- "ccert",
- "relay",
- "modbus",
- "reboot",
- "revoke",
- "devices",
- "dual_rt",
- "esp_gcm",
- "dg_aware",
- "firewall",
- "sa_stats",
- "snort2.0",
- "diag_pcap",
- "diag_ping",
- "lm_reboot",
- "port_vlan",
- "dhcp_relay",
- "diag_iperf",
- "fw_upgrade",
- "port_stats",
- "diag_report",
- "hipopt.port",
- "net_devices",
- "overlay_mtu",
- "port_config",
- "check_online",
- "diag_tracert",
- "relay_probes",
- "restart_ebm2",
- "m2_http_proxy",
- "diag_check_sas",
- "esp_encryption",
- "port_expansion",
- "support_bundle",
- "capture_options",
- "diag_ping_peers",
- "platform_config",
- "capture_options+",
- "diag_ping_devices",
- "monitors-11111111",
- "limit_ft_bandwidth",
- "advanced_networking",
- "disable_auto_repair"
], - "version": "2.2.0",
- "title": "aws-hs1",
- "traffic_stats_interval": 300,
- "relay_probe_interval": 30,
- "tunnel_stats_interval": 0,
- "peer_autoconnect_interval": 0,
- "esp_encryption": "system",
- "esp_compress": "system",
- "product_model": "ISA-300v",
- "product_platform": "300v-103",
- "network_list": [ ],
- "enabled": true,
- "communication_disabled_through_groups": [ ],
- "hotfix_list": [ ],
- "underlay_ip_nat": "",
- "relay": false,
- "max_ft_bandwidth": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#EC2123ABC123",
- "ccert_dn_present": false,
- "ccert_csr_present": false,
- "ccert_present": false,
- "ccert_dn": null,
- "ccert_csr": null,
- "ccert_completed_at": null,
- "ccert": null,
- "cloud_attributes": {
- "instanceid": "i-abcd0000000000000",
- "interfaceid": "eni-abcd0000000000000",
- "provider": "aws",
- "provisionid": "aws-hs1",
- "region": "eu-central-1",
- "region_az": "eu-central-1c",
- "subnetid": "subnet-abcd0000000000000",
- "vpcid": "vpc-abcd0000000000000",
- "routetableid": "rtb-abcd0000000000000"
}, - "cloud_route_table_id": "rtb-abcd0000000000000",
- "link_manager": null,
- "path_mtu_enabled": true,
- "source_nat_enabled": false,
- "stp_enabled": true,
- "overlay_path_mtu": 1400,
- "intrusion_prevention_frequency": 300,
- "intrusion_prevention_link_id": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "nat": false,
- "transparent_mode": false,
- "device_auto_detect": false,
- "dhcp_settings": [ ]
}
]
Returns a single cloud Airwall.
providerId required | string Cloud Provider ID |
hipserviceId required | string Cloud Airwall ID |
Ok
Forbidden
Not Found
Unprocessable Entity
{- "id": "a0000410-864c-4119-a933-32789f922608",
- "uuid": "a0000410-864c-4119-a933-32789f922608",
- "type": "HIPswitch",
- "description": null,
- "location": null,
- "active": false,
- "connected": false,
- "uid": "BHI@40130#EC2123ABC123",
- "underlay_ip": "172.21.1.179",
- "unassigned": true,
- "model": "Airwall-300v",
- "serial_number": "EC2123ABC123",
- "firmware_revision": "Airwall-x86_64_r2.2.0-311",
- "factory_reset_at": null,
- "managed": true,
- "firmware_install_at": "2019-06-03T15:26:35.000Z",
- "device_activity_reporting_interval": 300,
- "hit": "2001:11:1234:abcd:1234:abcd:abcd:1234",
- "lsi": "1.2.3.4",
- "tagged_by": [ ],
- "local_devices": [ ],
- "can_edit": true,
- "offline_at": "2019-06-12T23:52:33.597Z",
- "online_at": "2019-06-03T15:26:47.148Z",
- "packet_capture_started_at": null,
- "diagnostic_requested_at": null,
- "support_bundle_requested_at": null,
- "ha_compatible": false,
- "ha_available": false,
- "remote_session": null,
- "capabilities": [
- "lm",
- "m2",
- "eth",
- "data",
- "dhcp",
- "pcap",
- "soip",
- "block",
- "ccert",
- "relay",
- "modbus",
- "reboot",
- "revoke",
- "devices",
- "dual_rt",
- "esp_gcm",
- "dg_aware",
- "firewall",
- "sa_stats",
- "snort2.0",
- "diag_pcap",
- "diag_ping",
- "lm_reboot",
- "port_vlan",
- "dhcp_relay",
- "diag_iperf",
- "fw_upgrade",
- "port_stats",
- "diag_report",
- "hipopt.port",
- "net_devices",
- "overlay_mtu",
- "port_config",
- "check_online",
- "diag_tracert",
- "relay_probes",
- "restart_ebm2",
- "m2_http_proxy",
- "diag_check_sas",
- "esp_encryption",
- "port_expansion",
- "support_bundle",
- "capture_options",
- "diag_ping_peers",
- "platform_config",
- "capture_options+",
- "diag_ping_devices",
- "monitors-11111111",
- "limit_ft_bandwidth",
- "advanced_networking",
- "disable_auto_repair"
], - "version": "2.2.0",
- "title": "aws-hs1",
- "traffic_stats_interval": 300,
- "relay_probe_interval": 30,
- "tunnel_stats_interval": 0,
- "peer_autoconnect_interval": 0,
- "esp_encryption": "system",
- "esp_compress": "system",
- "product_model": "ISA-300v",
- "product_platform": "300v-103",
- "network_list": [ ],
- "enabled": true,
- "communication_disabled_through_groups": [ ],
- "hotfix_list": [ ],
- "underlay_ip_nat": "",
- "relay": false,
- "max_ft_bandwidth": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#EC2123ABC123",
- "ccert_dn_present": false,
- "ccert_csr_present": false,
- "ccert_present": false,
- "ccert_dn": null,
- "ccert_csr": null,
- "ccert_completed_at": null,
- "ccert": null,
- "cloud_attributes": {
- "instanceid": "i-abcd0000000000000",
- "interfaceid": "eni-abcd0000000000000",
- "provider": "aws",
- "provisionid": "aws-hs1",
- "region": "eu-central-1",
- "region_az": "eu-central-1c",
- "subnetid": "subnet-abcd0000000000000",
- "vpcid": "vpc-abcd0000000000000",
- "routetableid": "rtb-abcd0000000000000"
}, - "cloud_route_table_id": "rtb-abcd0000000000000",
- "link_manager": null,
- "path_mtu_enabled": true,
- "source_nat_enabled": false,
- "stp_enabled": true,
- "overlay_path_mtu": 1400,
- "intrusion_prevention_frequency": 300,
- "intrusion_prevention_link_id": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "nat": false,
- "transparent_mode": false,
- "device_auto_detect": false,
- "dhcp_settings": [ ]
}
Starts a job to start a cloud Airwall. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
Start a cloud Airwall
instance_id required | string [AWS, Azure, Google] Airwall Instance ID |
region | string [AWS, Azure, Google] Airwall Instance Region |
Accepted
Forbidden
Not Found
{- "instance_id": "i-2222abcde11111111",
- "region": "us-west-1"
}
{- "operation": "start",
- "provider": "aws",
- "region": "us-west-1",
- "instanceid": "i-2222abcde11111111",
- "status": "complete"
}
Starts a job to stop a cloud Airwall. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
Stop a cloud Airwall
instance_id required | string [AWS, Azure, Google] Airwall Instance ID |
region | string [AWS, Azure, Google] Airwall Instance Region |
Accepted
Forbidden
Not Found
{- "instance_id": "i-2222abcde11111111",
- "region": "us-west-1"
}
{- "operation": "stop",
- "provider": "aws",
- "region": "us-west-1",
- "instanceid": "i-2222abcde11111111",
- "status": "complete"
}
Starts a job to reset a cloud Airwall. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
Reset a cloud Airwall
instance_id required | string [AWS, Azure, Google] Airwall Instance ID |
region | string [AWS, Azure, Google] Airwall Instance Region |
Accepted
Forbidden
Not Found
{- "instance_id": "i-2222abcde11111111",
- "region": "us-west-1"
}
{- "operation": "reset",
- "provider": "aws",
- "region": "us-west-1",
- "instanceid": "i-2222abcde11111111",
- "status": "complete"
}
Starts a job to snapshot a cloud Airwall. Use GET /jobs/{id} to get the actual response.
providerId required | string Cloud Provider ID |
Snapshot a cloud Airwall
instance_id required | string [AWS, Azure, Google] Airwall Instance ID |
region | string [AWS, Azure, Google] Airwall Instance Region |
Accepted
Forbidden
Not Found
{- "instance_id": "i-2222abcde11111111",
- "region": "us-west-1"
}
{- "operation": "snapshot",
- "provider": "aws",
- "region": "us-west-1",
- "instanceid": "i-2222abcde11111111",
- "status": "complete"
}
Delete multiple device groups.
Delete multiple device groups.
device_group_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Unprocessable Entity
{- "device_group_ids": [
- "a9890571-369a-4a77-a80b-8de89ed1f008",
- "4b191722-962f-4da9-9f91-abe5e8c9c89b"
]
}
Returns a collection of device groups.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
{- "data": [
- {
- "description": "API device_group created by automated testing.",
- "device_ids": [ ],
- "id": "a9890571-369a-4a77-a80b-8de89ed1f008",
- "name": "API device_group (non persistent)",
- "uuid": "a9890571-369a-4a77-a80b-8de89ed1f008"
}, - {
- "description": "API device_group2 created by automated testing.",
- "device_ids": [ ],
- "id": "4b191722-962f-4da9-9f91-abe5e8c9c89b",
- "name": "API device_group2 (non persistent)",
- "uuid": "4b191722-962f-4da9-9f91-abe5e8c9c89b"
}
], - "metadata": {
- "limit": 2,
- "offset": 0,
- "next_offset": 2,
- "total": 8,
- "next_page": "?paginate=true&offset=2&limit=2"
}
}
Create a new device group.
Create a new device group.
auto_recompute | boolean Automatically recompute after rules change (smart device groups only) |
description | string |
device_ids | Array of strings An array of ID strings |
enabled | boolean Network communications enabled |
name required | string Device group name |
require_accepted | boolean Ignore auto-discovered devices until accepted (smart device groups only) |
rule_editor_id | string Id of user that can edit device match rules for this group (smart device groups only) |
use_rules | boolean Use rules to add devices |
Created
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "auto_recompute": false,
- "description": "API device_group created by automated testing.",
- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "enabled": true,
- "name": "API device_group (non persistent)",
- "require_accepted": false,
- "use_rules": false
}
{- "description": "API device_group created by automated testing.",
- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "a9890571-369a-4a77-a80b-8de89ed1f008",
- "name": "API device_group (non persistent)",
- "uuid": "a9890571-369a-4a77-a80b-8de89ed1f008"
}
Returns a single device group.
id required | string Device Group ID |
Success
Forbidden
Not Found
Unprocessable Entity
{- "description": "API device_group created by automated testing.",
- "device_ids": [
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API device_group (non persistent)",
- "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}
Update an existing device group (All fields are optional).
id required | string Device Group ID |
Update an existing device group (All fields are optional).
auto_recompute | boolean Automatically recompute after rules change (smart device groups only) |
description | string Device group description |
device_ids | Array of strings An array of ID strings |
enabled | boolean Network communications enabled |
name | string Device group name |
require_accepted | boolean Ignore auto-discovered devices until accepted (smart device groups only) |
rule_editor_id | string Id of user that can edit device match rules for this group (smart device groups only) |
use_rules | boolean Use rules to add devices |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "auto_recompute": false,
- "description": "Security cameras device group.",
- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "enabled": true,
- "name": "Cameras-01",
- "require_accepted": false,
- "rule_editor_id": false,
- "use_rules": false
}
{- "auto_recompute": false,
- "description": "Security cameras device group.",
- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "enabled": true,
- "name": "Cameras-01",
- "require_accepted": false,
- "rule_editor_id": false,
- "use_rules": false,
- "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}
Add devices to an existing device group.
id required | string Device Group ID |
An array of ID strings
device_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
]
}
{- "description": "API device_group created by automated testing.",
- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API device_group (non persistent) - Patched",
- "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}
Remove devices from an existing device group.
id required | string Device Group ID |
An array of ID strings
device_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
]
}
{- "description": "API device_group created by automated testing.",
- "device_ids": [ ],
- "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API device_group (non persistent) - Patched",
- "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}
Directly set tag members for device_group.
id required | string Device Group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Refresh expiration time for tag(s) on device_group.
id required | string Device Group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Remove tag(s) from device_group.
id required | string Device Group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Add tag(s) to device_group.
id required | string Device Group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Returns a collection of all device match rules on a device group
deviceGroupId required | string Device Group ID |
Success
Forbidden
Unprocessable Entity
[- {
- "cidr": "192.168.23.0/24",
- "created_at": "2018-11-26T19:56:06.193Z",
- "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
- "negate": false,
- "only_match_overlay_device_ip": false,
- "operator": "+",
- "rule_order": 10,
- "type": "match_cidr",
- "updated_at": "2018-11-26T19:56:06.193Z"
}, - {
- "created_at": "2018-11-26T19:56:06.472Z",
- "hipservice_attribute": "name",
- "id": "751eaffb-206e-445c-846b-22c1ae4c3b61",
- "negate": true,
- "operator": "-",
- "rule_order": 30,
- "type": "match_hipservice_attribute",
- "updated_at": "2018-11-26T19:56:06.472Z",
- "value": "dontMatchThisName"
}
]
Creates a new device match rule on a device group
deviceGroupId required | string Device Group ID |
Device Match Rule
negate | boolean Default: false |
operator required | string Default: "include" Enum: "include" "exclude" "filter" Operator type for rule |
rule_order required | integer Priority of rule |
type required | string Enum: "match_cidr" "match_device_group" "match_hipservice" "match_hipservice_attribute" "match_hipservice_group" "match_inet" "match_mac_prefix" "match_range" "match_tag" "match_tag_search" Type of device match rule |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "match_cidr example": {
- "cidr": "10.10.10.0/24",
- "negate": false,
- "only_match_overlay_device_ip": true,
- "operator": "include",
- "rule_order": 10,
- "type": "match_cidr"
}, - "match_device_group example": {
- "device_group_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_device_group"
}, - "match_hipservice example": {
- "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_hipservice"
}, - "match_hipservice_attribute example": {
- "hipservice_attribute": "name",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_hipservice_attribute",
- "value": "101e-82.21"
}, - "match_hipservice_group example": {
- "hipservice_group_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_hipservice_group"
}, - "match_inet example": {
- "ip": "10.10.10.10",
- "negate": false,
- "netmask": "255.255.255.0",
- "only_match_overlay_device_ip": true,
- "operator": "include",
- "rule_order": 10,
- "type": "match_inet"
}, - "match_mac_prefix example": {
- "mac_prefix": "00:A0:C9",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_mac_prefix"
}, - "match_range example": {
- "ip_end": "10.10.10.30",
- "ip_start": "10.10.10.3",
- "negate": false,
- "only_match_overlay_device_ip": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_range"
}, - "match_tag example": {
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "tag_refs": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "TagName"
], - "taggable_type": "any",
- "type": "match_tag"
}, - "match_tag_search example": {
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "search_string": "ExpectedTagName",
- "taggable_type": "device",
- "type": "match_tag_search"
}, - "id": "device_match_rule"
}
{- "cidr": "192.168.23.0/24",
- "created_at": "2018-11-26T19:56:06.193Z",
- "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
- "negate": false,
- "only_match_overlay_device_ip": false,
- "operator": "+",
- "rule_order": 10,
- "type": "match_cidr",
- "updated_at": "2018-11-26T19:56:06.193Z"
}
Removes a device match rule from a device group
deviceGroupId required | string Device Group ID |
id required | string Device Match Rule ID |
Success
Forbidden
Not Found
Unprocessable Entity
Returns a single device match rule
deviceGroupId required | string Device Group ID |
id required | string Device Match Rule ID |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "cidr": "192.168.23.0/24",
- "created_at": "2018-11-26T19:56:06.193Z",
- "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
- "negate": false,
- "only_match_overlay_device_ip": false,
- "operator": "+",
- "rule_order": 10,
- "type": "match_cidr",
- "updated_at": "2018-11-26T19:56:06.193Z"
}
Updates a device match rule on a device group
deviceGroupId required | string Device Group ID |
id required | string Device Match Rule ID |
Device Match Rule
negate | boolean Default: false |
operator required | string Default: "include" Enum: "include" "exclude" "filter" Operator type for rule |
rule_order required | integer Priority of rule |
type required | string Enum: "match_cidr" "match_device_group" "match_hipservice" "match_hipservice_attribute" "match_hipservice_group" "match_inet" "match_mac_prefix" "match_range" "match_tag" "match_tag_search" Type of device match rule |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "match_cidr example": {
- "cidr": "10.10.10.0/24",
- "negate": false,
- "only_match_overlay_device_ip": true,
- "operator": "include",
- "rule_order": 10,
- "type": "match_cidr"
}, - "match_device_group example": {
- "device_group_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_device_group"
}, - "match_hipservice example": {
- "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_hipservice"
}, - "match_hipservice_attribute example": {
- "hipservice_attribute": "name",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_hipservice_attribute",
- "value": "101e-82.21"
}, - "match_hipservice_group example": {
- "hipservice_group_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_hipservice_group"
}, - "match_inet example": {
- "ip": "10.10.10.10",
- "negate": false,
- "netmask": "255.255.255.0",
- "only_match_overlay_device_ip": true,
- "operator": "include",
- "rule_order": 10,
- "type": "match_inet"
}, - "match_mac_prefix example": {
- "mac_prefix": "00:A0:C9",
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_mac_prefix"
}, - "match_range example": {
- "ip_end": "10.10.10.30",
- "ip_start": "10.10.10.3",
- "negate": false,
- "only_match_overlay_device_ip": false,
- "operator": "include",
- "rule_order": 10,
- "type": "match_range"
}, - "match_tag example": {
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "tag_refs": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "TagName"
], - "taggable_type": "any",
- "type": "match_tag"
}, - "match_tag_search example": {
- "negate": false,
- "operator": "include",
- "rule_order": 10,
- "search_string": "ExpectedTagName",
- "taggable_type": "device",
- "type": "match_tag_search"
}, - "id": "device_match_rule"
}
{- "cidr": "192.168.23.0/24",
- "created_at": "2018-11-26T19:56:06.193Z",
- "id": "c21e2a4d-9443-4a52-906a-da3cec1067fc",
- "negate": false,
- "only_match_overlay_device_ip": false,
- "operator": "+",
- "rule_order": 10,
- "type": "match_cidr",
- "updated_at": "2018-11-26T19:56:06.193Z"
}
Delete multiple devices.
Delete multiple devices.
device_ids required | Array of strings An array of ID strings |
Success
Forbidden
Unprocessable Entity
{- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
]
}
Returns a collection of devices.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
{- "data": [
- {
- "id": "1ca8cc06-338e-4d65-86ab-6b8d756b7422",
- "uuid": "1ca8cc06-338e-4d65-86ab-6b8d756b7422",
- "overlay_device_ip": "172.16.0.70",
- "mac": "00:50:56:b0:14:08",
- "name": "RE-cam-01",
- "description": "Room 101 camera 1",
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "last_activity_at": null,
- "mac_lockdown": false,
- "discovered": false,
- "enabled": true,
- "tagged_by": [ ],
- "port_group": 1
}, - {
- "id": "70263fd6-9b40-4807-8a9a-c3a186ca4ebc",
- "uuid": "70263fd6-9b40-4807-8a9a-c3a186ca4ebc",
- "overlay_device_ip": "172.16.0.74",
- "mac": "00:50:56:b0:19:84",
- "name": "RE-cam-02",
- "description": "Room 101 camera 2",
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "last_activity_at": null,
- "mac_lockdown": false,
- "discovered": false,
- "enabled": true,
- "tagged_by": [ ],
- "port_group": 1
}
], - "metadata": {
- "limit": 2,
- "next_offset": 2,
- "next_page": "?paginate=true&offset=2&limit=2",
- "offset": 0,
- "total": 8
}
}
Create a new device.
Create a new device.
description | string Device description |
enabled | boolean Default: true Network communication enabled |
hipservice_id required | string ID of parent Airwall Service |
mac | string MAC address |
mac_lockdown | boolean MAC address lockdown |
name | string Device name |
overlay_device_ip required | string Overlay ip |
port_group | integer Port affinity port group ID (-1 for auto-detect) |
Created
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "Room 101 camera 1",
- "enabled": true,
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "mac": "00:50:56:b0:14:08",
- "mac_lockdown": false,
- "name": "RE-cam-01",
- "overlay_device_ip": "172.16.0.70",
- "port_group": 1
}
{- "description": "Room 101 camera 1",
- "discovered": false,
- "enabled": true,
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "id": "1ca8cc06-338e-4d65-86ab-6b8d756b7422",
- "last_activity_at": null,
- "mac": "00:50:56:b0:14:08",
- "mac_lockdown": false,
- "name": "RE-cam-01",
- "overlay_device_ip": "172.16.0.70",
- "port_group": 1,
- "tagged_by": [ ],
- "uuid": "1ca8cc06-338e-4d65-86ab-6b8d756b7422"
}
Accept discovered device for multiple devices.
Accept discovered device for multiple devices.
device_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "device_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
]
}
Export devices in CSV file format.
Success
Unauthorized
Not Found
hipservice_id,device_name,overlay_device_ip,overlay_device_ip_nat,mac_address,mac_lockdown,BHI@40130#122B0252588C,tnw-device-1,192.168.2.10,,false,BHI@40130#5C201195E81D,tnw-device-2,198.168.100.3,,,false
Returns a single device.
id required | string Device ID |
Success
Forbidden
Not Found
Unprocessable Entity
{- "description": "Room 101 camera 1",
- "discovered": false,
- "enabled": true,
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "id": "1ca8cc06-338e-4d65-86ab-6b8d756b7422",
- "last_activity_at": null,
- "mac": "00:50:56:b0:14:08",
- "mac_lockdown": false,
- "name": "RE-cam-01",
- "overlay_device_ip": "172.16.0.70",
- "port_group": 1,
- "tagged_by": [ ],
- "uuid": "1ca8cc06-338e-4d65-86ab-6b8d756b7422"
}
Updates a device
id required | string Device ID |
Update an existing device (All fields are optional).
description | string Device description |
enabled | boolean Network communication enabled |
hipservice_id | string ID of parent Airwall Service |
mac | string MAC address |
mac_lockdown | boolean MAC address lockdown |
name | string Device name |
overlay_device_ip | string Overlay ip |
port_group | integer Port affinity port group ID (-1 for auto-detect) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "Room 101 camera 1",
- "enabled": true,
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "mac": "00:50:56:b0:14:08",
- "mac_lockdown": false,
- "name": "RE-cam-01",
- "overlay_device_ip": "172.16.0.70",
- "port_group": 1
}
{- "description": "Room 101 camera 1",
- "discovered": false,
- "enabled": true,
- "hipservice_id": "5f9cf106-6436-4980-8e3e-fd06537caa1a",
- "id": "1ca8cc06-338e-4d65-86ab-6b8d756b7422",
- "last_activity_at": null,
- "mac": "00:50:56:b0:14:08",
- "mac_lockdown": false,
- "name": "RE-cam-01",
- "overlay_device_ip": "172.16.0.70",
- "port_group": 1,
- "tagged_by": [ ],
- "uuid": "1ca8cc06-338e-4d65-86ab-6b8d756b7422"
}
Directly set tag members for device.
id required | string Device ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Refresh expiration time for tag(s) on device.
id required | string Device ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Remove tag(s) from device.
id required | string Device ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Add tag(s) to device.
id required | string Device ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
{- "address": "smtp.example.com",
- "authentication_type": "login",
- "enabled": true,
- "from_email_address": "mailer@example.com",
- "helo_domain": null,
- "openssl_verify_mode": "none",
- "password": "[filtered]",
- "port": 587,
- "subject_prefix": "test-config",
- "time_zone": "America/Los_Angeles",
- "tlsmail": true,
- "username": "mailer@example.com"
}
Update the existing email settings (All fields are optional)
Update the existing email settings (All fields are optional)
address | string |
authentication_type | string Type of authorization (e.g. none, plain, login, cram_md5) |
enabled | boolean |
from_email_address | string |
helo_domain | string |
openssl_verify_mode | string SSL verification mode (e.g. none, peer) |
password | string |
port | integer <int32> |
subject_prefix | string Prefix for subject line |
time_zone | string IANA standard string |
tlsmail | boolean |
username | string |
Success
Bad Request
{- "address": "smtp.example.com",
- "authentication_type": "login",
- "enabled": true,
- "from_email_address": "mailer@example.com",
- "helo_domain": "",
- "openssl_verify_mode": "",
- "password": "actualpassword",
- "port": 587,
- "subject_prefix": "test-config",
- "time_zone": "America/Los_Angeles",
- "tlsmail": true,
- "username": "mailer@example.com"
}
{- "address": "smtp.example.com",
- "authentication_type": "login",
- "enabled": true,
- "from_email_address": "mailer@example.com",
- "helo_domain": null,
- "openssl_verify_mode": "none",
- "password": "[filtered]",
- "port": 587,
- "subject_prefix": "test-config",
- "time_zone": "America/Los_Angeles",
- "tlsmail": true,
- "username": "mailer@example.com"
}
Set the Airwall Conductor email settings
address | string |
authentication_type | string Type of authorization (e.g. none, plain, login, cram_md5) |
enabled | boolean |
from_email_address | string |
helo_domain | string |
openssl_verify_mode | string SSL verification mode (e.g. none, peer) |
password | string |
port | integer <int32> |
subject_prefix | string Prefix for subject line |
time_zone | string IANA standard string |
tlsmail | boolean |
username | string |
Created
Bad Request
{- "address": "smtp.example.com",
- "authentication_type": "login",
- "enabled": true,
- "from_email_address": "mailer@example.com",
- "helo_domain": "",
- "openssl_verify_mode": "",
- "password": "actualpassword",
- "port": 587,
- "subject_prefix": "test-config",
- "time_zone": "America/Los_Angeles",
- "tlsmail": true,
- "username": "mailer@example.com"
}
{- "address": "smtp.example.com",
- "authentication_type": "login",
- "enabled": true,
- "from_email_address": "mailer@example.com",
- "helo_domain": null,
- "openssl_verify_mode": "none",
- "password": "[filtered]",
- "port": 587,
- "subject_prefix": "test-config",
- "time_zone": "America/Los_Angeles",
- "tlsmail": true,
- "username": "mailer@example.com"
}
Send a test email to the given address
email required | string |
Success
Bad Request
Unauthorized
Service Unavailable
{- "email": "test@example.com"
}
Delete multiple Airwall groups.
Delete multiple Airwall groups.
hipservices_group_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Unprocessable Entity
{- "hipservices_group_ids": [
- "12609b45-86dd-40c7-95f8-bd46c22fabe0",
- "e86b66c9-302c-42a4-b975-8416be1070f9"
]
}
Returns a collection of Airwall groups.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
{- "data": [
- {
- "description": "API airwall_group 001 created by automated testing.",
- "enabled": true,
- "hipservices_ids": [ ],
- "id": "12609b45-86dd-40c7-95f8-bd46c22fabe0",
- "name": "API airwall_group 001 (non persistent)",
- "relay_group": false,
- "uuid": "12609b45-86dd-40c7-95f8-bd46c22fabe0"
}, - {
- "description": "API airwall_group 002 created by automated testing.",
- "enabled": true,
- "hipservices_ids": [ ],
- "id": "e86b66c9-302c-42a4-b975-8416be1070f9",
- "name": "API airwall_group 002 (non persistent)",
- "relay_group": false,
- "uuid": "e86b66c9-302c-42a4-b975-8416be1070f9"
}
], - "metadata": {
- "limit": 2,
- "offset": 0,
- "next_offset": 2,
- "total": 8,
- "next_page": "?paginate=true&offset=2&limit=2"
}
}
Create a new Airwall group.
Create a new Airwall group.
description | string |
enabled | boolean Set enabled state of Airwall group |
hipservices_ids | Array of strings An array of ID strings |
name required | string |
relay_group | boolean Set whether this Airwall group is a relay group (all Airwalls must be relays to enable) |
Created
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "API Airwall group created by automated testing.",
- "enabled": true,
- "hipservices_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "name": "API Airwall group (non persistent)",
- "relay_group": true
}
{- "description": "API airwall_group created by automated testing.",
- "enabled": true,
- "hipservices_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
- "name": "API airwall_group (non persistent)",
- "relay_group": false,
- "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}
Returns a single Airwall group.
id required | string Airwall group ID |
Success
Forbidden
Not Found
Unprocessable Entity
{- "description": "API Airwall group created by automated testing.",
- "enabled": true,
- "hipservices_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
- "name": "API airwall_group (non persistent)",
- "relay_group": false,
- "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}
Update an existing Airwall group (All fields are optional).
id required | string Airwall group ID |
Update an existing Airwall group (All fields are optional).
description | string |
enabled | boolean Set enabled state of Airwall group |
hipservices_ids | Array of strings An array of ID strings |
name required | string |
relay_group | boolean Set whether this Airwall group is a relay group (all Airwalls must be relays to enable) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "API Airwall group created by automated testing.",
- "enabled": true,
- "hipservices_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "name": "API Airwall group (non persistent)",
- "relay_group": true
}
{- "description": "API airwall_group created by automated testing.",
- "enabled": true,
- "hipservices_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
- "name": "API airwall_group (non persistent)",
- "relay_group": false,
- "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}
Directly set tag members for Airwall group.
id required | string Airwall group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Refresh expiration time for tag(s) on Airwall group.
id required | string Airwall group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Remove tag(s) from Airwall group.
id required | string Airwall group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Add tag(s) to Airwall group.
id required | string Airwall group ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Delete multiple revoked Airwalls.
List of Airwall IDs.
hipservice_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Unprocessable Entity
{- "hipservice_ids": [
- "12609b45-86dd-40c7-95f8-bd46c22fabe0",
- "e86b66c9-302c-42a4-b975-8416be1070f9"
]
}
Returns a collection of Airwalls.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
{- "data": [
- {
- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "ha",
- "ha2.0",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-1111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": true,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": 300,
- "device_auto_detect": true,
- "dhcp": null,
- "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
- "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-27T16:17:20.000Z",
- "firmware_revision": "Airwall-x86_64_r2.1.3-951",
- "ha_available": false,
- "ha_compatible": true,
- "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
- "hotfix_list": [ ],
- "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "location": "VMWARE. - PATCHED",
- "lsi": "1.115.218.191",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "Airwall-300v",
- "nat": false,
- "network_list": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "offline_at": "2018-08-28T18:24:42.180Z",
- "online_at": "2018-08-28T18:24:48.093Z",
- "overlay_gateway_ip": "192.168.2.10",
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-101",
- "relay": false,
- "remote_session": null,
- "serial_number": "42308D510FB2",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "title": "HS-168.3.51",
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#42308D510FB2",
- "unassigned": false,
- "underlay_ip": "192.168.3.51",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "version": "2.1.3"
}, - {
- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "ha",
- "ha2.0",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-1111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": false,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": 300,
- "device_auto_detect": true,
- "dhcp": null,
- "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#4230063FED68",
- "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-27T16:17:21.000Z",
- "firmware_revision": "Airwall-x86_64_r2.1.3-951",
- "ha_available": false,
- "ha_compatible": true,
- "hit": "2001:14:705e:5b2e:d6a2:429f:ae66:1479",
- "hotfix_list": [ ],
- "id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "location": "VMWARE. - PATCHED",
- "lsi": "1.102.20.121",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "Airwall-300v",
- "nat": false,
- "network_list": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "offline_at": "2018-08-28T18:28:42.287Z",
- "online_at": "2018-08-28T18:26:39.252Z",
- "overlay_gateway_ip": "192.168.100.13",
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-101",
- "relay": false,
- "remote_session": null,
- "serial_number": "4230063FED68",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "title": "HS-168.3.51",
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#4230063FED68",
- "unassigned": false,
- "underlay_ip": "192.168.101.15",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "version": "2.1.3"
}
], - "metadata": {
- "limit": 2,
- "next_offset": 2,
- "next_page": "?paginate=true&offset=2&limit=2",
- "offset": 0,
- "total": 8
}
}
Deactivate the Airwall.
List of Airwall IDs.
hipservice_ids required | Array of strings An array of ID strings |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "hipservice_ids": [
- "12609b45-86dd-40c7-95f8-bd46c22fabe0",
- "e86b66c9-302c-42a4-b975-8416be1070f9"
]
}
{- "result": "success"
}
Remove a failover group from the Airwall
hipserviceId required | string Airwall ID |
id required | string Failover group ID |
Success
Forbidden
Not Found
{ }
Returns a failover group
hipserviceId required | string Airwall ID |
id required | string Failover group ID |
Success
Forbidden
Not Found
{- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "disable_auto_repair": false,
- "id": 1,
- "name": "Failover group 1",
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 6,
- "ping_ttl": 255,
- "traffic_types": [
- "hip"
]
}
Update failover group on the Airwall
hipserviceId required | string Airwall ID |
id required | string Failover group ID |
name | string Group name |
ping_ttl | integer [ 1 .. 255 ] Default: 255 Number of hops ping will travel to reach destination |
ping_rate | integer [ 10 .. 600 ] Default: 30 Seconds between pings |
ping_timeout | integer [ 1 .. 30 ] Default: 5 Seconds before ping times out |
ping_failure_count | integer [ 1 .. 5 ] Default: 2 Number of times ping fails before link failover |
disable_active_link_pings | boolean Disable pings on the active link |
dest_conductor | boolean Use the Conductor as the ping destination |
dest_other_ips | Array of strings Array of other IPs to ping |
traffic_types | Array of strings Items Enum: "hip" "map" "relay" Traffic types allowed |
disable_auto_repair | boolean Disable link auto repair |
reboot | boolean Reboot if no links are available (only for Airwalls pre version 2.2.0) |
reboot_th_s | integer Minimum wait time after reboot in seconds (only for Airwalls pre version 2.2.0) |
reboot_recurring_th_s | integer Minimum wait time after failure in seconds (only for Airwalls pre version 2.2.0) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "name": "Failover Group 1",
- "ping_ttl": 255,
- "ping_rate": 30,
- "ping_timeout": 6,
- "ping_failure_count": 1,
- "disable_active_link_pings": false,
- "dest_conductor": true,
- "dest_other_ips": [
- "8.8.8.8",
- "1.2.3.4"
], - "traffic_types": [
- "hip",
- "map",
- "relay"
], - "disable_auto_repair": true,
- "reboot": true,
- "reboot_th_s": 60,
- "reboot_recurring_th_s": 600
}
{- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "disable_auto_repair": false,
- "id": 1,
- "name": "Failover group 1",
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 6,
- "ping_ttl": 255,
- "traffic_types": [
- "hip"
]
}
Returns a single Airwall.
id required | string Airwall ID |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "ha",
- "ha2.0",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-1111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": true,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": 300,
- "device_auto_detect": true,
- "dhcp": null,
- "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
- "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-27T16:17:20.000Z",
- "firmware_revision": "Airwall-x86_64_r2.1.3-951",
- "ha_available": false,
- "ha_compatible": true,
- "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
- "hotfix_list": [ ],
- "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "location": "VMWARE. - PATCHED",
- "lsi": "1.115.218.191",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "Airwall-300v",
- "nat": false,
- "network_list": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "offline_at": "2018-08-28T18:24:42.180Z",
- "online_at": "2018-08-28T18:24:48.093Z",
- "overlay_gateway_ip": "192.168.2.10",
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-101",
- "relay": true,
- "remote_session": null,
- "serial_number": "42308D510FB2",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "title": "HS-168.3.51",
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#42308D510FB2",
- "unassigned": false,
- "underlay_ip": "192.168.3.51",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "version": "2.1.3"
}
Update an existing Airwall (All fields are optional).
id required | string Airwall ID |
Update an existing Airwall (All fields are optional).
active | string |
ccert | string |
ccert_dn | string |
description | string |
device_activity_reporting_interval | string |
device_auto_detect | string |
dhcp | object (dhcp) |
enabled | string |
esp_encryption | string |
esp_compress | boolean |
exclusive_mode | string deprecated |
ha_ip | string |
ha_partner_id | string |
intrusion_prevention_frequency | integer Frequency that the intrusion detection system should processes alerts (in seconds) |
intrusion_prevention_link_id | integer Link to monitor with the intrusion prevention system |
location | string |
nat | string |
overlay_device_ip | string Overlay Device IP (for Airwall client) |
overlay_device_netmask | string Overlay Device Netmask (for Airwall client) |
overlay_gateway_ip | string |
overlay_netmask | string |
packet_capture_started | string |
path_mtu_enabled | boolean Enable path MTU detection (requires Advanced Networking) |
source_nat_enabled | boolean Enable source NAT (requires Advanced Networking) |
stp_enabled | boolean Enable spanning tree protocol (requires Advanced Networking) |
title | string |
transparent_mode | string |
two_factor_auth | string deprecated |
underlay_ip_nat | string |
user_auth | boolean User auth enabled (for Airwall client) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
[- {
- "active": true,
- "ccert": null,
- "ccert_dn": null,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": "300",
- "device_auto_detect": true,
- "dhcp": {
- "dhcp_type": "server",
- "gateway": "10.0.1.1",
- "lease_time": "24h",
- "netmask": "255.255.255.0",
- "range_begin": "10.0.1.100",
- "range_end": "10.0.1.199"
}, - "enabled": true,
- "esp_encryption": "AES256_GCM",
- "esp_compress": false,
- "exclusive_mode": false,
- "ha_ip": null,
- "ha_partner_id": null,
- "location": "VMWARE. - PATCHED",
- "nat": false,
- "overlay_device_ip": null,
- "overlay_device_netmask": null,
- "overlay_gateway_ip": "192.168.2.10",
- "overlay_netmask": "255.255.255.0",
- "packet_capture_started": null,
- "path_mtu_enabled": true,
- "source_nat_enabled": true,
- "stp_enabled": true,
- "title": "HS-168.2.10",
- "transparent_mode": false,
- "two_factor_auth": null,
- "underlay_ip_nat": "203.0.113.254",
- "user_auth": false
}, - {
- "active": true,
- "ccert": null,
- "ccert_dn": null,
- "description": "AUTOMATION 2 - PATCHED",
- "device_activity_reporting_interval": "300",
- "device_auto_detect": true,
- "dhcp": {
- "dhcp_type": "relay",
- "upstream_server": "10.10.2.100"
}, - "enabled": true,
- "esp_encryption": "AES256_GCM",
- "esp_compress": false,
- "exclusive_mode": false,
- "ha_ip": null,
- "ha_partner_id": null,
- "intrusion_prevention_frequency": 300,
- "intrusion_prevention_link_id": 1,
- "location": "VMWARE. - PATCHED 2",
- "nat": false,
- "overlay_device_ip": null,
- "overlay_device_netmask": null,
- "overlay_gateway_ip": "192.168.2.11",
- "overlay_netmask": "255.255.255.0",
- "packet_capture_started": null,
- "path_mtu_enabled": true,
- "source_nat_enabled": true,
- "stp_enabled": true,
- "title": "HS-168.2.11",
- "transparent_mode": false,
- "two_factor_auth": null,
- "underlay_ip_nat": "203.0.113.253",
- "user_auth": false
}
]
{- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "ha",
- "ha2.0",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-1111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": true,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": 300,
- "device_auto_detect": true,
- "dhcp": null,
- "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
- "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-27T16:17:20.000Z",
- "firmware_revision": "Airwall-x86_64_r2.1.3-951",
- "ha_available": false,
- "ha_compatible": true,
- "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
- "hotfix_list": [ ],
- "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "location": "VMWARE. - PATCHED",
- "lsi": "1.115.218.191",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "Airwall-300v",
- "nat": false,
- "network_list": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "offline_at": "2018-08-28T18:24:42.180Z",
- "online_at": "2018-08-28T18:24:48.093Z",
- "overlay_gateway_ip": "192.168.2.10",
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-101",
- "relay": true,
- "remote_session": null,
- "serial_number": "42308D510FB2",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "title": "HS-168.3.51",
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#42308D510FB2",
- "unassigned": false,
- "underlay_ip": "192.168.3.51",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "version": "2.1.3"
}
Sends a blink LED request to the Airwall.
id required | string Airwall ID |
Success
Not Found
Unprocessable Entity
{ }
Starts a job to get the list of Airwalls communicating through this relay.
id required | string Airwall ID |
Accepted
Forbidden
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to get the status of probes to HIPrelays.
id required | string Airwall ID |
Accepted
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to check the signal on a given port
id required | string Airwall ID |
uci_name required | string Name of port |
port_type required | string Enum: "cellular" "wireless" Type of port |
Accepted
Not Found
Unprocessable Entity
{- "uci_name": "cell0",
- "port_type": "cellular"
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to check the status of secure tunnels on the Airwall
id required | string Airwall ID |
create | boolean Build new tunnels if none exist |
Accepted
Forbidden
Not Found
{- "create": true
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
List all Airwall devices
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "description": null,
- "discovered": false,
- "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "id": "d26c6941-60d3-42ec-8987-f58d39d098aa",
- "last_activity_at": null,
- "mac": null,
- "mac_lockdown": false,
- "name": "Device-168.2.10",
- "overlay_device_ip": "192.168.2.10",
- "uuid": "d26c6941-60d3-42ec-8987-f58d39d098aa"
}
]
Show a diagnostic report
id required | string Airwall ID |
Success
Forbidden
Not Found
"string"
Start a job to request a Airwall diagnostic report
id required | string Airwall ID |
Accepted
Forbidden
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Export local devices to csv file.
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
airwall_id,device_name,overlay_device_ip,overlay_device_ip_nat,mac_address,mac_lockdown,BHI@40130#122B0252588C,tnw-device-1,192.168.2.10,,false,BHI@40130#5C201195E81D,tnw-device-2,198.168.100.3,,,false
Returns the existing failover groups
id required | string Airwall ID |
Created
Forbidden
Not Found
[- {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "disable_auto_repair": false,
- "id": 1,
- "name": "Failover group 1",
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 6,
- "ping_ttl": 255,
- "traffic_types": [
- "hip"
]
}, - {
- "dest_conductor": true,
- "dest_other_ips": "8.8.8.8",
- "disable_active_link_pings": false,
- "disable_auto_repair": false,
- "id": 2,
- "name": "Failover group 2",
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255,
- "traffic_types": [
- "hip",
- "map",
- "relay"
]
}
]
Add a new failover group to the Airwall
id required | string Airwall ID |
name | string Group name |
ping_ttl | integer [ 1 .. 255 ] Default: 255 Number of hops ping will travel to reach destination |
ping_rate | integer [ 10 .. 600 ] Default: 30 Seconds between pings |
ping_timeout | integer [ 1 .. 30 ] Default: 5 Seconds before ping times out |
ping_failure_count | integer [ 1 .. 5 ] Default: 2 Number of times ping fails before link failover |
disable_active_link_pings | boolean Disable pings on the active link |
dest_conductor | boolean Use the Conductor as the ping destination |
dest_other_ips | Array of strings Array of other IPs to ping |
traffic_types | Array of strings Items Enum: "hip" "map" "relay" Traffic types allowed |
disable_auto_repair | boolean Disable link auto repair |
reboot | boolean Reboot if no links are available (only for Airwalls pre version 2.2.0) |
reboot_th_s | integer Minimum wait time after reboot in seconds (only for Airwalls pre version 2.2.0) |
reboot_recurring_th_s | integer Minimum wait time after failure in seconds (only for Airwalls pre version 2.2.0) |
Created
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "name": "Failover Group 1",
- "ping_ttl": 255,
- "ping_rate": 30,
- "ping_timeout": 6,
- "ping_failure_count": 1,
- "disable_active_link_pings": false,
- "dest_conductor": true,
- "dest_other_ips": [
- "8.8.8.8",
- "1.2.3.4"
], - "traffic_types": [
- "hip",
- "map",
- "relay"
], - "disable_auto_repair": true,
- "reboot": true,
- "reboot_th_s": 60,
- "reboot_recurring_th_s": 600
}
{- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "disable_auto_repair": false,
- "id": 1,
- "name": "Failover group 1",
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 6,
- "ping_ttl": 255,
- "traffic_types": [
- "hip"
]
}
Returns the existing global failover settings
id required | string Airwall ID |
Success
Forbidden
Not Found
{- "reboot": true,
- "reboot_recurring_th_s": 1000,
- "reboot_th_s": 180
}
Update the existing global failover settings
id required | string Airwall ID |
reboot required | boolean Reboot if no links are available |
reboot_recurring_th_s required | integer Min. wait time after reboot (secs) |
reboot_th_s required | integer Min. wait time after failure (secs) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "reboot": true,
- "reboot_recurring_th_s": 1000,
- "reboot_th_s": 180
}
{- "reboot": true,
- "reboot_recurring_th_s": 1000,
- "reboot_th_s": 180
}
Returns Airwall health data.
id required | string Airwall ID |
timestamp | string <iso8601> Health data range begin |
timestamp_end | string <iso8601> Health data rage end |
filter | integer <int32> All health data of at least this log level |
offset | integer <int32> offset |
limit | integer Default: 20 limit |
ascending | boolean Default: false ascending |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "data": [
- {
- "entry": {
- "fds": "46",
- "ip": "192.168.2.10",
- "link_pri": "15",
- "load": "0.00",
- "map": "446",
- "mem": "944808",
- "ol_ports": "1",
- "opmode": "hip",
- "sadb_nlsi": "1",
- "sadb_relay": "0",
- "svc_restarts": "47",
- "up": "927"
}, - "level": 2,
- "timestamp": "2018-08-27 16:25:00.000000"
}, - {
- "entry": {
- "fds": "46",
- "ip": "192.168.2.10",
- "link_pri": "15",
- "load": "0.00",
- "map": "146",
- "mem": "945076",
- "ol_ports": "1",
- "opmode": "hip",
- "sadb_nlsi": "1",
- "sadb_relay": "0",
- "svc_restarts": "47",
- "up": "627"
}, - "level": 2,
- "timestamp": "2018-08-27 16:20:00.000000"
}, - {
- "entry": {
- "bridge_up.sh": "hip0 joined the bridge successfully"
}, - "level": 2,
- "timestamp": "2018-08-27 16:18:02.130855"
}
], - "metadata": {
- "limit": 3,
- "next_offset": 3,
- "offset": 0,
- "total": 8233
}
}
]
Sets the Airwall state to managed.
id required | string Airwall ID |
Success
Bad Request
Not Found
Unprocessable Entity
{- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-11111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "relay_probes",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": true,
- "description": null,
- "device_activity_reporting_interval": 300,
- "device_auto_detect": false,
- "dhcp": null,
- "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#6ED7E57DBFDA",
- "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-30T22:36:17.000Z",
- "firmware_revision": "Airwall-x86_64_r2.1.4-1067",
- "ha_available": false,
- "ha_compatible": false,
- "hit": "2001:14:b61d:8183:d115:96e:229e:51f1",
- "hotfix_list": [ ],
- "id": "f106b324-afc3-409b-b48f-2de28cacfb5d",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [ ],
- "location": null,
- "lsi": "1.158.81.241",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "Airwall-300v",
- "nat": false,
- "network_list": [ ],
- "offline_at": null,
- "online_at": "2018-08-30T22:36:31.581Z",
- "overlay_gateway_ip": null,
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-108",
- "relay": false,
- "remote_session": null,
- "serial_number": "6ED7E57DBFDA",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "title": null,
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#6ED7E57DBFDA",
- "unassigned": true,
- "underlay_ip": "192.168.184.2",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "f106b324-afc3-409b-b48f-2de28cacfb5d",
- "version": "2.1.4"
}
List Airwall overlay routes
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "gateway": "192.168.2.1",
- "hipservice_id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "id": "51778896-ebe0-4f01-b804-572265ff1ecf",
- "network": "192.168.2.0/24"
}
]
Stop a packet capture on a Airwall (will cause the Airwall to upload what has been captured up until this call)
id required | string Airwall ID |
Success
Accepted
Forbidden
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Start a job to request a packet capture on the Airwall
id required | string Airwall ID |
capture_interface required | string Interface to capture on |
ip_address | string IP address to capture |
max_bandwidth | integer Maximum bandwidth to use on PCAP upload (KB) |
max_size | integer Max size of PCAP (MB) |
max_time | integer Time limit for packet capture (in minutes) |
port | integer Port to capture |
protocol | string Protocol to capture (any, icmp, tcp, udp, arp) |
Accepted
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "capture_interface": "hip0",
- "ip_address": "192.168.1.101",
- "max_bandwidth": 1000,
- "max_size": 100,
- "max_time": 1,
- "port": 80,
- "protocol": "any"
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to ping a given IP or hostname
id required | string Airwall ID |
ip_address required | string IP address or hostname to ping |
network required | string Enum: "overlay_network" "underlay_network" Network to ping on |
port_group | integer Id of the desired port group to run ping on. If only one overlay port group exists it will be used by default. This parameter is only required for Airwalls version 2.2.0 or later. |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "ip_address": "192.168.1.101",
- "network": "overlay_network",
- "port_group": 1
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to ping all devices on the Airwall
id required | string Airwall ID |
Accepted
Forbidden
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to ping all peer Airwalls. Results include ping status and HIP traffic status (bex) as booleans.
id required | string Airwall ID |
Accepted
Forbidden
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Returns the existing port config
id required | string Airwall ID |
Success
Forbidden
Not Found
{- "port_groups": [
- {
- "id": 1,
- "interfaces": [
- "port1"
], - "ip_configs": [
- {
- "addrfam": "ipv4",
- "proto": "dhcp"
}
], - "name": "corp network 3",
- "prio": 0,
- "role": "shared",
- "routes": [ ],
- "traffic_types": [
- "hip",
- "map",
- "relay"
]
}, - {
- "id": 2,
- "interfaces": [
- "port1.1234",
- "port2"
], - "ip_configs": [
- {
- "addrfam": "ipv4",
- "ipaddr": "192.168.1.199/24",
- "proto": "static"
}
], - "prio": 0,
- "role": "device",
- "routes": [ ]
}, - {
- "id": 3,
- "interfaces": [ ],
- "ip_configs": [
- {
- "addrfam": "ipv4",
- "proto": "static"
}, - {
- "addrfam": "ipv6",
- "proto": "dhcp"
}
], - "prio": 0,
- "role": "shared",
- "routes": [
- { }
], - "traffic_types": [
- "hip",
- "map",
- "relay"
]
}, - {
- "id": 4,
- "interfaces": [ ],
- "ip_configs": [ ],
- "role": "disabled"
}
], - "ports": [
- {
- "interfaces": [
- {
- "ifname": "port1"
}, - {
- "ifname": "port1.1234",
- "vlan": true,
- "vlan_parent": "port1",
- "vlan_tag": 1234
}, - {
- "ifname": "port1.987",
- "vlan": true,
- "vlan_parent": "port1",
- "vlan_tag": "987"
}
], - "label": "port1",
- "num": 1,
- "slot": 1,
- "type": "wired"
}, - {
- "interfaces": [
- {
- "ifname": "port2"
}
], - "label": "port2",
- "num": 2,
- "slot": 1,
- "type": "wired"
}, - {
- "interfaces": [
- {
- "ifname": "port3"
}
], - "label": "port3",
- "num": 3,
- "slot": 1,
- "type": "wifi"
}
]
}
Start a job to replace the existing port config
id required | string Airwall ID |
port_groups required | Array of objects (Port Group) Array of port groups |
ports required | Array of objects (Port config) Array of ports |
Accepted
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "port_groups": [
- {
- "id": 1,
- "interfaces": [
- "port1"
], - "ip_configs": [
- {
- "addrfam": "ipv4",
- "proto": "dhcp"
}
], - "name": "corp network 3",
- "prio": 0,
- "role": "shared",
- "routes": [ ],
- "traffic_types": [
- "hip",
- "map",
- "relay"
]
}, - {
- "id": 2,
- "interfaces": [
- "port1.1234",
- "port2"
], - "ip_configs": [
- {
- "addrfam": "ipv4",
- "ipaddr": "192.168.1.199/24",
- "proto": "static"
}
], - "prio": 0,
- "role": "device",
- "routes": [ ]
}, - {
- "id": 3,
- "interfaces": [ ],
- "ip_configs": [
- {
- "addrfam": "ipv4",
- "proto": "static"
}, - {
- "addrfam": "ipv6",
- "proto": "dhcp"
}
], - "prio": 0,
- "role": "shared",
- "routes": [
- { }
], - "traffic_types": [
- "hip",
- "map",
- "relay"
]
}, - {
- "id": 4,
- "interfaces": [ ],
- "ip_configs": [ ],
- "role": "disabled"
}
], - "ports": [
- {
- "interfaces": [
- {
- "ifname": "port1"
}, - {
- "ifname": "port1.1234",
- "vlan": true,
- "vlan_parent": "port1",
- "vlan_tag": 1234
}, - {
- "ifname": "port1.987",
- "vlan": true,
- "vlan_parent": "port1",
- "vlan_tag": 987
}
], - "label": "port1",
- "num": 1,
- "slot": 1,
- "type": "wired"
}, - {
- "interfaces": [
- {
- "ifname": "port2"
}
], - "label": "port2",
- "num": 2,
- "slot": 1,
- "type": "wired"
}, - {
- "interfaces": [
- {
- "ifname": "port3"
}
], - "label": "port3",
- "num": 3,
- "slot": 1,
- "type": "wifi"
}
]
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Returns Airwall port configuration
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "id": "dbef8886-c5cc-4318-aa0a-7b2289be5c58",
- "ifname": "eth1",
- "ip_data": { },
- "link_state": "UP",
- "mac": "00:0d:3a:3b:54:cb",
- "port_number": "2",
- "port_type": "device",
- "priority": 0,
- "proto": "static",
- "uci_name": "overlay"
}, - {
- "force_link": "0",
- "id": "6ae9a8d7-1721-4863-93ac-7c2813966eb5",
- "ifname": "eth0",
- "ip_data": {
- "shared": "192.168.2.10"
}, - "link_state": "UP",
- "mac": "00:0d:3a:3b:54:c7",
- "metric": "0",
- "port_number": "1",
- "port_type": "shared",
- "priority": 0,
- "proto": "dhcp",
- "uci_name": "underlay"
}, - {
- "id": "80c1f8d6-776f-4d00-8b9f-87c9f509908c",
- "ifname": "hipbr",
- "ip_data": {
- "gw_device": "192.168.2.10"
}, - "ipv6": "0",
- "link_state": "UP",
- "mac": "00:0d:3a:3b:54:cb",
- "mtu": "1500",
- "port_number": null,
- "port_type": "br_device",
- "priority": 0,
- "proto": "static",
- "stp": "0",
- "type": "bridge",
- "uci_name": "hipbr"
}, - {
- "bridge_empty": "1",
- "id": "9383ce4c-67ba-4d6b-b5f4-a82de6bd192c",
- "ifname": "tmbr",
- "ip_data": { },
- "link_state": null,
- "mac": "56:7f:39:ff:c5:d3",
- "mtu": "1500",
- "port_number": null,
- "port_type": "br_xparent",
- "priority": 0,
- "proto": "dhcp",
- "stp": "0",
- "type": "bridge",
- "uci_name": "tmbr"
}
]
Activate the Airwall.
id required | string Airwall ID |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "result": "success"
}
Swap current Airwall configuration, overlay membership, group membership, and policies with the target Airwall. This excludes network configuration.
id required | string Airwall ID |
replacement_hipservice_id required | string ID of replacement Airwall |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{ }
Clears customer certificate from the Airwall.
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "ha",
- "ha2.0",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-1111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": true,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": 300,
- "device_auto_detect": true,
- "dhcp": {
- "dhcp_configured": true,
- "dhcp_type": "server",
- "enabled": true,
- "gateway": "10.0.1.1",
- "lease_time": "24h",
- "netmask": "255.255.255.0",
- "range_begin": "10.0.1.100",
- "range_end": "10.0.1.199"
}, - "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
- "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-27T16:17:20.000Z",
- "firmware_revision": "Airwall-x86_64_r2.1.3-951",
- "ha_available": false,
- "ha_compatible": true,
- "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
- "hotfix_list": [ ],
- "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "location": "VMWARE. - PATCHED",
- "lsi": "1.115.218.191",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "Airwall-300v",
- "nat": false,
- "network_list": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "offline_at": "2018-08-28T18:24:42.180Z",
- "online_at": "2018-08-28T18:24:48.093Z",
- "overlay_gateway_ip": "192.168.2.10",
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-101",
- "relay": true,
- "remote_session": null,
- "serial_number": "42308D510FB2",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "title": "HS-168.3.51",
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#42308D510FB2",
- "unassigned": false,
- "underlay_ip": "192.168.3.51",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "version": "2.1.3"
}, - {
- "active": true,
- "ccert": null,
- "ccert_dn": null,
- "description": "AUTOMATION 2 - PATCHED",
- "device_activity_reporting_interval": "300",
- "device_auto_detect": true,
- "dhcp": {
- "dhcp_configured": true,
- "dhcp_type": "relay",
- "enabled": true,
- "upstream_server": "10.10.2.100"
}, - "enabled": true,
- "esp_compress": false,
- "esp_encryption": "AES256_GCM",
- "exclusive_mode": false,
- "ha_ip": null,
- "ha_partner_id": null,
- "location": "VMWARE. - PATCHED 2",
- "nat": false,
- "overlay_device_ip": null,
- "overlay_device_netmask": null,
- "overlay_gateway_ip": "192.168.2.11",
- "overlay_netmask": "255.255.255.0",
- "packet_capture_started": null,
- "path_mtu_enabled": true,
- "source_nat_enabled": true,
- "stp_enabled": true,
- "title": "HS-168.2.11",
- "transparent_mode": false,
- "two_factor_auth": null,
- "underlay_ip_nat": "203.0.113.253",
- "user_auth": false
}
]
Deactivate the Airwall.
id required | string Airwall ID |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "result": "success"
}
Show a support bundle
id required | string Airwall ID |
Success
Forbidden
Not Found
"string"
Start a job to request a Airwall support bundle
id required | string Airwall ID |
Accepted
Forbidden
Not Found
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Swaps the HA role of the Airwall.
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
{ }
Directly set tag members for Airwall.
id required | string Airwall ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Refresh expiration time for tag(s) on Airwall.
id required | string Airwall ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Remove tag(s) from Airwall.
id required | string Airwall ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Add tag(s) to Airwall.
id required | string Airwall ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Starts a job to run traceroute on a given IP or hostname
id required | string Airwall ID |
ip_address required | string IP address or hostname to run traceroute on |
network required | string Enum: "overlay_network" "underlay_network" Network to run traceroute on |
port_group | integer Id of the desired port group to run traceroute on. If only one overlay port group exists it will be used by default. This parameter is only required for Airwalls version 2.2.0 or later. |
Accepted
Forbidden
Not Found
Unprocessable Entity
{- "ip_address": "192.168.1.101",
- "network": "overlay_network",
- "port_group": 1
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Returns Airwall traffic stats
id required | string Airwall ID |
timestamp | string <iso8601> Default: "one week ago" data range begin |
timestamp_end | string <iso8601> data range end |
interfaces | Array of strings Default: ["all interfaces"] interfaces |
limit | integer Default: 360 limit |
order | string Default: "DESC" Enum: "ASC" "DESC" order |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "curr_rx_bytes": 7488692693,
- "curr_rx_pkts": 14296350,
- "curr_tx_bytes": 3061645483,
- "curr_tx_pkts": 17929816,
- "delta_rx_bytes": 1055160,
- "delta_rx_pkts": 2015,
- "delta_time": 300,
- "delta_tx_bytes": 430547,
- "delta_tx_pkts": 2513,
- "ifc": "eth0",
- "src_timestamp": "2018-08-28 10:05:53.000000"
}, - {
- "curr_rx_bytes": 27930,
- "curr_rx_pkts": 363,
- "curr_tx_bytes": 228424,
- "curr_tx_pkts": 5036,
- "delta_rx_bytes": 0,
- "delta_rx_pkts": 0,
- "delta_time": 300,
- "delta_tx_bytes": 84,
- "delta_tx_pkts": 2,
- "ifc": "hipbr",
- "src_timestamp": "2018-08-28 10:05:53.000000"
}
]
Returns a list of ID pairs of tunnels on the given Airwall.
id required | string Airwall ID |
end_time | string Time for the start of the data (ISO8601 datetime) |
start_time | string Time for the start of the data (ISO8601 datetime) |
state | string Enum: "unknown" "unassociated" "i1_sent" "i2_sent" "r2_sent" "established" "rekeying" "closing" "closed" "e_failed" "relayed" Return only data in this state |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "end_time": "2019-01-23 17:24:52 -0800",
- "start_time": "2019-01-23 17:24:52 -0800",
- "state": "unassociated"
}
[- "3f862971-3d78-443b-9cfe-a327b43f4451",
- "f5ca9d80-7429-41ff-be30-e7b6a0382288"
]
Returns tunnel statistics that include the given Airwalls.
id required | string Airwall ID |
end_time | string Time for the start of the data (ISO8601 datetime) |
hipservice_ids | Array of strings An array of Airwall ID strings |
limit | integer Maximum number of stats to return |
start_time | string Time for the start of the data (ISO8601 datetime) |
state | string Enum: "unknown" "unassociated" "i1_sent" "i2_sent" "r2_sent" "established" "rekeying" "closing" "closed" "e_failed" "relayed" Return only data in this state |
wide_view | boolean If true, will return stats that include only one of the given Airwall IDs |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "end_time": "2019-01-23 17:24:52 -0800",
- "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
], - "limit": 1,
- "start_time": "2019-01-23 17:24:52 -0800",
- "state": "unassociated",
- "wide_view": false
}
[- {
- "bytes_in_95th_per_sec": 328,
- "bytes_in_avg_per_sec": 1,
- "bytes_in_total": 468628,
- "bytes_out_95th_per_sec": 340,
- "bytes_out_avg_per_sec": 1,
- "bytes_out_total": 3970952,
- "peer_1_id": "3f862971-3d78-443b-9cfe-a327b43f4451",
- "peer_2_id": "f5ca9d80-7429-41ff-be30-e7b6a0382288",
- "state": "RELAYED",
- "time_in_state": 546,
- "timestamp": "2019-01-24 18:01:16.000000"
}, - {
- "bytes_in_95th_per_sec": 324,
- "bytes_in_avg_per_sec": 32,
- "bytes_in_total": 3311676,
- "bytes_out_95th_per_sec": 360,
- "bytes_out_avg_per_sec": 1,
- "bytes_out_total": 2062856,
- "peer_1_id": "ed1e04c0-3c7f-48ca-8400-ba671551908d",
- "peer_2_id": "644664b5-80d8-44a6-85ab-be06272727c0",
- "state": "RELAYED",
- "time_in_state": 14794,
- "timestamp": "2019-01-24 18:01:16.000000"
}
]
Delete an overlay route
hipserviceId required | string Airwall ID |
id required | string Overlay route ID |
Success
Not Found
Unprocessable Entity
[- {
- "created_at": "2018-08-28T20:11:05.000Z",
- "id": "48457ebc-2389-4460-b03f-038b7ab2353a",
- "ident": "EventActionTypeAlert",
- "params": [
- {
- "default": "info",
- "ident": "alert_level",
- "options": [
- "info",
- "warning",
- "error"
], - "required": true,
- "select-box": true,
- "type": "string"
}, - {
- "ident": "people_ids",
- "required": false,
- "type": "people"
}
], - "test_perform": false,
- "updated_at": "2018-08-28T20:11:05.000Z"
}, - {
- "created_at": "2018-08-28T20:11:06.000Z",
- "id": "c79bce74-a158-441a-a89f-8e1c2e7766f2",
- "ident": "EventActionTypeHttpCall",
- "params": [
- {
- "default": "GET",
- "ident": "verb",
- "options": [
- "GET",
- "POST",
- "PUT",
- "PATCH",
- "DELETE"
], - "required": true,
- "select-box": true,
- "type": "string"
}, - {
- "ident": "url",
- "required": true,
- "type": "uri"
}, - {
- "ident": "headers",
- "required": false,
- "type": "string"
}, - {
- "ident": "body",
- "required": false,
- "type": "string"
}
], - "test_perform": true,
- "updated_at": "2018-08-28T20:11:06.000Z"
}
]
[- {
- "created_at": "2018-08-29T18:37:12.661Z",
- "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
- "event_monitor_id": "6f205edf-d0b3-4578-b2ae-8b39183c035e",
- "event_type": "match",
- "id": "3c0e6d32-1664-4dba-9856-80f9cc7156aa",
- "params": {
- "alert_level": "warning",
- "people_ids": [
- "b45d4567-1234-def7-abc1-1234567d58f2"
]
}, - "updated_at": "2018-08-29T18:37:12.661Z"
}
]
Create a new event action
event_action_type_id required | string Event action type ID |
event_monitor_id required | string Event monitor ID |
params required | object Hash of params for desired event action. Required and optional params are defined on each event action type |
Created
Forbidden
Unprocessable Entity
{- "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
- "event_monitor_id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "params": {
- "alert_level": "warning",
- "people_ids": [
- "b45d4567-1234-def7-abc1-1234567d58f2"
]
}
}
{- "created_at": "2018-09-04T16:44:34.431Z",
- "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
- "event_monitor_id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "event_type": "match",
- "id": "6a2f0651-2ba4-40ed-b3d8-2b549e610f59",
- "params": {
- "alert_level": "warning",
- "people_ids": [
- "b45d4567-1234-def7-abc1-1234567d58f2"
]
}, - "updated_at": "2018-09-04T16:44:34.431Z"
}
Return a single event action
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "created_at": "2018-08-29T18:37:12.661Z",
- "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
- "event_monitor_id": "6f205edf-d0b3-4578-b2ae-8b39183c035e",
- "event_type": "match",
- "id": "3c0e6d32-1664-4dba-9856-80f9cc7156aa",
- "params": {
- "alert_level": "warning",
- "people_ids": [
- "b45d4567-1234-def7-abc1-1234567d58f2"
]
}, - "updated_at": "2018-08-29T18:37:12.661Z"
}
Update an existing event action
id required | string |
params required | object Hash of params for desired event action. Required and optional params are defined on each event action type |
Success
Forbidden
Not Found
Unprocessable Entity
{- "params": {
- "alert_level": "info",
- "people_ids": [
- "b45d4567-1234-def7-abc1-1234567d58f2"
]
}
}
{- "created_at": "2018-09-04T16:44:34.431Z",
- "event_action_type_id": "48457ebc-2389-4460-b03f-038b7ab2353a",
- "event_monitor_id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "event_type": "match",
- "id": "6a2f0651-2ba4-40ed-b3d8-2b549e610f59",
- "params": {
- "alert_level": "info",
- "people_ids": [
- "b45d4567-1234-def7-abc1-1234567d58f2"
]
}, - "updated_at": "2018-09-04T16:44:34.431Z"
}
Trigger the event action for test purposes. Only available if the event action type supports 'test_perform'
id required | string |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
[- {
- "created_at": "2018-08-28T20:11:05.000Z",
- "event_types": [
- "match",
- "timed_out",
- "rtt_exceeded",
- "repaired"
], - "id": "d475c631-3cdb-4bcd-9dae-adc627191d9d",
- "ident": "ping",
- "monitorables": [
- "device"
], - "params": [
- {
- "default": 250,
- "ident": "max_rtt_ms",
- "required": true,
- "type": "int"
}, - {
- "default": 60,
- "ident": "freq_s",
- "min": 10,
- "required": true,
- "type": "int"
}, - {
- "default": 180,
- "ident": "event_s",
- "min": 20,
- "required": true,
- "type": "int"
}
], - "remote": true,
- "updated_at": "2018-08-28T20:11:05.000Z"
}, - {
- "created_at": "2018-08-28T20:11:06.185Z",
- "event_types": [
- "match",
- "offline",
- "online"
], - "id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
- "ident": "endbox_on_offline",
- "monitorables": [
- "hipservice",
- "hipservice_group"
], - "params": [ ],
- "remote": false,
- "updated_at": "2018-08-28T20:11:06.185Z"
}
]
Returns a list of IDs that are valid monitorable targets of a monitor for the given event monitor type
id required | string |
Success
Not Found
Unprocessable Entity
{- "hipservice": [
- "fd582c1c-2fc5-411f-8cd3-bc75f98779d9",
- "7588381d-f36c-4ded-9004-5dd581de0779"
], - "hipservice_group": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
]
}
Delete multiple event monitors
event_monitor_ids required | Array of strings An array of ID strings |
Success
Forbidden
Unprocessable Entity
{- "event_monitor_ids": [
- "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "52f15a00-3b92-43f3-902f-b7fabfcd38be"
]
}
[- {
- "can_edit": true,
- "created_at": "2018-08-29T20:01:13.372Z",
- "disabled_at": null,
- "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
- "flapping": 0,
- "id": "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "monitorable_id": "7588381d-f36c-4ded-9004-5dd581de0779",
- "monitorable_type": "hipservice",
- "params": { },
- "updated_at": "2018-08-29T20:01:13.372Z"
}, - {
- "can_edit": true,
- "created_at": "2018-08-29T20:04:26.978Z",
- "disabled_at": null,
- "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
- "flapping": 0,
- "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
- "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "monitorable_type": "hipservice_group",
- "params": { },
- "updated_at": "2018-08-29T20:04:26.978Z"
}
]
Create a new event monitor
event_monitor_type_id required | string Event monitor type ID |
monitorable_id required | string ID of monitorable target |
monitorable_type required | string Type of monitorable target (e.g. device, device_group, hipservice, hipservice_group) |
params required | object Hash of params for desired event monitor. Required and optional params are defined on each event monitor type |
Created
Forbidden
Not Found
Unprocessable Entity
{- "event_monitor_type_id": "2dd0de70-6b90-4523-ab05-0a49d26ae077",
- "monitorable_id": "d0017bc1-3762-4ade-9033-59f6ed4b8871",
- "monitorable_type": "hipservice",
- "params": {
- "event_s": 180,
- "freq_s": 60,
- "interface": "underlay",
- "max_rtt_ms": 250,
- "ping_ip": "192.168.3.13"
}
}
{- "can_edit": true,
- "created_at": "2018-09-04T17:19:52.927Z",
- "event_monitor_type_id": "2dd0de70-6b90-4523-ab05-0a49d26ae077",
- "flapping": 0,
- "id": "5ac5aa3e-dc90-490a-a01e-7123189b724a",
- "monitorable_id": "d0017bc1-3762-4ade-9033-59f6ed4b8871",
- "monitorable_type": "hipservice",
- "params": {
- "event_s": 180,
- "freq_s": 60,
- "interface": "underlay",
- "max_rtt_ms": 250,
- "ping_ip": "192.168.3.13"
}, - "updated_at": "2018-09-04T17:19:52.927Z"
}
Disable multiple event monitors
event_monitor_ids required | Array of strings An array of ID strings |
Success
Forbidden
Not Found
Unprocessable Entity
{- "event_monitor_ids": [
- "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "52f15a00-3b92-43f3-902f-b7fabfcd38be"
]
}
Enable multiple event monitors
event_monitor_ids required | Array of strings An array of ID strings |
Success
Forbidden
Not Found
Unprocessable Entity
{- "event_monitor_ids": [
- "3d09675b-b4a1-4d4e-a830-12c5d7904920",
- "52f15a00-3b92-43f3-902f-b7fabfcd38be"
]
}
Return a single event monitor
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "can_edit": true,
- "created_at": "2018-08-29T20:04:26.978Z",
- "disabled_at": null,
- "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
- "flapping": 0,
- "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
- "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "monitorable_type": "hipservice_group",
- "params": { },
- "updated_at": "2018-08-29T21:34:46.001Z"
}
Update an existing event monitor
id required | string |
params required | object Hash of params for desired event monitor. Required and optional params are defined on each event monitor type |
Success
Forbidden
Not Found
Unprocessable Entity
{- "params": {
- "event_s": 300,
- "freq_s": 20,
- "interface": "overlay",
- "max_rtt_ms": 250,
- "ping_ip": "192.168.5.13"
}
}
{- "can_edit": true,
- "created_at": "2018-09-04T17:19:52.927Z",
- "event_monitor_type_id": "2dd0de70-6b90-4523-ab05-0a49d26ae077",
- "flapping": 0,
- "id": "5ac5aa3e-dc90-490a-a01e-7123189b724a",
- "monitorable_id": "d0017bc1-3762-4ade-9033-59f6ed4b8871",
- "monitorable_type": "hipservice",
- "params": {
- "event_s": 300,
- "freq_s": 20,
- "interface": "overlay",
- "max_rtt_ms": 250,
- "ping_ip": "192.168.5.13"
}, - "updated_at": "2018-09-04T17:19:52.927Z"
}
Temporarily disable operation of an event monitor
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "can_edit": true,
- "created_at": "2018-08-29T20:04:26.978Z",
- "disabled_at": "2018-08-29T21:31:46.598Z",
- "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
- "flapping": 0,
- "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
- "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "monitorable_type": "hipservice_group",
- "params": { },
- "updated_at": "2018-08-29T21:31:46.599Z"
}
Enable operation of a disabled event monitor
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "can_edit": true,
- "created_at": "2018-08-29T20:04:26.978Z",
- "disabled_at": null,
- "event_monitor_type_id": "5b4c2da7-0953-4b5c-b500-47adf2dcdcd0",
- "flapping": 0,
- "id": "52f15a00-3b92-43f3-902f-b7fabfcd38be",
- "monitorable_id": "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "monitorable_type": "hipservice_group",
- "params": { },
- "updated_at": "2018-08-29T21:34:46.001Z"
}
Return a list of events sent by this event monitor
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "data": [
- {
- "id": "c888b3e1-002e-443b-87e5-7026fa5c78ee",
- "event_monitor_id": "3ae11f10-e5e2-4ad8-a977-64614666bdf1",
- "ebuid": "BHI@40130#671929746843",
- "event_data": {
- "status": "timed_out"
}, - "actions_completed": "2019-05-13T23:52:38.980Z",
- "event_uid": "9cdcad700199ad79b5bfa495fccfc718",
- "initial_time": "2019-05-13T23:52:15.000Z",
- "last_seen": "2019-05-13T23:52:47.000Z"
}
], - "metadata": {
- "limit": 20,
- "offset": 0,
- "next_offset": 1,
- "total": 1
}
}
Return a list of people groups that have permissions to view this event monitor
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
[- {
- "id": "3e0c3336-588a-4e57-8d12-edf73442ad45",
- "name": "3e0c3336-588a-4e57-8d12-edf73442ad45-implicit",
- "description": null,
- "person_ids": [
- "3e0c3336-588a-4e57-8d12-edf73442ad45"
], - "user_auth_tags": [ ]
}, - {
- "id": "8426c730-3b1a-415f-9d48-d6858df207cc",
- "name": "8426c730-3b1a-415f-9d48-d6858df207cc-implicit",
- "description": null,
- "person_ids": [
- "8426c730-3b1a-415f-9d48-d6858df207cc"
], - "user_auth_tags": [ ]
}
]
Returns a list of all firmware updates available on the Airwall Conductor
Success
Forbidden
[- {
- "id": "168510ea-f1fe-4d98-9948-cec22b0db186",
- "model": "Airwall-x86_64",
- "version": "2.2.0",
- "date": "2019-03-18",
- "revision": "Airwall-x86_64_r2.2.0-141",
- "description": "This firmware package updates the 100rc, all 300-, 400- and 500- series Airwalls"
}, - {
- "id": "ecd4a78e-9f68-4b3b-a72c-e9ad75797c05",
- "model": "Conductor",
- "version": "2.2.0",
- "date": "2019-03-18",
- "revision": "Conductor_20190318_2217_r2.2.0_eng",
- "description": "This firmware package updates all versions of Airwall Conductor"
}
]
Updates a set of Airwalls with the given firmware
firmware_id required | string ID of firmware to update with |
hipservice_ids required | Array of strings List of Airwall IDs |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "firmware_id": "168510ea-f1fe-4d98-9948-cec22b0db186",
- "hipservice_ids": [
- "aaefa7d7-2893-460a-bcd3-96b9eb144312",
- "ecd4a78e-9f68-4b3b-a72c-e9ad75797c05"
]
}
Updates the Airwall Conductor with the given firmware
firmware_id required | string ID of firmware to update with |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "firmware_id": "168510ea-f1fe-4d98-9948-cec22b0db186"
}
Starts a job to upload a new firmware update
update required | string <binary> |
Accepted
Bad Request
Forbidden
Unprocessable Entity
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Returns a paginated list of Airwall invitations and their recipients
limit | integer <int32> limit |
offset | integer <int32> offset |
order | string order |
ascending | boolean ascending |
Success
Forbidden
{- "data": [
- {
- "admin_ip": "203.0.113.254",
- "created_at": "2018-08-28T20:16:36.523Z",
- "email_message": "",
- "email_subject": "Airwall Invite",
- "hip_invite_recipients": [
- {
- "activation_code": "91f346930488",
- "created_at": "2018-08-28T20:16:36.525Z",
- "disabled_at": null,
- "email": "test@example.com",
- "expires_at": "2019-01-01T10:15:00.000Z",
- "hip_invite_id": "38406486-aaf3-49cb-8137-ce325cecb608",
- "hipservice_group_ids": [ ],
- "hipservice_uid": null,
- "id": "86211ab5-b7dc-4f63-869f-57acf8ff6c17",
- "name_schema": "${email_name} - ${hipswitch_type}",
- "overlay_device_ip_start": null,
- "overlay_device_netmask": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "status": "sent",
- "updated_at": "2018-08-28T20:16:38.626Z"
}
], - "id": "38406486-aaf3-49cb-8137-ce325cecb608",
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "updated_at": "2018-08-28T20:16:36.523Z"
}
], - "metadata": {
- "limit": 20,
- "next_offset": 2,
- "offset": 0,
- "total": 2
}
}
Create an Airwall invite
device_group_ids | Array of strings Array of device group ids |
email_message | string Message of email to send to invitees. It is advisable to include the Conductor URI, Conductor MAP port, and a location where users can download the Airwall client package. |
email_subject | string Subject line of email sent to invitees |
emails required | Array of strings Array of emails |
expires_at required | string ISO8601 date-time format when the Airwall invites will expire if not used |
hipservice_group_ids | Array of strings Array of Airwall group ids |
name_schema required | string Schema used to determine name of Airwall when it connects to conductor. Variables are wrapped in "${}". Valid variables are: email, email_name, hipswitch_type, ip |
overlay_device_ip_start | string First overlay IP address in range to be assigned to Airwall when it connects to Conductor |
overlay_network_ids | Array of strings Array of overlay network ids |
tag_refs | Array of strings Array of Tag References (IDs or Names) |
uniq_ip | string 'true' if IP addresses already assigned to existing devices should be skipped |
Created
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "device_group_ids": [
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "email_message": "Please find your Airwall Invite!",
- "email_subject": "Airwall Invite",
- "emails": [
- "test1@example.com",
- "test2@example.com"
], - "expires_at": "2019-01-01T10:15:00.000Z",
- "hipservice_group_ids": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "name_schema": "${email_name} - ${hipswitch_type}",
- "overlay_device_ip_start": "",
- "overlay_network_ids": [ ],
- "tag_refs": [
- "Online"
], - "uniq_ip": ""
}
{- "admin_ip": "203.0.113.254",
- "created_at": "2018-08-28T22:05:25.971Z",
- "email_message": "Please find your Airwall Invite!",
- "email_subject": "Airwall Invite",
- "hip_invite_recipients": [
- {
- "activation_code": "9daadb5eafe3",
- "created_at": "2018-08-28T22:05:25.972Z",
- "disabled_at": null,
- "email": "test1@example.com",
- "expires_at": "2019-01-01T10:15:00.000Z",
- "hip_invite_id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
- "hipservice_group_ids": [ ],
- "hipservice_uid": null,
- "id": "6a3c5cb7-1662-4611-b3a0-0fb659925dc2",
- "name_schema": "${email_name} - ${hipswitch_type}",
- "overlay_device_ip_start": null,
- "overlay_device_netmask": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "status": "pending_send",
- "updated_at": "2018-08-28T22:05:25.972Z"
}, - {
- "activation_code": "02e83ca3f2c6",
- "created_at": "2018-08-28T22:05:25.974Z",
- "disabled_at": null,
- "email": "test2@example.com",
- "expires_at": "2019-01-01T10:15:00.000Z",
- "hip_invite_id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
- "hipservice_group_ids": [ ],
- "hipservice_uid": null,
- "id": "731efaa2-c78f-4c9c-868a-a1a57f3d69b7",
- "name_schema": "${email_name} - ${hipswitch_type}",
- "overlay_device_ip_start": null,
- "overlay_device_netmask": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "status": "pending_send",
- "updated_at": "2018-08-28T22:05:25.974Z"
}
], - "id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "tags": [
- "Online"
], - "updated_at": "2018-08-28T22:05:25.971Z"
}
Returns a single Airwall invite and its recipients
id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "admin_ip": "203.0.113.254",
- "created_at": "2018-08-28T22:05:25.971Z",
- "email_message": "Please find your Airwall Invite!",
- "email_subject": "Airwall Invite",
- "hip_invite_recipients": [
- {
- "activation_code": "9daadb5eafe3",
- "created_at": "2018-08-28T22:05:25.972Z",
- "disabled_at": null,
- "email": "test1@example.com",
- "expires_at": "2019-01-01T10:15:00.000Z",
- "hip_invite_id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
- "hipservice_group_ids": [ ],
- "hipservice_uid": null,
- "id": "6a3c5cb7-1662-4611-b3a0-0fb659925dc2",
- "name_schema": "${email_name} - ${hipswitch_type}",
- "overlay_device_ip_start": null,
- "overlay_device_netmask": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "status": "pending_send",
- "updated_at": "2018-08-28T22:05:25.972Z"
}, - {
- "activation_code": "02e83ca3f2c6",
- "created_at": "2018-08-28T22:05:25.974Z",
- "disabled_at": null,
- "email": "test2@example.com",
- "expires_at": "2019-01-01T10:15:00.000Z",
- "hip_invite_id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
- "hipservice_group_ids": [ ],
- "hipservice_uid": null,
- "id": "731efaa2-c78f-4c9c-868a-a1a57f3d69b7",
- "name_schema": "${email_name} - ${hipswitch_type}",
- "overlay_device_ip_start": null,
- "overlay_device_netmask": null,
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "status": "pending_send",
- "updated_at": "2018-08-28T22:05:25.974Z"
}
], - "id": "60ecdcda-4ef5-4e7b-8959-855de1662839",
- "person_id": "b45d4567-1234-def7-abc1-1234567d58f2",
- "updated_at": "2018-08-28T22:05:25.971Z"
}
Returns the status of a job
id required | string Job id |
Success
Created
Bad Request
[- {
- "status": {
- "messages": "started",
- "status": "progress"
}
}
]
Enable or disable secure offline sync mode
Whether secure offline sync mode should be enabled
enabled required | boolean Whether to enable secure offline mode |
success
Not Found
Forbidden
{- "enabled": true
}
{- "enabled": true
}
[- {
- "licenses": {
- "2020-01-01 07:59:00 UTC": 10
}, - "total": 10,
- "used": 2,
- "model": "ISA-75",
- "name": "Airwall-75",
- "type": "hipswitch"
}, - {
- "licenses": {
- "2020-01-01 07:59:00 UTC": 3,
- "perpetual": 5
}, - "total": 8,
- "model": "ISA-100g",
- "name": "Airwall-100g",
- "used": 0,
- "type": "hipswitch"
}, - {
- "licenses": {
- "2020-07-01 06:59:00 UTC": 15,
- "2020-01-01 07:59:00 UTC": 10
}, - "total": 25,
- "used": 15,
- "model": "APPa",
- "name": "Airwall-Android",
- "type": "hipclient"
}
]
[- {
- "display_model": "Airwall-300v",
- "entity_uid": "EC27F4DFAF07",
- "id": "ed7f457c-c264-453e-944c-0ec4d1df7692",
- "status": "requested",
- "timestamp": "2018-08-28T22:18:24.097Z",
- "uuid": "ed7f457c-c264-453e-944c-0ec4d1df7692"
}, - {
- "display_model": "Airwall-300v",
- "entity_uid": "EC2AA16E5E91",
- "id": "8957fa2e-98db-4d0d-9e62-47b0af4f3dd9",
- "status": "requested",
- "timestamp": "2018-08-28T22:17:19.016Z",
- "uuid": "8957fa2e-98db-4d0d-9e62-47b0af4f3dd9"
}
]
Grant or Deny a provisioning request.
Grant or Deny a provisioning request.
grant required | string Boolean true or false to grant or deny a provisioning request. |
id required | Array of strings An array of ID strings |
success
Forbidden
Not Found
Unprocessable Entity
{- "grant": true,
- "id": [
- "ed7f457c-c264-453e-944c-0ec4d1df7692",
- "8957fa2e-98db-4d0d-9e62-47b0af4f3dd9"
]
}
Returns a single provisioning request.
licenseId required | string |
Success
Not Found
Unprocessable Entity
{- "display_model": "Airwall-300v",
- "entity_uid": "EC27F4DFAF07",
- "id": "ed7f457c-c264-453e-944c-0ec4d1df7692",
- "status": "grant",
- "timestamp": "2018-08-28T22:18:24.097Z",
- "uuid": "ed7f457c-c264-453e-944c-0ec4d1df7692"
}
Modify the status of a single provisioning request.
licenseId required | string |
New state of provisioning request. Valid options: ['requested']
status required | string New status of provisioning request |
Success
Bad Request
Not Found
{- "status": "requested"
}
{- "display_model": "Airwall-300v",
- "entity_uid": "EC27F4DFAF07",
- "id": "ed7f457c-c264-453e-944c-0ec4d1df7692",
- "status": "requested",
- "timestamp": "2018-08-28T22:18:24.097Z",
- "uuid": "ed7f457c-c264-453e-944c-0ec4d1df7692"
}
Export an Airwall Conductor sync package. Used to manually sync a Conductor.
Success
Forbidden
{- "auth_data": "3DjRbQ0G41fggfuE4lsQ==",
- "auth_tag": "UcK4mz/IMNlMW84og==",
- "cert_subject": "/C=US/O=Asguard/OU=AMA/CN=Test-AMA-Root",
- "data": "VqsTnP2yUK3BHlyUTI+NLKb63MzVtoOJKCB",
- "iv": "G2HfkKUp4xovibKu",
- "key": "123cigHmo12345678mItrGGABCDEF0clJKjYs16RnD3FDkOk/CABCDOzJdZn+g="
}
Import an Airwall Conductor sync package response. Used to manually sync a Conductor.
For import and export of Conductor sync packages.
auth_data required | string Auto-generated field. Do not modify. |
auth_tag required | string Auto-generated field. Do not modify. |
cert_subject required | string Auto-generated field. Do not modify. |
data required | string Auto-generated field. Do not modify. |
iv required | string Auto-generated field. Do not modify. |
key required | string Auto-generated field. Do not modify. |
Success
Bad Request
Forbidden
{- "auth_data": "1234aBCdeFghjklm4567==",
- "auth_tag": "AbcdHi/jKlmno123q==",
- "cert_subject": "/C=US/O=Asguard/OU=AMA/CN=Test-AMA-Root",
- "data": "CdefabC7Hys3HlyU98+HdjHb7jbHtoOJKCB",
- "iv": "ABcdefgH1234jkl7",
- "key": "1234AbcdeFgHiJ1234klnmOpqr1234stuvWXYzs12345678kOk/abCDefghijk+g="
}
{ }
[- {
- "code": "A123B45678911234",
- "expires_at": null,
- "id": "d36a2706-2f71-4678-bf44-b7892237c285",
- "license_blocks": [
- {
- "display_model": "Add-on: Airwall relay",
- "quantity": 100
}, - {
- "display_model": "Airwall-300v",
- "quantity": 100
}
], - "status": "active",
- "timestamp": "2018-08-28T20:15:21.265Z",
- "uuid": "d36a2706-2f71-4678-bf44-b7892237c285"
}
]
Add a licensing voucher.
Add a licensing voucher.
code required | string Tempered Networks voucher code. |
Success
Forbidden
Service Unavailable
{- "code": "A123B45678911234"
}
{- "code": "A123B45678911234",
- "expires_at": null,
- "id": "b467bb5d-0987-4756-af7f-c0855ad2cec0",
- "license_blocks": [ ],
- "status": "processing",
- "timestamp": "2018-08-28T22:23:30.344Z",
- "uuid": "b467bb5d-0987-4756-af7f-c0855ad2cec0"
}
Returns a single voucher setting.
voucherId required | string Voucher ID |
Success
Not Found
Unprocessable Entity
{- "code": "A123B45678911234",
- "expires_at": null,
- "id": "d36a2706-2f71-4678-bf44-b7892237c285",
- "license_blocks": [
- {
- "display_model": "Add-on: Airwall relay",
- "quantity": 100
}, - {
- "display_model": "Airwall-300v",
- "quantity": 100
}
], - "status": "active",
- "timestamp": "2018-08-28T20:15:21.265Z",
- "uuid": "d36a2706-2f71-4678-bf44-b7892237c285"
}
Removes device groups and devices from an overlay policy.
Removes device groups and devices from an overlay policy.
device_group_ids required | Array of strings An Array of device group ID strings |
network_id required | string |
Success
Forbidden
Not Found
Unprocessable Entity
{- "device_group_ids": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3"
}
Adds device groups and devices to an overlay policy.
Adds device groups and devices to an overlay policy.
device_group_ids required | Array of strings An Array of device group ID strings |
network_id required | string |
Created
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "device_group_ids": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3"
}
{- "can_edit": true,
- "description": "API Overlay created by automated testing.",
- "device_groups": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "enabled": true,
- "hipservices": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "bd03d291-699d-4d33-af1c-493edea60bb3",
- "name": "API Automation Overlay",
- "policy": [ ],
- "uuid": "bd03d291-699d-4d33-af1c-493edea60bb3",
- "vlan": {
- "allow_tagged": false,
- "allow_untagged": true,
- "allowed_tags": null
}
}
Removes policy block between two device groups/devices.
network_id required | string ID of network to unblock policy on |
device_group_1 required | string ID of device group 1 |
device_group_2 required | string ID of device group 2 |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3",
- "device_group_1": "49bd39d8-76ea-4c77-90bb-51f86cc63cc1",
- "device_group_2": "ed5c1e9b-9b7d-49da-98f7-44860ea92b14"
}
Adds policy block between two device groups/devices.
network_id required | string ID of network to block policy on |
device_group_1 required | string ID of device group 1 |
device_group_2 required | string ID of device group 2 |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3",
- "device_group_1": "49bd39d8-76ea-4c77-90bb-51f86cc63cc1",
- "device_group_2": "ed5c1e9b-9b7d-49da-98f7-44860ea92b14"
}
Removes policy between two device groups/devices.
network_id required | string ID of network to remove policy from |
policies required | Array of objects (PolicyPair) Array of device group policy pair IDs |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3",
- "policies": [
- {
- "device_group_1": "dd37346d-bd85-461b-be0b-d353c305de38",
- "device_group_2": "8c149ccd-3620-46c6-ba96-71b584ef863c"
}, - {
- "device_group_1": "dd37346d-bd85-461b-be0b-d353c305de38",
- "device_group_2": "5815133d-cfa2-4gb6-afb7-399394bb7ebc"
}
]
}
Establishes policy between two device groups/devices.
network_id required | string ID of network to add policy to |
policies required | Array of objects (PolicyPair) Array of device group policy pair IDs |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "network_id": "bd03d291-699d-4d33-af1c-493edea60bb3",
- "policies": [
- {
- "device_group_1": "dd37346d-bd85-461b-be0b-d353c305de38",
- "device_group_2": "8c149ccd-3620-46c6-ba96-71b584ef863c"
}, - {
- "device_group_1": "dd37346d-bd85-461b-be0b-d353c305de38",
- "device_group_2": "5815133d-cfa2-4gb6-afb7-399394bb7ebc"
}
]
}
Delete multiple people from a network.
id required | string Overlay Network ID |
Array of user IDs.
person_group_ids required | Array of strings An array of ID strings |
Success
Forbidden
Not Found
Unprocessable Entity
{- "person_group_ids": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "bd03d291-699d-4d33-af1c-493edea60bb3"
]
}
Returns a collection of network managers and members.
id required | string Overlay Network ID |
Success
[- {
- "id": "530106f2-512e-4b74-b804-134c32e82a0e",
- "manager_id": "8426c730-3b1a-415f-9d48-d6858df207cc",
- "overlay_network_id": "e6f445bd-3fea-4d04-95ec-7a8dfe9466c1",
- "role": "manager",
- "uuid": "530106f2-512e-4b74-b804-134c32e82a0e"
}, - {
- "id": "5ce9770d-256f-45e0-b7cd-e523dcc934ca",
- "manager_id": "7b45c971-1c7d-4795-ad70-9f97bfbb60e3",
- "overlay_network_id": "e6f445bd-3fea-4d04-95ec-7a8dfe9466c1",
- "role": "manager",
- "uuid": "5ce9770d-256f-45e0-b7cd-e523dcc934ca"
}, - {
- "id": "03329ca5-3902-40e4-95db-0593a4aab03b",
- "manager_id": "e80dc0da-fcea-4b05-b00e-de925e39bfa4",
- "overlay_network_id": "e6f445bd-3fea-4d04-95ec-7a8dfe9466c1",
- "role": "manager",
- "uuid": "03329ca5-3902-40e4-95db-0593a4aab03b"
}
]
Add people to the overlay network.
id required | string Overlay Network ID |
Array of network people.
network_people required | Array of objects An array of network people |
Success
Bad Request
Forbidden
{- "network_people": [
- {
- "person_group_id": "7d75c451-3b3b-480d-a79e-ef9070717c4e",
- "role": "member"
}, - {
- "person_group_id": "663b3850-53b5-43b2-9ef4-8a77cb0c48e3",
- "role": "manager"
}
]
}
[- {
- "id": "530106f2-512e-4b74-b804-134c32e82a0e",
- "manager_id": "8426c730-3b1a-415f-9d48-d6858df207cc",
- "overlay_network_id": "e6f445bd-3fea-4d04-95ec-7a8dfe9466c1",
- "role": "manager",
- "uuid": "530106f2-512e-4b74-b804-134c32e82a0e"
}, - {
- "id": "5ce9770d-256f-45e0-b7cd-e523dcc934ca",
- "manager_id": "7b45c971-1c7d-4795-ad70-9f97bfbb60e3",
- "overlay_network_id": "e6f445bd-3fea-4d04-95ec-7a8dfe9466c1",
- "role": "manager",
- "uuid": "5ce9770d-256f-45e0-b7cd-e523dcc934ca"
}, - {
- "id": "03329ca5-3902-40e4-95db-0593a4aab03b",
- "manager_id": "e80dc0da-fcea-4b05-b00e-de925e39bfa4",
- "overlay_network_id": "e6f445bd-3fea-4d04-95ec-7a8dfe9466c1",
- "role": "manager",
- "uuid": "03329ca5-3902-40e4-95db-0593a4aab03b"
}
]
Delete multiple overlay networks.
Delete multiple overlay networks.
overlay_network_ids required | Array of strings An array of ID strings |
Success
Forbidden
Unprocessable Entity
{- "overlay_network_ids": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "bd03d291-699d-4d33-af1c-493edea60bb3"
]
}
Returns a collection of overlay networks.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
{- "data": [
- {
- "can_edit": true,
- "description": null,
- "device_groups": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "enabled": true,
- "hipservices": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "name": "Overlay",
- "policy": [
- {
- "from": "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "to": "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
}
], - "uuid": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "vlan": {
- "allow_tagged": false,
- "allow_untagged": true,
- "allowed_tags": null
}
}
], - "metadata": {
- "limit": 1,
- "offset": 0,
- "next_offset": 1,
- "total": 8,
- "next_page": "?paginate=true&offset=1&limit=1"
}
}
Create a new overlay network.
description | string Overlay network description |
enabled | boolean Enable network communications |
name required | string Overlay network name |
set_current_user_as_manager | boolean Set creator of network as its manager |
Created
Bad Request
Forbidden
{- "description": "Core services network",
- "enabled": true,
- "name": "core-services",
- "set_current_user_as_manager": true
}
{- "can_edit": true,
- "description": "API Overlay created by automated testing.",
- "device_groups": [ ],
- "enabled": true,
- "hipservices": [ ],
- "id": "b54a301c-2647-4844-bbc1-8d6e736f51f0",
- "name": "API Overlay (non persistent)",
- "policy": [ ],
- "uuid": "b54a301c-2647-4844-bbc1-8d6e736f51f0",
- "vlan": {
- "allow_tagged": false,
- "allow_untagged": true,
- "allowed_tags": null
}
}
Returns a single overlay network.
id required | string Overlay Network ID |
Success
Forbidden
Not Found
Unprocessable Entity
{- "can_edit": true,
- "description": null,
- "device_groups": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "enabled": true,
- "hipservices": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "name": "Overlay",
- "policy": [
- {
- "from": "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "to": "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
}
], - "uuid": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "vlan": {
- "allow_tagged": false,
- "allow_untagged": true,
- "allowed_tags": null
}
}
Update an existing overlay network (All fields are optional).
id required | string Overlay network ID |
description | string Overlay network description |
enabled | boolean Enable network communications |
name | string Overlay network name |
set_current_user_as_manager | boolean Set creator of network as its manager |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "Core services network",
- "enabled": true,
- "name": "core-services",
- "set_current_user_as_manager": true
}
{- "can_edit": true,
- "description": null,
- "device_groups": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "enabled": true,
- "hipservices": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "name": "Overlay",
- "policy": [
- {
- "from": "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "to": "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
}
], - "uuid": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "vlan": {
- "allow_tagged": false,
- "allow_untagged": true,
- "allowed_tags": null
}
}
Directly set tag members for overlay_network.
id required | string Overlay Network ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Refresh expiration time for tag(s) on overlay_network.
id required | string Overlay Network ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Remove tag(s) from overlay_network.
id required | string Overlay Network ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Add tag(s) to overlay_network.
id required | string Overlay Network ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
[- {
- "policy_name": "foo",
- "from_devices": "dc1e855e-e49c-415f-a4fa-95439304f2c8|d656eea0-80a3-4af0-aa54-dfecc37b59f3|949675be-c28b-4ffa-ba29-7786eb528fd3|24eadf89-d81c-4247-ae14-d6006f46d76d|10ae33cb-e1b0-4a7c-97cd-9a321f688084|85d41795-f774-4d1e-8dbc-3dc2960a69bf|ca7e898d-dab4-4685-9615-7fe3c9069040|f20f102e-6674-48ff-912e-40c09404230b|bff698a3-fbed-4c53-b3a6-63d2680d1816|752dad79-7d0e-409d-8f0b-410bf4228a0d",
- "to_devices": "7c328d88-7895-4f23-9d32-5a317c8fa01b"
}
]
[- {
- "event_timestamp": "2019-05-06T22:33:11.661Z",
- "object_type": "Event Monitor",
- "action_type": "Modified",
- "object_info": "",
- "object_id": "d16c7127-1d44-4337-ab24-4e146e746448",
- "user_id": "e306e316-5df2-4f70-9726-dd8db8793ca1",
- "username": "admin",
- "change": "{\"params\":{\"previous\":{\"url\":\"192.168.1.101:2015\",\"freq_s\":60,\"event_s\":180,\"interface\":\"overlay\",\"timeout_s\":10,\"response_code\":200},\"new\":{\"url\":\"192.168.1.101\",\"freq_s\":60,\"event_s\":180,\"interface\":\"overlay\",\"timeout_s\":10,\"response_code\":200}}}",
- "ip_addr": "127.0.0.1"
}
]
Returns a collection of People settings.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
{- "data": [
- {
- "current_sign_in_at": "2018-08-28T17:36:49.787Z",
- "description": "Local Administrator Account",
- "email": "test@example.com",
- "email_alert_level": "none",
- "id": "7cb6266c-ad12-44ea-a5db-455bf3aa377c",
- "is_active": true,
- "is_api_user": true,
- "is_locked": false,
- "me": true,
- "name": "Local Administrator",
- "phone1": null,
- "phone2": null,
- "remote_session_active": false,
- "role": "administrator",
- "username": "admin",
- "uuid": "7cb6266c-ad12-44ea-a5db-455bf3aa377c",
- "provider": null
}
], - "metadata": {
- "limit": 1,
- "offset": 0,
- "next_offset": 1,
- "total": 8,
- "next_page": "?paginate=true&offset=1&limit=1"
}
}
Create a new Person.
Create a new Person.
description | string description |
string | |
email_alert_level | string Level at which alerts should be emailed to user (Options: none, info, warning, error). Email server must be configured. |
is_active required | string Boolean true or false to set Person's enable status |
is_api_user | string Boolean true or false to enable/disable Person's api access |
name required | string Full Name |
password required | string Password |
phone1 | string Phone 1 |
phone2 | string Phone 2 |
provider | string Authentication provider |
role required | string Person's Role ( administrator, editor, viewer, remote) |
username required | string Username |
Created
Forbidden
{- "description": "Robin of the Hood",
- "email": "robin@stealfromtherich.com",
- "email_alert_level": "none",
- "is_active": true,
- "is_api_user": true,
- "name": "Robin Longstride",
- "password": "actualpassword",
- "phone1": "217-555-1234",
- "phone2": "217-555-1234",
- "provider": null,
- "role": "administrator",
- "username": "robinhood_test_crud_person"
}
{- "current_sign_in_at": null,
- "description": "Robin of the Hood",
- "email": "robin@stealfromtherich.com",
- "email_alert_level": "none",
- "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "is_active": true,
- "is_api_user": true,
- "is_locked": false,
- "me": false,
- "name": "Robin Longstride",
- "phone1": "217-555-1234",
- "phone2": "217-555-1234",
- "remote_session_active": false,
- "role": "administrator",
- "username": "robinhood_test_crud_person",
- "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "provider": null
}
Returns a single Person setting.
id required | string Person ID |
Success
Not Found
Unprocessable Entity
{- "current_sign_in_at": null,
- "description": "Robin of the Hood",
- "email": "robin@stealfromtherich.com",
- "email_alert_level": "none",
- "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "is_active": true,
- "is_api_user": true,
- "is_locked": false,
- "me": false,
- "name": "Robin Longstride",
- "phone1": "217-555-1234",
- "phone2": "217-555-1234",
- "remote_session_active": false,
- "role": "administrator",
- "username": "robinhood_test_crud_person",
- "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "provider": null
}
Update a Person setting (All fields are optional).
id required | string Person ID |
Update a Person setting (All fields are optional).
description | string description |
string | |
email_alert_level | string Level at which alerts should be emailed to user (Options: none, info, warning, error). Email server must be configured. |
is_active required | string Boolean true or false to set Person's enable status |
is_api_user | string Boolean true or false to enable/disable Person's api access |
name required | string Full Name |
password required | string Password |
phone1 | string Phone 1 |
phone2 | string Phone 2 |
provider | string Authentication provider |
role required | string Person's Role ( administrator, editor, viewer, remote) |
username required | string Username |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "Robin of the Hood",
- "email": "robin@stealfromtherich.com",
- "email_alert_level": "none",
- "is_active": true,
- "is_api_user": true,
- "name": "Robin Longstride",
- "password": "actualpassword",
- "phone1": "217-555-1234",
- "phone2": "217-555-1234",
- "provider": null,
- "role": "administrator",
- "username": "robinhood_test_crud_person"
}
{- "current_sign_in_at": null,
- "description": "Robin of the Hood",
- "email": "robin@stealfromtherich.com",
- "email_alert_level": "none",
- "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "is_active": true,
- "is_api_user": true,
- "is_locked": false,
- "me": false,
- "name": "Robin Longstride",
- "phone1": "217-555-1234",
- "phone2": "217-555-1234",
- "remote_session_active": false,
- "role": "administrator",
- "username": "robinhood_test_crud_person",
- "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "provider": null
}
Directly set tag members for person.
id required | string Person ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Refresh expiration time for tag(s) on person.
id required | string Person ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Remove tag(s) from person.
id required | string Person ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Add tag(s) to person.
id required | string Person ID |
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
success
Forbidden
Not Found
Unprocessable Entity
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
{ }
Returns a collection of person groups.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
{- "data": [
- {
- "description": "API person_group created by automated testing.",
- "person_ids": [ ],
- "id": "a9890571-369a-4a77-a80b-8de89ed1f008",
- "name": "API person_group",
- "user_auth_tags": [ ]
}, - {
- "description": "API person_group2 created by automated testing.",
- "person_ids": [ ],
- "id": "4b191722-962f-4da9-9f91-abe5e8c9c89b",
- "name": "API person_group2 (non persistent)",
- "user_auth_tags": [ ]
}
], - "metadata": {
- "limit": 2,
- "offset": 0,
- "next_offset": 2,
- "total": 8,
- "next_page": "?paginate=true&offset=2&limit=2"
}
}
Create a new person group.
Create a new person group.
name | string Name of person group |
description | string Description of person group |
person_ids | Array of strings An array of ID strings |
Created
Bad Request
Forbidden
Unprocessable Entity
{- "name": "Administrators",
- "description": "Administrators of important resources",
- "person_ids": [
- "32d685a6-f188-44a2-ad1d-742dab63da34"
]
}
{- "description": "API person_group created by automated testing.",
- "person_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "a9890571-369a-4a77-a80b-8de89ed1f008",
- "name": "API person_group",
- "user_auth_tags": [ ]
}
Returns a single person group.
id required | string Person Group ID |
Success
Forbidden
Not Found
{- "description": "API person_group created by automated testing.",
- "person_ids": [
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API person_group",
- "user_auth_tags": [ ]
}
Update an existing person group (All fields are optional).
id required | string Person Group ID |
Update an existing person group (All fields are optional).
description | string Device group description |
person_ids | Array of strings An array of ID strings |
name | string Device group name |
Success
Forbidden
Not Found
Unprocessable Entity
{- "description": "Security cameras person group.",
- "person_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "name": "Cameras-01"
}
{- "description": "Security cameras person group.",
- "person_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "name": "Administrators",
- "user_auth_tags": [ ]
}
Add people to an existing person group.
id required | string Person Group ID |
An array of ID strings
person_ids required | Array of strings An array of ID strings |
Success
Forbidden
Not Found
Unprocessable Entity
{- "person_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
]
}
{- "description": "API person_group created by automated testing.",
- "person_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API person_group - Patched",
- "user_auth_tags": [ ]
}
Remove devices from an existing person group.
id required | string Person Group ID |
An array of ID strings
person_ids required | Array of strings An array of ID strings |
Success
Forbidden
Not Found
Unprocessable Entity
{- "person_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
]
}
{- "description": "API person_group created by automated testing.",
- "person_ids": [ ],
- "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API person_group - Patched",
- "user_auth_tags": [ ]
}
Provision a new Airwall Conductor
proxy_address | string Address of proxy server |
proxy_password | string Password for proxy server |
proxy_port | integer Port for proxy server |
proxy_username | string Username for proxy server |
use_proxy | boolean Use a proxy server for provisioning |
voucher_code | string Tempered Networks voucher code |
success
Bad Request
{- "proxy_address": "192.168.2.90",
- "proxy_password": "password123",
- "proxy_port": "80",
- "proxy_username": "admin",
- "use_proxy": true,
- "voucher_code": "ABCDEF0123456789"
}
Export an Airwall Conductor provisioning package.Used to manually provision a Conductor
voucher_code required | string Tempered Networks voucher code |
success
Bad Request
[- {
- "auth_data": "0UE/S=",
- "auth_tag": "G1/i39Q/IAcUlk2nrN4ARA==",
- "cert_subject": "/Tempered Networks AMA",
- "data": "Bykq1DFkauJ",
- "iv": "ODUFXRudITt+aivm",
- "key": "41GBc="
}
]
Import an Airwall Conductor provisioning package response. Used to manually provisioning a Conductor
Provision a Conductor manually
auth_data required | string Cryptographic auth data |
auth_tag required | string Cryptographic auth tag |
cert_subject required | string Certificate subject of conductor sync package belongs to |
data required | string Encrypted data |
iv required | string Cryptographic initializaion vector |
key required | string Encrypted key |
success
Bad Request
{- "auth_data": "string",
- "auth_tag": "string",
- "cert_subject": "string",
- "data": "string",
- "iv": "string",
- "key": "string"
}
[- {
- "description": "This is a test relay rule",
- "group_1": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "group_2": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
- "name": "Test Relay Rule",
- "relay": {
- "hipservice_group_ids": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "defbaf97-aec3-43aa-9a93-60f495175f72"
], - "hipservice_ids": [
- "29863534-6ce0-4c82-a3e7-1c4bdf4f986b",
- "d0017bc1-3762-4ade-9033-59f6ed4b8871"
]
}
}
]
Create a new relay rule
description | string |
name required | string |
Created
Bad Request
Forbidden
{- "description": "This is a test relay rule",
- "name": "Test Relay Rule"
}
{- "description": "This is a test relay rule",
- "group_1": { },
- "group_2": { },
- "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
- "name": "Test Relay Rule",
- "relay": { }
}
Returns a single relay rule
id required | string Airwall ID |
Success
Forbidden
Not Found
Unprocessable Entity
{- "description": "This is a test relay rule",
- "group_1": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "group_2": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
- "name": "Test Relay Rule",
- "relay": {
- "hipservice_group_ids": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "defbaf97-aec3-43aa-9a93-60f495175f72"
], - "hipservice_ids": [
- "29863534-6ce0-4c82-a3e7-1c4bdf4f986b",
- "d0017bc1-3762-4ade-9033-59f6ed4b8871"
]
}
}
Update an existing relay rule
id required | string Airwall ID |
description | string |
name | string |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "description": "This is a test relay rule",
- "name": "Test Relay Rule"
}
{- "description": "This is a test relay rule",
- "group_1": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "group_2": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
- "name": "Test Relay Rule",
- "relay": {
- "hipservice_group_ids": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "defbaf97-aec3-43aa-9a93-60f495175f72"
], - "hipservice_ids": [
- "29863534-6ce0-4c82-a3e7-1c4bdf4f986b",
- "d0017bc1-3762-4ade-9033-59f6ed4b8871"
]
}
}
Add Airwall or Airwall groups to a relay rule
id required | string Airwall ID |
group_1 | object (group_1) |
group_2 | object (group_2) |
relay | object (relay) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "group_1": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "group_2": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "relay": {
- "hipservice_group_ids": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "defbaf97-aec3-43aa-9a93-60f495175f72"
], - "hipservice_ids": [
- "29863534-6ce0-4c82-a3e7-1c4bdf4f986b",
- "d0017bc1-3762-4ade-9033-59f6ed4b8871"
]
}
}
{- "description": "This is a test relay rule",
- "group_1": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "group_2": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
- "name": "Test Relay Rule",
- "relay": {
- "hipservice_group_ids": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "defbaf97-aec3-43aa-9a93-60f495175f72"
], - "hipservice_ids": [
- "29863534-6ce0-4c82-a3e7-1c4bdf4f986b",
- "d0017bc1-3762-4ade-9033-59f6ed4b8871"
]
}
}
Remove Airwalls or Airwall groups from a relay rule
id required | string Airwall ID |
group_1 | object (group_1) |
group_2 | object (group_2) |
relay | object (relay) |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "group_1": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "group_2": {
- "hipservice_group_ids": [
- "98f52e8f-bb9b-4c18-9dca-cf0faa3d86ea",
- "64967ebe-cd64-4ee8-b482-30d5dd455aca"
], - "hipservice_ids": [
- "bd6daefe-feaf-4eca-9f76-69a39aa96b71",
- "3b59a040-575d-4205-b5ed-94074f6311b4"
]
}, - "relay": {
- "hipservice_group_ids": [
- "88b28601-c33f-4ab1-8830-2f75d534ec79",
- "defbaf97-aec3-43aa-9a93-60f495175f72"
], - "hipservice_ids": [
- "29863534-6ce0-4c82-a3e7-1c4bdf4f986b",
- "d0017bc1-3762-4ade-9033-59f6ed4b8871"
]
}
}
{- "description": "This is a test relay rule",
- "group_1": { },
- "group_2": { },
- "id": "69ecc675-b8d3-406c-9be9-a64ed45ea755",
- "name": "Test Relay Rule",
- "relay": { }
}
Show current Airwall Conductor configuration
Success
Forbidden
{- "completed": true,
- "db_status": "rw",
- "device_id": "Unavailable",
- "domain_name": "",
- "eula": true,
- "firmware_revision": "test-revision-of-no-consequence",
- "hostname": "conductor",
- "hotfix_list": [ ],
- "network_interface_configs": [
- {
- "default_gateway": "",
- "dns1": "",
- "dns2": "",
- "enabled": true,
- "ip": "",
- "netmask": "",
- "network_configuration": "dhcp",
- "static_routes": [
- {
- "gateway": "192.168.56.91",
- "network": "192.168.1.1/24"
}, - {
- "gateway": "192.168.56.90",
- "network": "192.168.2.0/24"
}
], - "web_enabled": true
}, - {
- "default_gateway": "",
- "dns1": "",
- "dns2": "",
- "enabled": true,
- "ip": "192.168.56.6",
- "netmask": "255.255.255.0",
- "network_configuration": "static",
- "static_routes": [
- {
- "gateway": "192.168.56.12",
- "network": "192.168.2.1/24"
}
], - "web_enabled": false
}
], - "product_model": "SCMP-2p",
- "product_platform": "401v-101",
- "rails_log_level": "info",
- "serial_number": "Unavailable",
- "system_log_level": "info",
- "version": ""
}
Update Airwall Conductor configuration
domain_name | string Domain name for the Conductor |
hostname | string Hostname for the Conductor |
nic1 | object (NicConfig) |
nic2 | object (NicConfig) |
rails_log_level | string Enum: "debug" "info" "warn" "error" Log level for the webapp |
system_log_level | string Enum: "debug" "info" "warn" "error" Log level for system processes |
Success
Forbidden
{- "domain_name": "domain.com",
- "hostname": "Conductor",
- "nic1": {
- "default_gateway": "192.168.56.90",
- "dns1": "8.8.8.8",
- "dns2": "10.10.10.10",
- "enabled": true,
- "ip": "192.168.56.2",
- "netmask": "255.255.255.0",
- "network_configuration": "dhcp",
- "static_routes": [
- {
- "gateway": "192.168.56.91",
- "network": "192.168.1.1/24"
}
], - "web_enabled": true
}, - "nic2": {
- "default_gateway": "192.168.56.90",
- "dns1": "8.8.8.8",
- "dns2": "10.10.10.10",
- "enabled": true,
- "ip": "192.168.56.2",
- "netmask": "255.255.255.0",
- "network_configuration": "dhcp",
- "static_routes": [
- {
- "gateway": "192.168.56.91",
- "network": "192.168.1.1/24"
}
], - "web_enabled": true
}, - "rails_log_level": "info",
- "system_log_level": "info"
}
{- "completed": true,
- "db_status": "rw",
- "device_id": "Unavailable",
- "domain_name": "",
- "eula": true,
- "firmware_revision": "test-revision-of-no-consequence",
- "hostname": "conductor",
- "hotfix_list": [ ],
- "network_interface_configs": [
- {
- "default_gateway": "",
- "dns1": "",
- "dns2": "",
- "enabled": true,
- "ip": "",
- "netmask": "",
- "network_configuration": "dhcp",
- "static_routes": [
- {
- "gateway": "192.168.56.91",
- "network": "192.168.1.1/24"
}, - {
- "gateway": "192.168.56.90",
- "network": "192.168.2.0/24"
}
], - "web_enabled": true
}, - {
- "default_gateway": "",
- "dns1": "",
- "dns2": "",
- "enabled": true,
- "ip": "192.168.56.6",
- "netmask": "255.255.255.0",
- "network_configuration": "static",
- "static_routes": [
- {
- "gateway": "192.168.56.12",
- "network": "192.168.2.1/24"
}
], - "web_enabled": false
}
], - "product_model": "SCMP-2p",
- "product_platform": "401v-101",
- "rails_log_level": "info",
- "serial_number": "Unavailable",
- "system_log_level": "info",
- "version": ""
}
{- "cipher": "AES256_GCM",
- "compress": true,
- "disable_shared_key_encryption": false,
- "dns_domain": "temperednetworks.corp",
- "dns_servers": [
- "8.8.8.8"
], - "esp_transform": "HMAC_SHA256",
- "hip_lockdown": {
- "allow_override": false,
- "gateway_id": "b6beba80-0e29-4892-a1bd-de734e88fca2",
- "required": true,
- "white_list": [
- {
- "dir": "in",
- "ip": "192.168.23.1",
- "ports": "22",
- "proto": "tcp"
}, - {
- "dir": "out",
- "ports": "8080-8090,80",
- "proto": "any"
}
]
}, - "hip_port": 10500,
- "lsi_prefix": 1,
- "map_port": 8096,
- "map_urls": [
- "192.168.56.33"
], - "pci_enabled": true,
- "shared_endbox_key": "LV6XYYuYfUWUD"
}
Update advanced settings
Update existing advanced settings.
cipher | string Enum: "AES256_GCM" "AES256_CBC" Preferred cipher suite for encryption |
compress | boolean Use compression for encryption by default |
disable_shared_key_encryption | boolean Do not use shared key encryption |
dns_domain | string Domain used for app overlay DNS searches |
dns_servers | Array of strings DNS server IPs used on app overlays |
esp_transform | string Value: "HMAC_SHA256" ESP transform to use for encryption by default |
hip_lockdown | object Lockdown mode settings |
hip_port | integer Port used for all HIP communication |
lsi_prefix | integer IPv4 prefix |
map_port | integer Port for Airwalls to communicate with the Airwall Conductor |
map_urls | Array of strings IP addresses or hostnames to connect to the Conductor on |
pci_enabled | boolean Enable PCI reporting |
shared_endbox_key | string Shared key used to validate the identity of the Conductor |
Success
Forbidden
Unprocessable Entity
{- "cipher": "AES256_GCM",
- "compress": false,
- "disable_shared_key_encryption": false,
- "dns_domain": "temperednetworks.corp",
- "dns_servers": [
- "8.8.8.8"
], - "esp_transform": "HMAC_SHA256",
- "hip_lockdown": {
- "allow_override": false,
- "gateway_id": "b6beba80-0e29-4892-a1bd-de734e88fca2",
- "required": true,
- "white_list": [
- {
- "dir": "in",
- "ip": "192.168.23.1",
- "ports": "22",
- "proto": "tcp"
}, - {
- "dir": "out",
- "ports": "8080-8090,80",
- "proto": "any"
}
]
}, - "hip_port": 10500,
- "lsi_prefix": 1,
- "map_port": 8096,
- "map_urls": [
- "192.168.56.3"
], - "pci_enabled": true,
- "shared_endbox_key": "LV6XYYuYfUWUD"
}
{- "cipher": "AES256_GCM",
- "compress": true,
- "disable_shared_key_encryption": false,
- "dns_domain": "temperednetworks.corp",
- "dns_servers": [
- "8.8.8.8"
], - "esp_transform": "HMAC_SHA256",
- "hip_lockdown": {
- "allow_override": false,
- "required": true,
- "white_list": [
- {
- "dir": "in",
- "ip": "192.168.23.1",
- "ports": "22",
- "proto": "tcp"
}, - {
- "dir": "out",
- "ports": "8080-8090,80",
- "proto": "any"
}
]
}, - "hip_port": 10500,
- "lsi_prefix": 1,
- "map_port": 8096,
- "map_urls": [
- "192.168.56.33"
], - "pci_enabled": true,
- "shared_endbox_key": "LV6XYYuYfUWUD"
}
Show current authentication settings
Success
Forbidden
{- "allow_password_recovery": true,
- "default_auth_provider": "local",
- "default_user_auth_provider": "userpass",
- "login_lockout_hours": 25,
- "max_login_attempts": 25,
- "password_complexity": [
- "mixed",
- "digit",
- "symbol"
], - "password_expiration_days": 180,
- "password_length": 8,
- "session_expiration_hours": 24,
- "session_timeout_min": 120,
- "token_expiration_days": 0,
- "user_auth": false,
- "user_auth_lockout": true,
- "user_auth_lockout_linux": false,
- "user_auth_storage": false,
- "user_auth_timeout": 24
}
Update authentication settings
Update existing authentication settings.
allow_password_recovery | boolean Show "Forgot Your Password?" link |
default_auth_provider | string Enum: "local" "ldap" "openid_connect" Default authentication provider for Conductor login |
default_user_auth_provider | string Enum: "all" "userpass" "openid_connect" Default authentication provider for Airwall client authentication |
login_lockout_hours | integer Hours to prevent user login after lockout |
max_login_attempts | integer Login attempts before lockout (0 to disable) |
password_complexity | Array of strings Items Enum: "mixed" "digit" "symbol" Password complexity requirements |
password_expiration_days | integer Days before passwords expire (0 to disable) |
password_length | integer Minimum password length |
session_expiration_hours | integer Hours before user UI session expires |
session_timeout_min | integer Minutes before user will be logged out for inactivity |
token_expiration_days | integer Days before API tokens expire (0 to disable) |
user_auth | boolean Require app authentication |
user_auth_storage | boolean Airwall client's remote session will remain authenticated across restarts until it times out |
user_auth_timeout | integer User auth session timeout (in hours) |
user_auth_lockout | boolean Prevent any clients that do not support user authentication from connecting to a network |
user_auth_lockout_linux | boolean Make an exception for Linux clients since they do not support user authentication and are typically deployed in a server environment |
Success
Forbidden
Unprocessable Entity
{- "allow_password_recovery": true,
- "default_auth_provider": "local",
- "default_user_auth_provider": "userpass",
- "login_lockout_hours": 24,
- "max_login_attempts": 25,
- "password_complexity": [
- "mixed",
- "digit"
], - "password_expiration_days": 180,
- "password_length": 8,
- "session_expiration_hours": 24,
- "session_timeout_min": 120,
- "token_expiration_days": 0,
- "user_auth": false,
- "user_auth_storage": false,
- "user_auth_timeout": 24,
- "user_auth_lockout": true,
- "user_auth_lockout_linux": false
}
{- "allow_password_recovery": true,
- "default_auth_provider": "local",
- "default_user_auth_provider": "userpass",
- "login_lockout_hours": 25,
- "max_login_attempts": 25,
- "password_complexity": [
- "mixed",
- "digit"
], - "password_expiration_days": 180,
- "password_length": 8,
- "session_expiration_hours": 24,
- "session_timeout_min": 120,
- "token_expiration_days": 0,
- "user_auth": false,
- "user_auth_lockout": true,
- "user_auth_lockout_linux": false,
- "user_auth_storage": false,
- "user_auth_timeout": 24
}
{- "monitor_flapping_minimum": 3,
- "monitor_flapping_minutes": 10
}
Update monitor/alert settings
Update existing monitor/alert settings.
monitor_flapping_minimum | integer [ 2 .. 1000 ] Number of events required before frequent events warning |
monitor_flapping_minutes | integer [ 1 .. 1000 ] Number of minutes events must occur within for frequent events warning |
Success
Forbidden
Unprocessable Entity
{- "monitor_flapping_minimum": 3,
- "monitor_flapping_minutes": 10
}
{- "monitor_flapping_minimum": 3,
- "monitor_flapping_minutes": 10
}
{- "proxy_address": "192.168.16.103",
- "proxy_password": "[filtered]",
- "proxy_port": 3128,
- "proxy_username": "proxyusername",
- "use_proxy": true
}
Update proxy server settings
Update existing proxy server settings.
proxy_address | string IP address or hostname of proxy server |
proxy_password | string Password for proxy server |
proxy_port | integer Port to connect to proxy server on |
proxy_username | string Proxy server username |
use_proxy | boolean Enable proxy server |
Success
Forbidden
Unprocessable Entity
{- "proxy_address": "192.168.16.103",
- "proxy_password": "Password123",
- "proxy_port": 3128,
- "proxy_username": "proxyusername",
- "use_proxy": true
}
{- "proxy_address": "192.168.16.103",
- "proxy_password": "[filtered]",
- "proxy_port": 3128,
- "proxy_username": "proxyusername",
- "use_proxy": true
}
Starts a job to create a support bundle
Accepted
Bad Request
Forbidden
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
{- "log_conductor": true,
- "log_hipservices": true,
- "port": 514,
- "server": "192.168.33.33",
- "use_tls": false
}
Update remote syslog server configuration.
Modify one or all the fields of the syslog_config model
enabled | boolean Enable remote logging settings |
log_conductor | boolean |
log_hipservices | boolean |
port required | string Remote syslog server port |
server required | string Remote syslog server URL |
use_tls | boolean |
Success
Forbidden
Unprocessable Entity
{- "log_conductor": true,
- "log_hipservices": true,
- "port": "514",
- "server": "192.168.33.33",
- "use_tls": false
}
{- "log_conductor": true,
- "log_hipservices": true,
- "port": 514,
- "server": "192.168.33.33",
- "use_tls": false
}
Add remote syslog server configuration.
Server and port are required with either 'log_conductor' or 'log_hipservices' or both being true
enabled | boolean Enable remote logging settings |
log_conductor | boolean |
log_hipservices | boolean |
port required | string Remote syslog server port |
server required | string Remote syslog server URL |
use_tls | boolean |
Success
Forbidden
Unprocessable Entity
{- "log_conductor": true,
- "log_hipservices": true,
- "port": "514",
- "server": "192.168.33.33",
- "use_tls": false
}
{- "log_conductor": true,
- "log_hipservices": true,
- "port": 514,
- "server": "192.168.33.33",
- "use_tls": false
}
Returns a JSON representation of the API documentation
Success
Bad Request
{- "swagger": "2.0",
- "info": {
- "description": "API methods for Simple Connect",
- "version": "1.0.1",
- "title": "Simple Connect API"
}, - "host": "localhost",
- "basePath": "/api/v1",
- "schemes": [
- "http"
], - "consumes": [
- "application/json"
], - "produces": [
- "application/json"
], - "paths": { },
- "definitions": { }
}
Starts a job to generate an Airwall Conductor diagnostic report
Accepted
Bad Request
Forbidden
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to ping an IP address or hostname
ip required | string IP address or hostname to ping |
Accepted
Bad Request
Forbidden
Unprocessable Entity
{- "ip": "string"
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to run traceroute on an IP address or hostname
ip required | string IP address or hostname to perform traceroute on |
Accepted
Bad Request
Forbidden
Unprocessable Entity
{- "ip": "string"
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
[- {
- "captureStart": null,
- "pcaps": [
- {
- "id": "b124610bd0616b788499f331151e8621",
- "size": 324942,
- "timestamp": "2019-01-15T13:16:47.930+00:00"
}, - {
- "id": "3b4794ef7dc4789e7343098372466543",
- "size": 339609,
- "timestamp": "2019-01-15T13:37:02.630+00:00"
}, - {
- "id": "b52dc5dd5b43be61843c3bd452b3414a",
- "size": 159098,
- "timestamp": "2019-01-15T13:39:15.650+00:00"
}, - {
- "id": "7040407925f0f6938b2dc89d4de261ed",
- "size": 386067,
- "timestamp": "2019-01-15T13:48:54.060+00:00"
}
]
}
]
Removes a pcap file
id required | string Pcap id |
Success
Bad Request
Forbidden
[- {
- "captureStart": null,
- "pcaps": [
- {
- "id": "b124610bd0616b788499f331151e8621",
- "size": 324942,
- "timestamp": "2019-01-15T13:16:47.930+00:00"
}, - {
- "id": "3b4794ef7dc4789e7343098372466543",
- "size": 339609,
- "timestamp": "2019-01-15T13:37:02.630+00:00"
}, - {
- "id": "b52dc5dd5b43be61843c3bd452b3414a",
- "size": 159098,
- "timestamp": "2019-01-15T13:39:15.650+00:00"
}
]
}
]
Starts a job to run a packet capture on the Airwall Conductor
capture_interface required | string Interface on which to run the packet capture |
protocol | string Protocol to capture (any, icmp, tcp, udp, arp) |
ip_address | string IP address to capture |
port | integer Port to capture |
max_size | integer Maximum packet size to capture |
max_time | integer Time limit for packet capture (in minutes) |
Accepted
Forbidden
Unprocessable Entity
{- "capture_interface": "hip0",
- "protocol": "any",
- "ip_address": "192.168.1.101",
- "port": 80,
- "max_size": 100,
- "max_time": 1
}
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Starts a job to stop the running packet capture on the Airwall Conductor
Accepted
Bad Request
Forbidden
{- "job_id": "272e0685685a6fe7fb9e377aea4cfbfe",
- "status_url": "{request_base_url}/api/v1/jobs/272e0685685a6fe7fb9e377aea4cfbfe"
}
Delete multiple tags.
array of Tag References (IDs or Names)
tag_refs required | Array of strings array of Tag References (IDs or Names) |
Success
Forbidden
{- "tag_refs": [
- "api-test",
- "fbe76d09-9fad-4baf-a4ed-788eca148d96"
]
}
Returns a collection of tags.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
Forbidden
{- "data": [
- {
- "color": "red",
- "id": "3857fb12-861c-4cef-9fb1-74e7190bcb20",
- "name": "I'm a new tag!",
- "ownership": "anyone",
- "priority": 50,
- "remove_if_unused": false,
- "usage_ttl": "0s"
}
], - "metadata": {
- "limit": 1,
- "offset": 0,
- "next_offset": 1,
- "total": 8,
- "next_page": "?paginate=true&offset=1&limit=1"
}
}
Create a new tag.
Create a new tag.
color | string cosmetic; one of { black, blue, brown, gray, green, orange, purple, red, white, yellow } |
name required | string name |
ownership | string one of { anyone, admins, user }, determines who may utilize this tag; if "user", then a valid tag_owner_id must also be given. |
priority | string cosmetic; determines tag sort order in lists. Lower numbers take precedence (1 = highest priority, 5 = default, etc.). |
remove_if_unused | boolean When a tag is removed from something, check to see if anything else uses it; if not then delete it. |
tag_owner_id | string if ownership == "user", then ID of the specific user who may utilize the tag (else, ignored). |
usage_ttl | string tagging an object will last for this amount of time (if 0, tagging never expires). Supported units: y, M, w, d, h, m, s (default: s). No spaces between parts. For example, these are equivalent: 16250, 16250s, 270m50s, and 4h30m50s. |
Created
Bad Request
Forbidden
Unprocessable Entity
{- "tags": {
- "color": "red",
- "name": "I'm a new tag!",
- "ownership": "anyone",
- "priority": 50,
- "remove_if_unused": false,
- "usage_ttl": "0m"
}
}
{- "api_uuid": "3857fb12-861c-4cef-9fb1-74e7190bcb20",
- "canUse": true,
- "can_edit": true,
- "color": "red",
- "id": 1,
- "name": "I'm a new tag!",
- "ownership": "anyone",
- "priority": 50,
- "remove_if_unused": false,
- "usage_ttl": "0s"
}
Returns a single tag.
id required | string Tag Reference (ID or Name) |
Success
Forbidden
Not Found
{- "color": "red",
- "id": "3857fb12-861c-4cef-9fb1-74e7190bcb20",
- "name": "I'm a new tag!",
- "ownership": "anyone",
- "priority": 50,
- "remove_if_unused": false,
- "usage_ttl": "0s"
}
Update an existing tag (All fields are optional).
id required | string Tag Reference (ID or Name) |
Update an existing tag (All fields are optional).
color | string cosmetic; one of { black, blue, brown, gray, green, orange, purple, red, white, yellow } |
name required | string name |
ownership | string one of { anyone, admins, user }, determines who may utilize this tag; if "user", then a valid tag_owner_id must also be given. |
priority | string cosmetic; determines tag sort order in lists. Lower numbers take precedence (1 = highest priority, 5 = default, etc.). |
remove_if_unused | boolean When a tag is removed from something, check to see if anything else uses it; if not then delete it. |
tag_owner_id | string if ownership == "user", then ID of the specific user who may utilize the tag (else, ignored). |
usage_ttl | string tagging an object will last for this amount of time (if 0, tagging never expires). Supported units: y, M, w, d, h, m, s (default: s). No spaces between parts. For example, these are equivalent: 16250, 16250s, 270m50s, and 4h30m50s. |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "tags": {
- "color": "red",
- "name": "I'm a new tag!",
- "ownership": "anyone",
- "priority": 50,
- "remove_if_unused": false,
- "usage_ttl": "0m"
}
}
[- {
- "color": "red",
- "id": "3857fb12-861c-4cef-9fb1-74e7190bcb20",
- "name": "I'm a new tag!",
- "ownership": "anyone",
- "priority": 50,
- "remove_if_unused": false,
- "usage_ttl": "0s"
}
]
Returns all device groups that have this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
[- {
- "description": "API device_group created by automated testing.",
- "device_ids": [
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "id": "55535846-ae0f-4327-be88-f3cdd1dd9463",
- "name": "API device_group (non persistent)",
- "tagged_by": [
- {
- "tag_id": "fbe76d09-9fad-4baf-a4ed-788eca148d96",
- "tag_name": "I'm a new tag!",
- "tagged_at": "2018-12-11T19:29:36.333Z",
- "tagger": "user",
- "tagger_id": 1
}
], - "uuid": "55535846-ae0f-4327-be88-f3cdd1dd9463"
}
]
Returns all devices that have this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
[- {
- "description": "API device created by automated testing.",
- "discovered": false,
- "hipservice_id": "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "id": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8",
- "last_activity_at": null,
- "mac": "00:0d:29:f0:93:dd",
- "mac_lockdown": true,
- "name": "API device (non persistent)",
- "overlay_device_ip": "192.168.2.10",
- "tagged_by": [
- {
- "tag_id": "fbe76d09-9fad-4baf-a4ed-788eca148d96",
- "tag_name": "I'm a new tag!",
- "tagged_at": "2018-12-11T19:29:36.333Z",
- "tagger": "user",
- "tagger_id": 1
}
], - "uuid": "73e2e02a-46ce-45cc-ac76-2ad945b9d2f8"
}
]
Disable network communications for all objects with this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
{ }
Enable network communications for all objects with this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
{ }
Returns all HIPservice groups that have this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
[- {
- "description": "API hipservice_group created by automated testing.",
- "enabled": true,
- "hipservices_ids": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "a851fe87-3247-4ade-9dd0-a62d6f340e3a",
- "name": "API hipservice_group (non persistent)",
- "relay_group": false,
- "tagged_by": [
- {
- "tag_id": "fbe76d09-9fad-4baf-a4ed-788eca148d96",
- "tag_name": "I'm a new tag!",
- "tagged_at": "2018-12-11T19:29:36.333Z",
- "tagger": "user",
- "tagger_id": 1
}
], - "uuid": "a851fe87-3247-4ade-9dd0-a62d6f340e3a"
}
]
Returns all HIPservices that have this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
[- {
- "active": true,
- "can_edit": true,
- "capabilities": [
- "advanced_networking",
- "capture_options",
- "capture_options+",
- "check_online",
- "data",
- "devices",
- "dg_aware",
- "dhcp",
- "diag_check_sas",
- "diag_iperf",
- "diag_pcap",
- "diag_ping",
- "diag_ping_devices",
- "diag_ping_peers",
- "diag_report",
- "diag_tracert",
- "dual_rt",
- "esp_encryption",
- "esp_gcm",
- "eth",
- "firewall",
- "fw_upgrade",
- "ha",
- "ha2.0",
- "hipopt.port",
- "limit_ft_bandwidth",
- "lm",
- "m2",
- "m2_http_proxy",
- "monitors-1111",
- "one_armed",
- "pcap",
- "port_config",
- "port_expansion",
- "port_stats",
- "port_vlan",
- "reboot",
- "relay",
- "revoke",
- "soip",
- "support_bundle"
], - "ccert": null,
- "ccert_completed_at": null,
- "ccert_csr": null,
- "ccert_csr_present": false,
- "ccert_dn": null,
- "ccert_dn_present": false,
- "ccert_present": false,
- "communication_disabled_through_groups": [ ],
- "connected": true,
- "description": "AUTOMATION - PATCHED",
- "device_activity_reporting_interval": 300,
- "device_auto_detect": true,
- "dhcp": null,
- "diagnostic_requested_at": null,
- "dn": "/C=US/O=Asguard/OU=Endbox/CN=BHI@40130#42308D510FB2",
- "enabled": true,
- "esp_encryption": "AES256_GCM",
- "esp_compress": false,
- "factory_reset_at": null,
- "firewall_config": {
- "enabled": false,
- "rules": [ ]
}, - "firmware_install_at": "2018-08-27T16:17:20.000Z",
- "firmware_revision": "HIPswitch-x86_64_r2.1.3-951",
- "ha_available": false,
- "ha_compatible": true,
- "hit": "2001:10:c384:9bde:a3aa:57bc:4473:dabf",
- "hotfix_list": [ ],
- "id": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "link_manager": {
- "dest_conductor": true,
- "dest_other_ips": "",
- "disable_active_link_pings": false,
- "ping_failure_count": 2,
- "ping_rate": 30,
- "ping_timeout": 5,
- "ping_ttl": 255
}, - "local_devices": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
], - "location": "VMWARE. - PATCHED",
- "lsi": "1.115.218.191",
- "managed": true,
- "max_ft_bandwidth": null,
- "model": "HIPswitch-300v",
- "nat": false,
- "network_list": [
- "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea"
], - "offline_at": "2018-08-28T18:24:42.180Z",
- "online_at": "2018-08-28T18:24:48.093Z",
- "overlay_gateway_ip": "192.168.2.10",
- "overlay_netmask": "255.255.255.0",
- "overlay_routes": [ ],
- "packet_capture_started_at": null,
- "path_mtu_enabled": true,
- "peer_autoconnect_interval": 60,
- "product_model": "ISA-300v",
- "product_platform": "300v-101",
- "relay": true,
- "remote_session": null,
- "serial_number": "42308D510FB2",
- "source_nat_enabled": false,
- "stp_enabled": true,
- "support_bundle_requested_at": null,
- "tagged_by": [
- {
- "tag_id": "fbe76d09-9fad-4baf-a4ed-788eca148d96",
- "tag_name": "I'm a new tag!",
- "tagged_at": "2018-12-11T19:29:36.333Z",
- "tagger": "user",
- "tagger_id": 1
}
], - "title": "HS-168.3.51",
- "traffic_stats_interval": 300,
- "transparent_mode": false,
- "type": "HIPswitch",
- "uid": "BHI@40130#42308D510FB2",
- "unassigned": false,
- "underlay_ip": "192.168.3.51",
- "underlay_ip_nat": "203.0.113.254",
- "uuid": "ce5e081e-f063-4b16-8cd4-a353e276f575",
- "version": "2.1.5"
}
]
Returns all networks that have this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
[- {
- "can_edit": true,
- "description": null,
- "device_groups": [
- "4e7264ea-79f2-43b1-bf1e-2b786a41450e",
- "6dfda5e4-809c-414e-b9ab-b6b3e7a47085"
], - "enabled": true,
- "hipservices": [
- "4ae21af1-e5b8-4f92-8c17-c420a93bcdea",
- "ce5e081e-f063-4b16-8cd4-a353e276f575"
], - "id": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "name": "Overlay",
- "policy": [
- {
- "from": "6dfda5e4-809c-414e-b9ab-b6b3e7a47085",
- "to": "4e7264ea-79f2-43b1-bf1e-2b786a41450e"
}
], - "tagged_by": [
- {
- "tag_id": "fbe76d09-9fad-4baf-a4ed-788eca148d96",
- "tag_name": "I'm a new tag!",
- "tagged_at": "2018-12-11T19:29:36.333Z",
- "tagger": "user",
- "tagger_id": 1
}
], - "uuid": "cd4a9ed7-3ab4-484e-bf44-5feff5fbf2ea",
- "vlan": {
- "allow_tagged": false,
- "allow_untagged": true,
- "allowed_tags": null
}
}
]
Returns all people that have this tag.
id required | string Tag Reference (ID or Name) |
Success
Not Found
[- {
- "current_sign_in_at": null,
- "description": "Robin of the Hood",
- "email": "robin@stealfromtherich.com",
- "email_alert_level": "none",
- "id": "bd570507-7c1e-40a7-b961-216eb56c8142",
- "is_active": true,
- "is_api_user": true,
- "is_locked": false,
- "me": false,
- "name": "Robin Longstride",
- "phone1": "217-555-1234",
- "phone2": "217-555-1234",
- "remote_session_active": false,
- "role": "administrator",
- "provider": null,
- "tagged_by": [
- {
- "tag_id": "fbe76d09-9fad-4baf-a4ed-788eca148d96",
- "tag_name": "I'm a new tag!",
- "tagged_at": "2018-12-11T19:29:36.333Z",
- "tagger": "user",
- "tagger_id": 1
}
], - "username": "robinhood_test_crud_person",
- "uuid": "bd570507-7c1e-40a7-b961-216eb56c8142"
}
]
Refresh expires-at time for all expiring tagged object relationships (based on current usage_ttl).
id required | string Tag Reference (ID or Name) |
Success
Not Found
{ }
Generate an authentication token for the API
provider | string Authentication provider. Options: local, ldap / Default: local |
Authorization required | string Basic auth is in the format 'Basic |
Created
Bad Request
Forbidden
{- "client_id": "-Ijdbnk4V0i1ZoWG-5NTOA",
- "token": "xV1234uat1234xkpPr1234"
}
Returns wireless settings.
filter | string filter |
sort | string sort |
limit | integer <int32> limit |
offset | integer <int32> offset |
paginate | boolean Default: false Response will include metadata to allow easy pagination through all available data. Default will change to true in v2.3. |
Success
Bad Request
Forbidden
{- "data": [
- {
- "ca_chain": "tn-api-test-patched",
- "enabled": true,
- "id": "f098bf9f-2d50-4879-b737-c7dd778f7854",
- "key": "tn-api-test-patched",
- "ssid": "2621405f-ee0f-4538-989a-0de79b60ee8f",
- "uuid": "f098bf9f-2d50-4879-b737-c7dd778f7854",
- "wireless_auth_type": "WPA-PSK"
}, - {
- "ca_chain": "tn-api-test-patched",
- "enabled": true,
- "id": "4bbdecf6-bfaf-449d-8313-72a6c50f48f6",
- "key": "tn-api-test-patched",
- "ssid": "fa624b37-41a7-4396-8433-718abc0d3f65",
- "uuid": "4bbdecf6-bfaf-449d-8313-72a6c50f48f6",
- "wireless_auth_type": "WPA-PSK"
}
], - "metadata": {
- "limit": 2,
- "offset": 0,
- "next_offset": 2,
- "total": 8,
- "next_page": "?paginate=true&offset=2&limit=2"
}
}
Create new wireless settings.
Create new wireless settings.
ca_chain required | string |
enabled required | string Boolean true or false to enabled WiFi network. |
key required | string |
ssid required | string |
wireless_auth_type required | string Enum: "Open" "WEP" "WPA-PSK" "EAP-TLS" Authorization standard to use |
Created
Bad Request
Forbidden
{- "ca_chain": "tn-api-test",
- "enabled": true,
- "key": "tn-api-test",
- "ssid": "tn-api-test",
- "wireless_auth_type": "WPA-PSK"
}
{- "ca_chain": "tn-api-test",
- "enabled": true,
- "id": "c9244489-48c9-436a-a716-5311be2190cd",
- "key": "tn-api-test",
- "ssid": "tn-api-test",
- "uuid": "c9244489-48c9-436a-a716-5311be2190cd",
- "wireless_auth_type": "WPA-PSK"
}
Returns a single wireless setting.
id required | string Wireless settings ID |
Success
Forbidden
Not Found
Unprocessable Entity
{- "ca_chain": "tn-api-test",
- "enabled": true,
- "id": "c9244489-48c9-436a-a716-5311be2190cd",
- "key": "tn-api-test",
- "ssid": "tn-api-test",
- "uuid": "c9244489-48c9-436a-a716-5311be2190cd",
- "wireless_auth_type": "WPA-PSK"
}
Update an wireless settings (All fields are optional).
id required | string |
Update an wireless settings (All fields are optional).
ca_chain required | string |
enabled required | string Boolean true or false to enabled WiFi network. |
key required | string |
ssid required | string |
wireless_auth_type required | string Enum: "Open" "WEP" "WPA-PSK" "EAP-TLS" Authorization standard to use |
Success
Bad Request
Forbidden
Not Found
Unprocessable Entity
{- "ca_chain": "tn-api-test",
- "enabled": true,
- "key": "tn-api-test",
- "ssid": "tn-api-test",
- "wireless_auth_type": "WPA-PSK"
}
{- "ca_chain": "tn-api-test",
- "enabled": true,
- "id": "c9244489-48c9-436a-a716-5311be2190cd",
- "key": "tn-api-test",
- "ssid": "tn-api-test",
- "uuid": "c9244489-48c9-436a-a716-5311be2190cd",
- "wireless_auth_type": "WPA-PSK"
}