Add a new company under a parent company
name required | string Company name |
required | object (AddressDto) Address |
phoneNumber required | string Phone number |
faxNumber | string Fax number |
supportEmail required | string Support email |
salesEmail required | string Sales email |
accountsEmail required | string Accounts email |
parentCompanyId required | string <uuid> Parent company ID |
companyType required | string Enum: "CUSTOMER" "RESELLER" Company type |
{- "parentCompanyId": "5f10c94d-af26-479f-a705-aa2a85d778ea",
- "companyType": "RESELLER",
- "name": "Example Company name",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "supportEmail": "support@supported.com",
- "salesEmail": "sales@supported.com",
- "accountsEmail": "accounts@supported.com"
}
{- "status": "OK",
- "body": {
- "name": "Example Company name",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "supportEmail": "support@supported.com",
- "salesEmail": "sales@supported.com",
- "accountsEmail": "accounts@supported.com",
- "id": "61000d29-3f6e-405a-a764-9666766a6d13"
}
}
Find company with a matching name
companyName required | string Example: companyName=test Company name to search for (partial match) |
{- "status": "OK",
- "body": [
- {
- "id": "ac68adfc-6d80-4e43-947a-66070e244fee",
- "name": "Test Company"
}, - {
- "id": "6aa6ddc6-23f1-411b-baf8-7a4d5256b9f4",
- "name": "Other Company"
}
]
}
Get company by ID
id required | string <uuid> Example: ac68adfc-6d80-4e43-947a-66070e244fee Company ID |
{- "status": "OK",
- "body": {
- "name": "Example Company name",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "supportEmail": "support@supported.com",
- "salesEmail": "sales@supported.com",
- "accountsEmail": "accounts@supported.com",
- "id": "61000d29-3f6e-405a-a764-9666766a6d13"
}
}
{- "status": "OK",
- "body": [
- {
- "name": "Example Company name",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "supportEmail": "support@supported.com",
- "salesEmail": "sales@supported.com",
- "accountsEmail": "accounts@supported.com",
- "id": "61000d29-3f6e-405a-a764-9666766a6d13"
}
]
}
Get child companies by parent company id
companyId required | string <uuid> Example: ac68adfc-6d80-4e43-947a-66070e244fee |
{- "status": "OK",
- "body": [
- {
- "id": "ac68adfc-6d80-4e43-947a-66070e244fee",
- "name": "Test Company"
}
]
}
{- "status": "OK",
- "body": [
- {
- "zoneId": "America/Anchorage",
- "name": "Alaska Standard Time",
- "region": "United States"
}, - {
- "zoneId": "America/Chicago",
- "name": "Central Time",
- "region": "USA"
}
]
}
Update Company details
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
status | string Enum: "OK" "FAILED" |
object (CompanyDto) | |
object (ErrorDto) |
{- "name": "Example Company name",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "IL 60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "supportEmail": "support@makonetworks.com",
- "salesEmail": "sales@makonetworks.com",
- "accountsEmail": "accounts@makonetworks.com"
}
{- "status": "OK",
- "body": {
- "name": "Example Company name",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "supportEmail": "support@supported.com",
- "salesEmail": "sales@supported.com",
- "accountsEmail": "accounts@supported.com",
- "id": "61000d29-3f6e-405a-a764-9666766a6d13"
}
}
Delete Label by Id for Ethernet Interface.
interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
labelId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK"
}
Delete Label by Interface Device Id and Label for InterfaceDevice.
interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
label required | string Example: someLabel |
{- "status": "OK"
}
Delete Label by Id for Mako Device.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
labelId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK"
}
Find Ethernet Interface Label by Ethernet Interface UUID and label.
interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
label required | string Example: someLabel |
"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"label\":\"value1\t\"}}"
Find Mako Device Label by mako UUID and label.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
label required | string Example: someLabel |
"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"label\":\"value1\t\"}}"
Find Site Label by Site UUID and label.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
label required | string Example: someLabel |
"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"label\":\"value1\t\"}}"
Find Ethernet Interface Labels by Ethernet Interface UUID.
interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
"{\t\"status\":\"OK\",\t\"body\":[\t\t{\t\t\t\"id\":\"b6664af0-fc44-40b6-9d12-38e624903628\",\t\t\t\"label\":\"value3\t\t\"},\t\t{\t\t\t\"id\":\"d9e1da23-bc40-4669-9d09-b7dfcc3d7498\",\t\t\t\"label\":\"value4\t\t\"},\t\t{\t\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\t\"label\":\"value1\t\t\"},\t\t{\t\t\t\"id\":\"1a859379-1048-430c-a474-f777b39cddfe\",\t\t\t\"label\":\"value2\t\t\"}\t]}"
Find Mako Device Labels by Mako Device UUID.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
"{\t\"status\":\"OK\",\t\"body\":[\t\t{\t\t\t\"id\":\"b6664af0-fc44-40b6-9d12-38e624903628\",\t\t\t\"label\":\"value3\t\t\"},\t\t{\t\t\t\"id\":\"d9e1da23-bc40-4669-9d09-b7dfcc3d7498\",\t\t\t\"label\":\"value4\t\t\"},\t\t{\t\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\t\"label\":\"value1\t\t\"},\t\t{\t\t\t\"id\":\"1a859379-1048-430c-a474-f777b39cddfe\",\t\t\t\"label\":\"value2\t\t\"}\t]}"
Find Site Labels by Site UUID.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
"{\t\"status\":\"OK\",\t\"body\":[\t\t{\t\t\t\"id\":\"b6664af0-fc44-40b6-9d12-38e624903628\",\t\t\t\"label\":\"value3\t\t\"},\t\t{\t\t\t\"id\":\"d9e1da23-bc40-4669-9d09-b7dfcc3d7498\",\t\t\t\"label\":\"value4\t\t\"},\t\t{\t\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\t\"label\":\"value1\t\t\"},\t\t{\t\t\t\"id\":\"1a859379-1048-430c-a474-f777b39cddfe\",\t\t\t\"label\":\"value2\t\t\"}\t]}"
Put Label for InterfaceDevice.
interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
label | string |
{- "label": "someVal"
}
{- "status": "OK",
- "body": {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVal"
}
}
Put Label for Mako Device.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
label | string |
{- "label": "someVal"
}
{- "status": "OK",
- "body": {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVal"
}
}
Put Label for Site.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
label | string |
{- "label": "someVal"
}
{- "status": "OK",
- "body": {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVal"
}
}
Put Labels for Ethernet Interface.
interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
label | string |
"[\t{\t\t\"label\": \"someVal\t\"}, \t{\t\t\"label\": \"someVal2\t\"}]"
{- "status": "OK",
- "body": [
- {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVal"
}, - {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVa2l"
}
]
}
Put Labels for Mako Device.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
label | string |
"[\t{\t\t\"label\": \"someVal\t\"}, \t{\t\t\"label\": \"someVal2\t\"}]"
{- "status": "OK",
- "body": [
- {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVal"
}, - {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVa2l"
}
]
}
Put Labels for Site.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
label | string |
"[\t{\t\t\"label\": \"someVal\t\"}, \t{\t\t\"label\": \"someVal2\t\"}]"
{- "status": "OK",
- "body": [
- {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVal"
}, - {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "label": "someVa2l"
}
]
}
Add a licence code
makoId required | string <uuid> Mako ID to add licence for |
licenceCode required | string Licence code |
{- "makoId": "7741327b-a91d-4c7c-a80b-2b9482c93826",
- "licenceCode": "string"
}
{- "status": "OK"
}
Add Mako
companyId required | string <uuid> Mako parent company ID |
name required | string Mako name (department name) |
required | object (AddressDto) Address |
phoneNumber required | string Phone number |
faxNumber | string Fax number |
makoModel | string Mako hardware model, e.g. "Mako-6500M" |
identification | string Mako identification/MAC address |
siteId | string <uuid> Site ID |
customSiteId | string Custom site ID (reference) to assign to a newly created site for the Mako (if siteId is not provided) |
customSiteName | string Custom site name to assign to a newly created site for the Mako (if siteId is not provided) |
Create a Mako using hardware model and put it into an existing site
{- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "siteId": "a8e2c248-36e4-430d-99cb-8e8b4550b668",
- "name": "Mako Test",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": " IL 60123",
- "country": "US",
- "timezone": "America/Chicago",
- "latitude": 42.06,
- "longitude": -88.31
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "makoModel": "Mako 6500-M"
}
{- "status": "OK",
- "body": {
- "id": "26202f37-8b99-493a-a6a1-8f79540ae5fa",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Mako",
- "companyName": "Example Company",
- "identification": "10:20:30:44:11:22"
}
}
Add Mako from template (copy Mako)
name | string Mako name (department name) |
id | string <uuid> Mako unique identifier |
cpeId | string <uuid> Mako unique identifier - same as id |
companyId | string <uuid> Mako parent company ID |
companyName | string Mako parent company name |
identification | string Mako identification/MAC address |
siteId | string <uuid> Site ID |
siteName | string Site name |
siteReference | string Site Reference |
makoType | string Mako type |
hardware | string Mako hardware |
firmware | string Mako firmware |
Add Mako from template and put it into an existing site
{- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "siteId": "9c2be5a2-8c7a-4289-bf58-c12da8edc447",
- "name": "Example Mako",
- "address": {
- "address1": "Some Address",
- "country": "PL",
- "timezone": "Europe/Warsaw"
}, - "phoneNumber": "1240912491724912412",
- "templateId": "2a8e4a67-d97e-42f4-b757-071cfdc4f5e7",
- "copyDhcpLeases": false,
- "copyInternetPasswords": false,
- "snatMapping": [
- {
- "cloud": "My Test Cloud",
- "mapping": {
- "LAN 1": "10.1.1.0/27"
}
}, - {
- "cloud": "My Other Cloud",
- "mapping": {
- "LAN 1": "1.2.0.0/255.255.0.0",
- "LAN 2": "192.168.99.0/27"
}
}
]
}
{- "status": "OK",
- "body": {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Mako",
- "companyName": "Example Company",
- "identification": "10:20:30:44:11:22"
}
}
Find Mako by name (partial match). Optionally provide a companyId to find Makos only in a specific company
companyId | string <uuid> Example: companyId=06d0dee3-ee0a-4cac-af90-09c1a89d0bd4 |
name required | string Example: name=office |
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Mako",
- "companyName": "Example Company",
- "identification": "10:20:30:44:11:22"
}
]
}
Get a list of Enterprise Templates (including inherited) the Mako can be assigned to
Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example Template",
- "pciTemplate": true,
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "companyName": "Example Company"
}
]
}
Get a list of Enterprise Templates (not including inherited) the Mako can be assigned to
Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example Template",
- "pciTemplate": true,
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "companyName": "Example Company"
}
]
}
Get a list of Interfaces for Mako.
Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "id": "22d467a5-d461-41b8-9814-53fd309667ed",
- "normalizedName": "lan1",
- "description": "LAN 1",
- "external": false,
- "subnet": "192.168.21.0/24"
}, - {
- "id": "3600c8b0-14c1-46aa-ac6c-7163245e172f",
- "normalizedName": "dsl1",
- "description": "External",
- "external": true,
- "subnet": "0.0.0.0/32",
- "priority": 0
}
]
}
Get mako by ID
id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Mako",
- "companyName": "Example Company",
- "identification": "10:20:30:44:11:22"
}
}
Get Mako by MAC address
macAddress required | string Example: 10:30:22:33:11:44 |
{- "status": "OK",
- "body": {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Mako",
- "companyName": "Example Company",
- "identification": "10:20:30:44:11:22"
}
}
Get a list of Enterprise Templates the Mako is assigned to
Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example Template",
- "pciTemplate": true,
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "companyName": "Example Company"
}
]
}
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Mako",
- "companyName": "Example Company",
- "identification": "10:20:30:44:11:22"
}
]
}
Subscribe Mako to Enterprise Template
enterpriseTemplateId required | string <uuid> Enterprise Template Id |
makoId required | string <uuid> Mako Id |
{- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "enterpriseTemplateId": "61000d29-3f6e-405a-a764-9666766a6d13"
}
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "name": "Example Template",
- "pciTemplate": true,
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "companyName": "Example Company"
}
]
}
Unsubscribe Mako from Enterprise Template
enterpriseTemplateId required | string <uuid> Enterprise Template Id |
makoId required | string <uuid> Mako Id |
{- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "enterpriseTemplateId": "61000d29-3f6e-405a-a764-9666766a6d13"
}
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "name": "Example Template",
- "pciTemplate": true,
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "companyName": "Example Company"
}
]
}
Update Mako details
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
name | string Mako name (department name) |
{- "name": "Example Mako"
}
{- "status": "OK",
- "body": {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "name": "Example Mako",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "companyName": "Example Company",
- "siteId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "siteName": "Example Site",
- "identification": "10:20:30:44:11:22"
}
}
Delete Metadata by metadata Id.
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
metadataId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK"
}
Delete Metadata by Metadata Id.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
metadataId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK"
}
Delete Metadata by Metadata Id.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
metadataId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK"
}
Find Company Metadata by Company UUID.
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
"{\t\"status\":\"OK\",\t\"body\":[\t\t{\t\t\t\"id\":\"b6664af0-fc44-40b6-9d12-38e624903628\",\t\t\t\"key\":\"mkn3\",\t\t\t\"value\":\"value3\t\t\"},\t\t{\t\t\t\"id\":\"d9e1da23-bc40-4669-9d09-b7dfcc3d7498\",\t\t\t\"key\":\"mkn4\",\t\t\t\"value\":\"value4\t\t\"},\t\t{\t\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\t\"key\":\"mkn1\",\t\t\t\"value\":\"value1\t\t\"},\t\t{\t\t\t\"id\":\"1a859379-1048-430c-a474-f777b39cddfe\",\t\t\t\"key\":\"mkn2\",\t\t\t\"value\":\"value2\t\t\"}\t]}"
Find Company Metadata by Company UUID and key.
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
key required | string Example: someKey |
"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"key\":\t\t\"mkn1\",\t\t\"value\":\"value1\t\"}}"
Find Mako Device Metadata by Mako Device UUID.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
"{\t\"status\":\"OK\",\t\"body\":[\t\t{\t\t\t\"id\":\"b6664af0-fc44-40b6-9d12-38e624903628\",\t\t\t\"key\":\"mkn3\",\t\t\t\"value\":\"value3\t\t\"},\t\t{\t\t\t\"id\":\"d9e1da23-bc40-4669-9d09-b7dfcc3d7498\",\t\t\t\"key\":\"mkn4\",\t\t\t\"value\":\"value4\t\t\"},\t\t{\t\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\t\"key\":\"mkn1\",\t\t\t\"value\":\"value1\t\t\"},\t\t{\t\t\t\"id\":\"1a859379-1048-430c-a474-f777b39cddfe\",\t\t\t\"key\":\"mkn2\",\t\t\t\"value\":\"value2\t\t\"}\t]}"
Find Mako Device Metadata by mako UUID and key.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
key required | string Example: someKey |
"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"key\":\t\t\"mkn1\",\t\t\"value\":\"value1\t\"}}"
Find Site Metadata by site UUID.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
"{\t\"status\":\"OK\",\t\"body\":[\t\t{\t\t\t\"id\":\"b6664af0-fc44-40b6-9d12-38e624903628\",\t\t\t\"key\":\"mkn3\",\t\t\t\"value\":\"value3\t\t\"},\t\t{\t\t\t\"id\":\"d9e1da23-bc40-4669-9d09-b7dfcc3d7498\",\t\t\t\"key\":\"mkn4\",\t\t\t\"value\":\"value4\t\t\"},\t\t{\t\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\t\"key\":\"mkn1\",\t\t\t\"value\":\"value1\t\t\"},\t\t{\t\t\t\"id\":\"1a859379-1048-430c-a474-f777b39cddfe\",\t\t\t\"key\":\"mkn2\",\t\t\t\"value\":\"value2\t\t\"}\t]}"
Find Site Metadata by site UUID and key.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
key required | string Example: someKey |
"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"key\":\t\t\"mkn1\",\t\t\"value\":\"value1\t\"}}"
Put Metadata for Company.
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
key | string |
value | string |
{- "key": "mkn5",
- "value": "someVal"
}
{- "status": "OK",
- "body": {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "key": "mkn5",
- "value": "someVal"
}
}
Put Metadata for Mako Device.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
key | string |
value | string |
{- "key": "mkn5",
- "value": "someVal"
}
{- "status": "OK",
- "body": {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "key": "mkn5",
- "value": "someVal"
}
}
Put Metadata List for site.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
key | string |
value | string |
[- {
- "key": "mkn5",
- "value": "someVal"
}, - {
- "key": "mkn6",
- "value": "someVal2"
}
]
{- "status": "OK",
- "body": [
- {
- "key": "mkn5",
- "value": "someVal"
}, - {
- "key": "mkn6",
- "value": "someVal2"
}
]
}
Put Metadata for site.
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
key | string |
value | string |
{- "key": "mkn5",
- "value": "someVal"
}
{- "status": "OK",
- "body": {
- "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
- "key": "mkn5",
- "value": "someVal"
}
}
Put Metadata List for Company.
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
key | string |
value | string |
"[{\t\"key\": \"mkn5\", \t\"value\": \"someVal\"}, {\t\"key\": \"mkn6\", \t\"value\": \"someVal2\"}, ]"
{- "status": "OK",
- "body": [
- {
- "key": "mkn5",
- "value": "someVal"
}, - {
- "key": "mkn6",
- "value": "someVal2"
}
]
}
Put Metadata List for Mako Device.
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
id | string <uuid> |
key | string |
value | string |
[- {
- "key": "mkn5",
- "value": "someVal"
}, - {
- "key": "mkn6",
- "value": "someVal2"
}
]
{- "status": "OK",
- "body": [
- {
- "key": "mkn5",
- "value": "someVal"
}, - {
- "key": "mkn6",
- "value": "someVal2"
}
]
}
Add a new person
companyId required | string <uuid> User company ID |
userType required | string Enum: "Configure Client" "Diagnostics Client" "Full Reseller" "Reports Client" "Reports Only Reseller" "VPN User" User type |
templateScope required | string Enum: "COMPANY_INHERIT" "COMPANY_NO_INHERIT" "COMPANY_CHILDREN" Template scope |
firstName required | string First name |
lastName required | string Last name |
username required | string ^[a-z0-9-.@]*$ Username |
email required | string |
allowLogin required | boolean Whether to allow user to log in |
required | object (AddressDto) Address |
phoneNumber | string Phone number |
faxNumber | string Fax number |
{- "companyId": "ae696d15-d9d8-4694-b1be-de6a8dd14f18",
- "userType": "Full Reseller",
- "templateScope": "COMPANY_NO_INHERIT",
- "firstName": "Jane",
- "lastName": "Smith",
- "username": "testuser2",
- "email": "testuser2@makonetworks.com",
- "allowLogin": true,
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": " IL 60123",
- "country": "US",
- "timezone": "America/Chicago",
- "latitude": 42.06,
- "longitude": -88.31
}, - "phoneNumber": "123423423"
}
{- "status": "OK",
- "body": {
- "id": "f0afc736-88cb-4780-a306-99082a7e1576",
- "firstName": "Jane",
- "lastName": "Smith",
- "username": "testuser",
- "email": "testuser@makonetworks.com"
}
}
Get person by ID
id required | string <uuid> Example: f0afc736-88cb-4780-a306-99082a7e1576 |
{- "status": "OK",
- "body": {
- "id": "f0afc736-88cb-4780-a306-99082a7e1576",
- "firstName": "Jane",
- "lastName": "Smith",
- "username": "testuser",
- "email": "testuser@makonetworks.com"
}
}
Get person by username
username required | string Example: testuser Username |
{- "status": "OK",
- "body": {
- "id": "f0afc736-88cb-4780-a306-99082a7e1576",
- "firstName": "Jane",
- "lastName": "Smith",
- "username": "testuser",
- "email": "testuser@makonetworks.com"
}
}
List people for a company
companyId required | string <uuid> Example: ae696d15-d9d8-4694-b1be-de6a8dd14f18 Company ID |
{- "status": "OK",
- "body": [
- {
- "id": "f0afc736-88cb-4780-a306-99082a7e1576",
- "firstName": "Jane",
- "lastName": "Smith",
- "username": "testuser",
- "email": "testuser@makonetworks.com"
}
]
}
Add Site
companyId required | string <uuid> Parent company ID |
name required | string Name |
reference | string Reference |
latitude | number <double> Latitude |
longitude | number <double> Longitude |
required | object (AddressDto) Address |
phoneNumber required | string Phone number |
faxNumber | string Fax number |
Create a Site
"{\n \"companyId\" : \"06d0dee3-ee0a-4cac-af90-09c1a89d0bd4\",\n \"name\" : \"Example Site\",\n \"reference\" : \"Some Reference\",\n \"address\" : {\n \"address1\" : \"1355\",\n \"address2\" : \"N McLean Blvd\",\n \"suburb\" : \"Suburb\",\n \"city\" : \"Elgin\",\n \"state\" : \"Illinois\",\n \"postOrZipCode\" : \" IL 60123\",\n \"country\" : \"US\",\n \"timezone\" : \"America/Chicago\",\n },\n \"phoneNumber\" : \"+18008514691\",\n \"faxNumber\" : \"+18008514691\",\n \"latitude\" : 42.06,\n \"longitude\" : -88.31\n}"
{- "status": "OK",
- "body": {
- "id": "26202f37-8b99-493a-a6a1-8f79540ae5fa",
- "name": "Example Site"
}
}
Assign Mako to Site
siteId required | string <uuid> Site ID |
makoId required | string <uuid> Mako ID |
Assign a Mako to Site
{- "siteId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "makoId": "61000d29-3f6e-405a-a764-9666766a6d13"
}
{- "status": "OK"
}
Find Site by name (partial match). Optionally provide a companyId to find Sites only in a specific company
companyId | string <uuid> Example: companyId=06d0dee3-ee0a-4cac-af90-09c1a89d0bd4 |
name required | string Example: name=office |
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Site",
- "reference": "Some Reference"
}
]
}
Get Site by ID
id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Site",
- "reference": "Some Reference"
}
}
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "name": "Example Site",
- "reference": "Some Reference"
}
]
}
Update Site details
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
name | string Site name |
reference | string Reference |
object (AddressDto) Address | |
phoneNumber | string Phone number |
faxNumber | string Fax number |
latitude | number <double> Latitude |
longitude | number <double> Longitude |
{- "name": "Example Site",
- "reference": "Some Reference",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "IL 60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "latitude": 42.06,
- "longitude": -88.31
}
{- "status": "OK",
- "body": {
- "name": "Example name",
- "reference": "Example reference",
- "address": {
- "address1": "1355",
- "address2": "N McLean Blvd",
- "suburb": "Suburb",
- "city": "Elgin",
- "state": "Illinois",
- "postOrZipCode": "IL 60123",
- "country": "US",
- "timezone": "America/Chicago"
}, - "phoneNumber": "+18008514691",
- "faxNumber": "+18008514691",
- "latitude": 42.06,
- "longitude": -88.31,
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "companyName": "Example Company"
}
}
Add Mako to VPN Cloud
vpnCloudId required | string <uuid> VPN Cloud Id |
makoId required | string <uuid> Mako Id |
{- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "vpnCloudId": "61000d29-3f6e-405a-a764-9666766a6d13"
}
{- "status": "OK",
- "body": {
- "cloud": {
- "id": "1fa427f4-d932-4d2f-96b8-071606ae0f0f",
- "name": "Example VPN Cloud",
- "companyName": "Example Company"
}, - "cipherSuite": "Automatic",
- "interfaceConfiguration": [
- {
- "configurationDisabled": true,
- "interfaceDevice": {
- "id": "8b333eb5-0564-4688-a6fc-c69cbd623014",
- "name": "LAN 1",
- "network": "192.168.48.0/24"
}
}, - {
- "configurationDisabled": true,
- "interfaceDevice": {
- "id": "b831c2e7-333d-43b6-b65c-3ae610914ab9",
- "name": "LAN 2",
- "network": "192.168.49.0/24"
}
}
]
}
}
Get VPN Clouds the Mako can be a member of
Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example VPN Cloud",
- "companyName": "Example Company"
}
]
}
Get VPN Clouds the Mako is a member of
Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example VPN Cloud",
- "companyName": "Example Company"
}
]
}
Get Mako Configuration for VPN Cloud
Mako Id required | string <uuid> Example: 06d0dee3-ee0a-4cac-af90-09c1a89d0bd4 |
VPN Cloud Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
One interface with custom configuration, and one with default
{- "status": "OK",
- "body": [
- {
- "cloud": {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example VPN Cloud",
- "companyName": "Example Company"
}, - "cipherSuite": "Automatic",
- "interfaceConfiguration": [
- {
- "interfaceDevice": {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "LAN 1",
- "network": "192.168.48.0/24"
}, - "direction": "IN",
- "snat": "LEGACY",
- "weight": 10
}, - {
- "configurationDisabled": true,
- "interfaceDevice": {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "LAN 2",
- "network": "192.168.49.0/24"
}
}
]
}
]
}
Remove Mako from VPN Cloud
vpnCloudId required | string <uuid> VPN Cloud Id |
makoId required | string <uuid> Mako Id |
{- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "vpnCloudId": "61000d29-3f6e-405a-a764-9666766a6d13"
}
{- "status": "OK",
- "body": [
- {
- "id": "61000d29-3f6e-405a-a764-9666766a6d13",
- "name": "Example VPN Cloud",
- "companyName": "Example Company"
}
]
}
Update Mako Configuration for VPN Cloud
object (VpnCloudDto) VPN Cloud | |
cipherSuite | string Enum: "Automatic" "ECDHE_ECDSA_AES128_GCM" "ECDHE_ECDSA_AES256_GCM" "ECDHE_ECDSA_CHACHA20_POLY1305" "ECDHE_ECDSA_AES128_CTR" "ECDHE_ECDSA_AES256_CTR" Cipher Suite |
Array of objects (VpnNodeInterfaceDto) Interface Configuration | |
vpnCloudId required | string <uuid> VPN Cloud Id |
makoId required | string <uuid> Mako Id |
{- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "vpnCloudId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "cipherSuite": "ECDHE_ECDSA_AES128_GCM",
- "interfaceConfiguration": [
- {
- "interfaceDeviceId": "3ed4d999-6df1-4acf-8bb8-555119f76a99",
- "weight": 40,
- "snat": "LEGACY",
- "direction": "IN"
}, - {
- "interfaceDeviceId": "5f10c94d-af26-479f-a705-aa2a85d778ea",
- "configurationDisabled": true
}
]
}
One interface with custom configuration, and one with default
{- "status": "OK",
- "body": [
- {
- "cloud": {
- "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
- "name": "Example VPN Cloud",
- "companyName": "Example Company"
}, - "cipherSuite": "Automatic",
- "interfaceConfiguration": [
- {
- "interfaceDevice": {
- "id": "3ed4d999-6df1-4acf-8bb8-555119f76a99",
- "name": "LAN 1",
- "network": "192.168.48.0/24"
}, - "direction": "IN",
- "snat": "LEGACY",
- "weight": 10
}, - {
- "configurationDisabled": true,
- "interfaceDevice": {
- "id": "5f10c94d-af26-479f-a705-aa2a85d778ea",
- "name": "LAN 2",
- "network": "192.168.49.0/24"
}
}
]
}
]
}
Retrieve the state of all Mako devices owned by the company
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "state": "json"
}
]
}
Retrieve the state of all Mako devices owned by the company and its subsidiaries
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "state": "json"
}
]
}
Retrieve the state of all Mako devices at a site
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "state": "json"
}
]
}
Retrieve the online status of a Mako device
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
}
Retrieve the online status of all Mako devices owned by the company
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
]
}
Retrieve the online status of all Mako devices owned by the company and its subsidiaries
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
]
}
Retrieve the online status of all Mako devices at a site
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
]
}
Retrieve the status of a Mako device
makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "contactDate": "2016-01-01T00:00:00.000",
- "wanIpAddress": "111.111.111.111",
- "contactIpAddress": "222.222.222.222",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
}
Retrieve the status of all Mako devices owned by the company
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "contactDate": "2016-01-01T00:00:00.000",
- "wanIpAddress": "111.111.111.111",
- "contactIpAddress": "222.222.222.222",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
]
}
Retrieve the status of all Mako devices owned by the company and its subsidiaries
companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "contactDate": "2016-01-01T00:00:00.000",
- "wanIpAddress": "111.111.111.111",
- "contactIpAddress": "222.222.222.222",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
]
}
Retrieve the status of all Mako devices at a site
siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13 |
{- "status": "OK",
- "body": [
- {
- "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
- "contactDate": "2016-01-01T00:00:00.000",
- "wanIpAddress": "111.111.111.111",
- "contactIpAddress": "222.222.222.222",
- "statusTimestamp": "2016-01-01T00:00:00.000",
- "status": "Online"
}
]
}
Authenticate the user and retrieve authentication token. Post form params as application/x-www-form-urlencoded
client_id required | string Example: client_id=test.api.12nn7 Client ID |
client_secret required | string Example: client_secret=2j38nd2c43 Client secret |
{- "access_token": "YUMCABTl0kzM",
- "token_type": "Bearer",
- "expires_in": 14400
}