Documentation Powered by ReDoc

# Mako API (1.0)

Download OpenAPI specification:Download

License: Commercial License

## addCompany

Add a new company under a parent company

##### Request Body schema: application/json

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

### Responses

/config/v1/addCompany

### Request samples

- Payload

Content type
application/json
`
{

- "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"

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## deleteCompany

Delete company

##### path Parameters

id required | string <uuid> Example: ac68adfc-6d80-4e43-947a-66070e244fee

### Responses

/config/v1/deleteCompany/{id}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## findCompanyByNameLike

Find company with a matching name

##### query Parameters

companyName required | string Example: companyName=test Company name to search for (partial match)

### Responses

/config/v1/findCompanyByNameLike

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "ac68adfc-6d80-4e43-947a-66070e244fee",
    - "name": "Test Company"
    },
  - {
    - "id": "6aa6ddc6-23f1-411b-baf8-7a4d5256b9f4",
    - "name": "Other Company"
    }
  ]

}`

## getCompany

Get company by ID

##### path Parameters

id required | string <uuid> Example: ac68adfc-6d80-4e43-947a-66070e244fee Company ID

### Responses

/config/v1/getCompany/{id}

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## listAllCompanies

List all companies

### Responses

/config/v1/listAllCompanies

### Response samples

- default

Content type
application/json
`
{

- "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"
    }
  ]

}`

## listChildCompanies

Get child companies by parent company id

##### path Parameters

companyId required | string <uuid> Example: ac68adfc-6d80-4e43-947a-66070e244fee

### Responses

/config/v1/listChildCompanies/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "ac68adfc-6d80-4e43-947a-66070e244fee",
    - "name": "Test Company"
    }
  ]

}`

## listCompaniesByPerson

Get companies for person

##### path Parameters

personId required | string <uuid> Example: ac68adfc-6d80-4e43-947a-66070e244fee

### Responses

/config/v1/listCompaniesByPerson/{personId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "ac68adfc-6d80-4e43-947a-66070e244fee",
    - "name": "Test Company"
    }
  ]

}`

## listCountries

List countries

### Responses

/config/v1/listCountries

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "abbreviate": "AL",
    - "name": "Albania",
    - "currency": "USD"
    },
  - {
    - "abbreviate": "AS",
    - "name": "American Samoa",
    - "currency": "USD"
    }
  ]

}`

## listTimezones

List timezones by country

##### path Parameters

abbr required | string Example: PL

### Responses

/config/v1/listTimezones/{abbr}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "zoneId": "America/Anchorage",
    - "name": "Alaska Standard Time",
    - "region": "United States"
    },
  - {
    - "zoneId": "America/Chicago",
    - "name": "Central Time",
    - "region": "USA"
    }
  ]

}`

## updateCompany

Update Company details

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

status | string Enum: "OK" "FAILED"
| object (CompanyDto)
| object (ErrorDto)

### Responses

/config/v1/updateCompany/{companyId}

### Request samples

- Payload

Content type
application/json
`
{

- "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"

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## deleteLabelByInterfaceDeviceAndId

Delete Label by Id for Ethernet Interface.

##### path Parameters

interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
labelId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteLabelByInterfaceDeviceAndId/{interfaceDeviceId}/{labelId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteLabelByInterfaceDeviceAndLabel

Delete Label by Interface Device Id and Label for InterfaceDevice.

##### path Parameters

interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
label required | string Example: someLabel

### Responses

/config/v1/deleteLabelByInterfaceDeviceAndLabel/{interfaceDeviceId}/{label}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteLabelByMakoAndId

Delete Label by Id for Mako Device.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
labelId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteLabelByMakoAndId/{makoId}/{labelId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteLabelByMakoAndLabel

Delete Label by Label for Mako Device.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
label required | string Example: someLabel

### Responses

/config/v1/deleteLabelByMakoAndLabel/{makoId}/{label}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteLabelBySiteAndId

Delete Label by Id for Site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
labelId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteLabelBySiteAndId/{siteId}/{labelId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteLabelsForSite

Delete Label by Label for Site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
label required | string Example: someLabel

### Responses

/config/v1/deleteLabelBySiteAndLabel/{siteId}/{label}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## getLabelByInterfaceDeviceAndLabel

Find Ethernet Interface Label by Ethernet Interface UUID and label.

##### path Parameters

interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
label required | string Example: someLabel

### Responses

/config/v1/getLabelByInterfaceDeviceAndLabel/{interfaceDeviceId}/{label}

### Response samples

- default

Content type
application/json
`"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"label\":\"value1\t\"}}"`

## getLabelByMakoAndLabel

Find Mako Device Label by mako UUID and label.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
label required | string Example: someLabel

### Responses

/config/v1/getLabelByMakoAndLabel/{makoId}/{label}

### Response samples

- default

Content type
application/json
`"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"label\":\"value1\t\"}}"`

## getLabelBySiteAndLabel

Find Site Label by Site UUID and label.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
label required | string Example: someLabel

### Responses

/config/v1/getLabelBySiteAndLabel/{siteId}/{label}

### Response samples

- default

Content type
application/json
`"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"label\":\"value1\t\"}}"`

## getLabelsByInterfaceDevice

Find Ethernet Interface Labels by Ethernet Interface UUID.

##### path Parameters

interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getLabelsByInterfaceDevice/{interfaceDeviceId}

### Response samples

- default

Content type
application/json
`"{\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]}"`

## getLabelsByMako

Find Mako Device Labels by Mako Device UUID.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getLabelsByMako/{makoId}

### Response samples

- default

Content type
application/json
`"{\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]}"`

## getLabelsBySite

Find Site Labels by Site UUID.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getLabelsBySite/{siteId}

### Response samples

- default

Content type
application/json
`"{\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]}"`

## putLabelForInterfaceDevice

Put Label for InterfaceDevice.

##### path Parameters

interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
label | string

### Responses

/config/v1/putLabelForInterfaceDevice/{interfaceDeviceId}

### Request samples

- Payload

Content type
application/json
`
{

- "label": "someVal"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
  - "label": "someVal"
  }

}`

## putLabelForMako

Put Label for Mako Device.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
label | string

### Responses

/config/v1/putLabelForMako/{makoId}

### Request samples

- Payload

Content type
application/json
`
{

- "label": "someVal"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
  - "label": "someVal"
  }

}`

## putLabelForSite

Put Label for Site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
label | string

### Responses

/config/v1/putLabelForSite/{siteId}

### Request samples

- Payload

Content type
application/json
`
{

- "label": "someVal"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
  - "label": "someVal"
  }

}`

## putLabelsForInterfaceDevice

Put Labels for Ethernet Interface.

##### path Parameters

interfaceDeviceId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

Array ()

id | string <uuid>
label | string

### Responses

/config/v1/putLabelsForInterfaceDevice/{interfaceDeviceId}

### Request samples

- Payload

Content type
application/json
`"[\t{\t\t\"label\": \"someVal\t\"}, \t{\t\t\"label\": \"someVal2\t\"}]"`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
    - "label": "someVal"
    },
  - {
    - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
    - "label": "someVa2l"
    }
  ]

}`

## putLabelsForMako

Put Labels for Mako Device.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

Array ()

id | string <uuid>
label | string

### Responses

/config/v1/putLabelsForMako/{makoId}

### Request samples

- Payload

Content type
application/json
`"[\t{\t\t\"label\": \"someVal\t\"}, \t{\t\t\"label\": \"someVal2\t\"}]"`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
    - "label": "someVal"
    },
  - {
    - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
    - "label": "someVa2l"
    }
  ]

}`

## putLabelsForSite

Put Labels for Site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

Array ()

id | string <uuid>
label | string

### Responses

/config/v1/putLabelsForSite/{siteId}

### Request samples

- Payload

Content type
application/json
`"[\t{\t\t\"label\": \"someVal\t\"}, \t{\t\t\"label\": \"someVal2\t\"}]"`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
    - "label": "someVal"
    },
  - {
    - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
    - "label": "someVa2l"
    }
  ]

}`

## addLicence

Add a licence code

##### Request Body schema: application/json

makoId required | string <uuid> Mako ID to add licence for
licenceCode required | string Licence code

### Responses

/config/v1/addLicence

### Request samples

- Payload

Content type
application/json
`
{

- "makoId": "7741327b-a91d-4c7c-a80b-2b9482c93826",
- "licenceCode": "string"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## addMako

Add Mako

##### Request Body schema: application/json

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)

### Responses

/config/v1/addMako

### Request samples

- Payload

Content type
application/json
Example
Create a Mako using hardware model and put it into an existing site
Create a Mako using hardware model and put it into an existing site
Create a Mako using identification and put it into an existing site
Create a Mako using hardware model and create a new site for it

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"

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## addMakoFromTemplate

Add Mako from template (copy Mako)

##### Request Body schema: application/json

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

### Responses

/config/v1/addMakoFromTemplate

### Request samples

- Payload

Content type
application/json
Example
Add Mako from template and put it into an existing site
Add Mako from template and put it into an existing site
Add Mako from template and create a new site for it

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"
      }
    }
  ]

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## deleteMako

Delete mako

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteMako/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## doGet

### Responses

/config/v1

## findMakosByNameLike

Find Mako by name (partial match). Optionally provide a companyId to find Makos only in a specific company

##### query Parameters

companyId | string <uuid> Example: companyId=06d0dee3-ee0a-4cac-af90-09c1a89d0bd4
name required | string Example: name=office

### Responses

/config/v1/findMakosByNameLike

### Response samples

- default

Content type
application/json
`
{

- "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"
    }
  ]

}`

## getAvailableEnterpriseTemplates

Get a list of Enterprise Templates (including inherited) the Mako can be assigned to

##### path Parameters

Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getAvailableEnterpriseTemplates/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    - "name": "Example Template",
    - "pciTemplate": true,
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "companyName": "Example Company"
    }
  ]

}`

## getAvailableEnterpriseTemplatesWithoutInherited

Get a list of Enterprise Templates (not including inherited) the Mako can be assigned to

##### path Parameters

Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getAvailableNotInheritedEnterpriseTemplates/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    - "name": "Example Template",
    - "pciTemplate": true,
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "companyName": "Example Company"
    }
  ]

}`

## getInterfacesForMako

Get a list of Interfaces for Mako.

##### path Parameters

Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getInterfacesForMako/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "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
    }
  ]

}`

## getMako

Get mako by ID

##### path Parameters

id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getMako/{id}

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## getMakoByMac

Get Mako by MAC address

##### path Parameters

macAddress required | string Example: 10:30:22:33:11:44

### Responses

/config/v1/getMakoByMac/{macAddress}

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## getSubscribedEnterpriseTemplates

Get a list of Enterprise Templates the Mako is assigned to

##### path Parameters

Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getSubscribedEnterpriseTemplates/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    - "name": "Example Template",
    - "pciTemplate": true,
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "companyName": "Example Company"
    }
  ]

}`

## listMakos

List Makos for company

##### path Parameters

companyId required | string <uuid>

### Responses

/config/v1/listMakos/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "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"
    }
  ]

}`

## subscribeEnterpriseTemplate

Subscribe Mako to Enterprise Template

##### Request Body schema: application/json

enterpriseTemplateId required | string <uuid> Enterprise Template Id
makoId required | string <uuid> Mako Id

### Responses

/config/v1/subscribeEnterpriseTemplate

### Request samples

- Payload

Content type
application/json
`
{

- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "enterpriseTemplateId": "61000d29-3f6e-405a-a764-9666766a6d13"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "name": "Example Template",
    - "pciTemplate": true,
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "companyName": "Example Company"
    }
  ]

}`

## unsubscribeEnterpriseTemplate

Unsubscribe Mako from Enterprise Template

##### Request Body schema: application/json

enterpriseTemplateId required | string <uuid> Enterprise Template Id
makoId required | string <uuid> Mako Id

### Responses

/config/v1/unsubscribeEnterpriseTemplate

### Request samples

- Payload

Content type
application/json
`
{

- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "enterpriseTemplateId": "61000d29-3f6e-405a-a764-9666766a6d13"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "name": "Example Template",
    - "pciTemplate": true,
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "companyName": "Example Company"
    }
  ]

}`

## updateMako

Update Mako details

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

name | string Mako name (department name)

### Responses

/config/v1/updateMako/{makoId}

### Request samples

- Payload

Content type
application/json
`
{

- "name": "Example Mako"

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## deleteMetadataByCompanyAndId

Delete Metadata by metadata Id.

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
metadataId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteMetadataByCompanyAndId/{companyId}/{metadataId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteMetadataByCompanyAndKey

Delete Metadata by Company Id and Key.

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
key required | string Example: someKey

### Responses

/config/v1/deleteMetadataByCompanyAndKey/{companyId}/{key}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteMetadataByMakoAndId

Delete Metadata by Metadata Id.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
metadataId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteMetadataByMakoAndId/{makoId}/{metadataId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteMetadataByMakoAndKey

Delete Metadata by Mako Id and Key.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
key required | string Example: someKey

### Responses

/config/v1/deleteMetadataByMakoAndKey/{makoId}/{key}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteMetadataBySiteAndId

Delete Metadata by Metadata Id.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
metadataId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteMetadataBySiteAndId/{siteId}/{metadataId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteMetadataBySiteAndKey

Delete Metadata by Key for site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
key required | string Example: someKey

### Responses

/config/v1/deleteMetadataBySiteAndKey/{siteId}/{key}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## getMetadataByCompany

Find Company Metadata by Company UUID.

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getMetadataByCompany/{companyId}

### Response samples

- default

Content type
application/json
`"{\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]}"`

## getMetadataByCompanyAndKey

Find Company Metadata by Company UUID and key.

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
key required | string Example: someKey

### Responses

/config/v1/getMetadataByCompanyAndKey/{companyId}/{key}

### Response samples

- default

Content type
application/json
`"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"key\":\t\t\"mkn1\",\t\t\"value\":\"value1\t\"}}"`

## getMetadataByMako

Find Mako Device Metadata by Mako Device UUID.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getMetadataByMako/{makoId}

### Response samples

- default

Content type
application/json
`"{\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]}"`

## getMetadataByMakoAndKey

Find Mako Device Metadata by mako UUID and key.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
key required | string Example: someKey

### Responses

/config/v1/getMetadataByMakoAndKey/{makoId}/{key}

### Response samples

- default

Content type
application/json
`"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"key\":\t\t\"mkn1\",\t\t\"value\":\"value1\t\"}}"`

## getMetadataBySite

Find Site Metadata by site UUID.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getMetadataBySite/{siteId}

### Response samples

- default

Content type
application/json
`"{\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]}"`

## getMetadataBySiteAndKey

Find Site Metadata by site UUID and key.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13
key required | string Example: someKey

### Responses

/config/v1/getMetadataBySiteAndKey/{siteId}/{key}

### Response samples

- default

Content type
application/json
`"{\t\"status\":\"OK\",\t\"body\":{\t\t\"id\":\"3a62cac6-d5b8-43fe-8cb4-c0747cc0c289\",\t\t\"key\":\t\t\"mkn1\",\t\t\"value\":\"value1\t\"}}"`

## putMetadataForCompany

Put Metadata for Company.

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
key | string
value | string

### Responses

/config/v1/putMetadataForCompany/{companyId}

### Request samples

- Payload

Content type
application/json
`
{

- "key": "mkn5",
- "value": "someVal"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
  - "key": "mkn5",
  - "value": "someVal"
  }

}`

## putMetadataForMako

Put Metadata for Mako Device.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
key | string
value | string

### Responses

/config/v1/putMetadataForMako/{makoId}

### Request samples

- Payload

Content type
application/json
`
{

- "key": "mkn5",
- "value": "someVal"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
  - "key": "mkn5",
  - "value": "someVal"
  }

}`

## putMetadataForSite

Put Metadata List for site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

Array ()

id | string <uuid>
key | string
value | string

### Responses

/config/v1/putMetadataListForSite/{siteId}

### Request samples

- Payload

Content type
application/json
`
[

- {
  - "key": "mkn5",
  - "value": "someVal"
  },
- {
  - "key": "mkn6",
  - "value": "someVal2"
  }

]`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "key": "mkn5",
    - "value": "someVal"
    },
  - {
    - "key": "mkn6",
    - "value": "someVal2"
    }
  ]

}`

## putMetadataForSite_1

Put Metadata for site.

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
key | string
value | string

### Responses

/config/v1/putMetadataForSite/{siteId}

### Request samples

- Payload

Content type
application/json
`
{

- "key": "mkn5",
- "value": "someVal"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "5683018e-4274-46b1-8a1b-4bb4d3fd3760",
  - "key": "mkn5",
  - "value": "someVal"
  }

}`

## putMetadataListForCompany

Put Metadata List for Company.

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

Array ()

id | string <uuid>
key | string
value | string

### Responses

/config/v1/putMetadataListForCompany/{companyId}

### Request samples

- Payload

Content type
application/json
`"[{\t\"key\": \"mkn5\", \t\"value\": \"someVal\"}, {\t\"key\": \"mkn6\", \t\"value\": \"someVal2\"}, ]"`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "key": "mkn5",
    - "value": "someVal"
    },
  - {
    - "key": "mkn6",
    - "value": "someVal2"
    }
  ]

}`

## putMetadataListForMako

Put Metadata List for Mako Device.

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

id | string <uuid>
key | string
value | string

### Responses

/config/v1/putMetadataListForMako/{makoId}

### Request samples

- Payload

Content type
application/json
`
[

- {
  - "key": "mkn5",
  - "value": "someVal"
  },
- {
  - "key": "mkn6",
  - "value": "someVal2"
  }

]`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "key": "mkn5",
    - "value": "someVal"
    },
  - {
    - "key": "mkn6",
    - "value": "someVal2"
    }
  ]

}`

## addPerson

Add a new person

##### Request Body schema: application/json

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 Email
allowLogin required | boolean Whether to allow user to log in
required | object (AddressDto) Address
phoneNumber | string Phone number
faxNumber | string Fax number

### Responses

/config/v1/addPerson

### Request samples

- Payload

Content type
application/json
`
{

- "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"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "f0afc736-88cb-4780-a306-99082a7e1576",
  - "firstName": "Jane",
  - "lastName": "Smith",
  - "username": "testuser",
  - "email": "testuser@makonetworks.com"
  }

}`

## deletePerson

Delete person

##### path Parameters

personId required | string <uuid>

### Responses

/config/v1/deletePerson/{personId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## getPerson

Get person by ID

##### path Parameters

id required | string <uuid> Example: f0afc736-88cb-4780-a306-99082a7e1576

### Responses

/config/v1/getPerson/{id}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "f0afc736-88cb-4780-a306-99082a7e1576",
  - "firstName": "Jane",
  - "lastName": "Smith",
  - "username": "testuser",
  - "email": "testuser@makonetworks.com"
  }

}`

## getPersonByUsername

Get person by username

##### path Parameters

username required | string Example: testuser Username

### Responses

/config/v1/getPersonByUsername/{username}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "f0afc736-88cb-4780-a306-99082a7e1576",
  - "firstName": "Jane",
  - "lastName": "Smith",
  - "username": "testuser",
  - "email": "testuser@makonetworks.com"
  }

}`

## listPeople

List people for a company

##### path Parameters

companyId required | string <uuid> Example: ae696d15-d9d8-4694-b1be-de6a8dd14f18 Company ID

### Responses

/config/v1/listPeople/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "f0afc736-88cb-4780-a306-99082a7e1576",
    - "firstName": "Jane",
    - "lastName": "Smith",
    - "username": "testuser",
    - "email": "testuser@makonetworks.com"
    }
  ]

}`

## addSite

Add Site

##### Request Body schema: application/json

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

### Responses

/config/v1/addSite

### Request samples

- Payload

Content type
application/json

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}"`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "26202f37-8b99-493a-a6a1-8f79540ae5fa",
  - "name": "Example Site"
  }

}`

## assignMakoToSite

Assign Mako to Site

##### Request Body schema: application/json

siteId required | string <uuid> Site ID
makoId required | string <uuid> Mako ID

### Responses

/config/v1/assignMakoToSite

### Request samples

- Payload

Content type
application/json

Assign a Mako to Site

`
{

- "siteId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "makoId": "61000d29-3f6e-405a-a764-9666766a6d13"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## deleteSite

Delete Site

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/deleteSite/{siteId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK"

}`

## findSitesByNameLike

Find Site by name (partial match). Optionally provide a companyId to find Sites only in a specific company

##### query Parameters

companyId | string <uuid> Example: companyId=06d0dee3-ee0a-4cac-af90-09c1a89d0bd4
name required | string Example: name=office

### Responses

/config/v1/findSitesByNameLike

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "name": "Example Site",
    - "reference": "Some Reference"
    }
  ]

}`

## getSite

Get Site by ID

##### path Parameters

id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getSite/{id}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "id": "61000d29-3f6e-405a-a764-9666766a6d13",
  - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
  - "name": "Example Site",
  - "reference": "Some Reference"
  }

}`

## listSites

List Sites for company

##### path Parameters

companyId required | string <uuid>

### Responses

/config/v1/listSitesByCompany/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "companyId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
    - "name": "Example Site",
    - "reference": "Some Reference"
    }
  ]

}`

## updateSite

Update Site details

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

##### Request Body schema: application/json

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

### Responses

/config/v1/updateSite/{siteId}

### Request samples

- Payload

Content type
application/json
`
{

- "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

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## addMakoToVpnCloud

Add Mako to VPN Cloud

##### Request Body schema: application/json

vpnCloudId required | string <uuid> VPN Cloud Id
makoId required | string <uuid> Mako Id

### Responses

/config/v1/joinVpnCloudByMako

### Request samples

- Payload

Content type
application/json
`
{

- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "vpnCloudId": "61000d29-3f6e-405a-a764-9666766a6d13"

}`

### Response samples

- default

Content type
application/json
`
{

- "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"
        }
      }
    ]
  }

}`

## getAvailableVpnClouds

Get VPN Clouds the Mako can be a member of

##### path Parameters

Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getAvailableVpnClouds/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    - "name": "Example VPN Cloud",
    - "companyName": "Example Company"
    }
  ]

}`

## getVpnCloudMemberships

Get VPN Clouds the Mako is a member of

##### path Parameters

Mako Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getVpnCloudMemberships/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    - "name": "Example VPN Cloud",
    - "companyName": "Example Company"
    }
  ]

}`

## getVpnConfigByMako

Get Mako Configuration for VPN Cloud

##### path Parameters

Mako Id required | string <uuid> Example: 06d0dee3-ee0a-4cac-af90-09c1a89d0bd4
VPN Cloud Id required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/config/v1/getVpnConfigByMako/{makoId}/forCloud/{cloudId}

### Response samples

- default

Content type
application/json

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"
          }
        }
      ]
    }
  ]

}`

## removeMakoFromVpnCloud

Remove Mako from VPN Cloud

##### Request Body schema: application/json

vpnCloudId required | string <uuid> VPN Cloud Id
makoId required | string <uuid> Mako Id

### Responses

/config/v1/leaveVpnCloudByMako

### Request samples

- Payload

Content type
application/json
`
{

- "makoId": "06d0dee3-ee0a-4cac-af90-09c1a89d0bd4",
- "vpnCloudId": "61000d29-3f6e-405a-a764-9666766a6d13"

}`

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "id": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "name": "Example VPN Cloud",
    - "companyName": "Example Company"
    }
  ]

}`

## updateVpnConfig

Update Mako Configuration for VPN Cloud

##### Request Body schema: application/json

| 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

### Responses

/config/v1/updateVpnConfig

### Request samples

- Payload

Content type
application/json
`
{

- "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
    }
  ]

}`

### Response samples

- default

Content type
application/json

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"
          }
        }
      ]
    }
  ]

}`

## getCredentialIdsForUsername

##### path Parameters

username required | string

### Responses

/periscope/v1/getCredentialIdsForUsername/{username}

### Response samples

- default

Content type
application/json
`
[

- {
  - "type": "public-key",
  - "id": "string",
  - "transports":
    [
    - "string"
    ]
  }

]`

## getUserHandleForUsername

##### path Parameters

username required | string

### Responses

/periscope/v1/getUserHandleForUsername/{username}

### Response samples

- default

Content type
application/json
`"string"`

## getUsernameForUserHandle

##### path Parameters

userHandle required | string

### Responses

/periscope/v1/getUsernameForUserHandle/{userHandle}

### Response samples

- default

Content type
application/json
`"string"`

## lookup

##### path Parameters

credentialId required | string
userHandle required | string

### Responses

/periscope/v1/lookup/{credentialId}/{userHandle}

### Response samples

- default

Content type
application/json
`
{

- "credentialId": "string",
- "userHandle": "string",
- "publicKeyCose": "string",
- "signatureCount": 0,
- "backupEligible": true,
- "backupState": true

}`

## lookupAll

##### path Parameters

credentialId required | string

### Responses

/periscope/v1/lookupAll/{credentialId}

### Response samples

- default

Content type
application/json
`
[

- {
  - "credentialId": "string",
  - "userHandle": "string",
  - "publicKeyCose": "string",
  - "signatureCount": 0,
  - "backupEligible": true,
  - "backupState": true
  }

]`

## getMakoDeviceState

Retrieve the state of a Mako device

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoDeviceState/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
  - "state": "json"
  }

}`

## getMakoDeviceStateByCompany

Retrieve the state of all Mako devices owned by the company

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoDeviceStateByCompany/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "state": "json"
    }
  ]

}`

## getMakoDeviceStateByCompanyAndChildren

Retrieve the state of all Mako devices owned by the company and its subsidiaries

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoDeviceStateByCompanyAndChildren/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "state": "json"
    }
  ]

}`

## getMakoDeviceStateBySite

Retrieve the state of all Mako devices at a site

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoDeviceStateBySite/{siteId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "state": "json"
    }
  ]

}`

## getMakoOnlineStatus

Retrieve the online status of a Mako device

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoOnlineStatus/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  {
  - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
  - "statusTimestamp": "2016-01-01T00:00:00.000",
  - "status": "Online"
  }

}`

## getMakoOnlineStatusByCompany

Retrieve the online status of all Mako devices owned by the company

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoOnlineStatusByCompany/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "statusTimestamp": "2016-01-01T00:00:00.000",
    - "status": "Online"
    }
  ]

}`

## getMakoOnlineStatusByCompanyAndChildren

Retrieve the online status of all Mako devices owned by the company and its subsidiaries

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoOnlineStatusByCompanyAndChildren/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "statusTimestamp": "2016-01-01T00:00:00.000",
    - "status": "Online"
    }
  ]

}`

## getMakoOnlineStatusBySite

Retrieve the online status of all Mako devices at a site

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoOnlineStatusBySite/{siteId}

### Response samples

- default

Content type
application/json
`
{

- "status": "OK",
- "body":
  [
  - {
    - "cpeId": "61000d29-3f6e-405a-a764-9666766a6d13",
    - "statusTimestamp": "2016-01-01T00:00:00.000",
    - "status": "Online"
    }
  ]

}`

## getMakoStatus

Retrieve the status of a Mako device

##### path Parameters

makoId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoStatus/{makoId}

### Response samples

- default

Content type
application/json
`
{

- "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"
  }

}`

## getMakoStatusByCompany

Retrieve the status of all Mako devices owned by the company

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoStatusByCompany/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "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"
    }
  ]

}`

## getMakoStatusByCompanyAndChildren

Retrieve the status of all Mako devices owned by the company and its subsidiaries

##### path Parameters

companyId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoStatusByCompanyAndChildren/{companyId}

### Response samples

- default

Content type
application/json
`
{

- "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"
    }
  ]

}`

## getMakoStatusBySite

Retrieve the status of all Mako devices at a site

##### path Parameters

siteId required | string <uuid> Example: 61000d29-3f6e-405a-a764-9666766a6d13

### Responses

/status/v1/getMakoStatusBySite/{siteId}

### Response samples

- default

Content type
application/json
`
{

- "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"
    }
  ]

}`

## auth

Authenticate the user and retrieve authentication token. Post form params as application/x-www-form-urlencoded

##### query Parameters

client_id required | string Example: client_id=test.api.12nn7 Client ID
client_secret required | string Example: client_secret=2j38nd2c43 Client secret

### Responses

/auth/v1/auth

### Response samples

- default

Content type
application/json
`
{

- "access_token": "YUMCABTl0kzM",
- "token_type": "Bearer",
- "expires_in": 14400

}`