API Usage

By using the NEQTO API you agree to the terms of service outlined in the NEQTO API Terms of Service. Through the API, you can register, change, and delete the objects your company uses. You can execute it from your own own server, RESTful Client, or even integrate API calls into your own program. Authorized credentials are required for executing API calls.

The Global API is used for device, licensing, and account management. The Global API is not limited to a single region.

Region APIs represent physical data centers or locations such as Asia Pacific or North America. There are multiple Region APIs. The endpoint changes based on the region name. We recommend using the region closest to your physical devices.

Endpoints

Service	Name	Endpoint	Note
Authentication API	auth	https://auth.neqto.com/
Global API	global	https://global.neqto.com/	Global API Reference
AP Region API	asia-pacific-1	https://asia-pacific-1.neqto.com/	Regional API Reference
NA Region API	north-america-1	https://north-america-1.neqto.com/	Regional API Reference

Getting Authorized Credentials

First, prepare login information.

Parameter	Contents
Company Code	The code that identifies the company the account belongs to.
Email	Registered E-mail address of account
Password	The set password of account

In your preferred tool, please set the above parameters in the body of your request and execute.

Request

Parameters
URL	https://auth.neqto.com/account/api-token-auth
method	POST
Content-Type	application/json

body

{
    "company_code": "your company code",
    "email": "your login user",
    "password": "your user's login password"
}

Response

The token will be valid for 24 hours, which can be up to exp (Epoch seconds).

{
    "token": "eyJ0eXAiOiJKV1QiLCJ...9C6PW9pudTYUR-HdDI",
    "language": "",
    "auth_header_prefix": "JWT",
    "exp": 123
}

API Execution

The example below shows a GET request to the group list API. In your preferred tool, please set the following parameters in the body of your request then execute the API call to the Group List API Endpoint. For Authorization parameter, please set "JWT VALUEOFTOKENHERE". Use single-byte spaces.

Request

Parameters
URL	https://asia-pacific-1.neqto.com/groups
method	GET
Content-Type	application/json
Authorization	jwt eyJ0eXAiOiJKV1QiLCJ...9C6PW9pudTYUR-HdDI

Response

The maximum number of data to be returned at one time is 100. If you have more than 100 data, please request to the next parameter.

{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": "group's uuid",
            "name": "test",
            "note": "",
            "updated_at": "2018-11-16T01:58:59.705133Z",
            "node_count": 0
        }
    ]
}

API Rate Limit

There are API limit for each license plan. For more information, please see API Access in System Management & Deployment of the Pricing.

---

Updated: 2022-07-14