Register Iot Device

1min
POST
http://{base_url}/core/api/v1/mts/devices/{deviceId}/onboard
This endpoint can be used by any source that needs to send data to MTS via the AWS-IoT MQTT broker. The API accepts a deviceId. This hardware ID needs to be unique for every device. In the case of FE mobile apps, the IMEI number of the device is to be used to make the call.
Path Parameters
deviceId
string
*
Header Parameters
X-COREOS-TID
string
*
X-COREOS-ACCESS
string
*
X-COREOS-REQUEST-ID
string
*
X-COREOS-USERINFO
string
Responses
200
OK - The request succeeded.
object
request
Request
error
Error
data
IotManagerResponse
400
Bad request - The server is unable to process the request due to something that is perceived to be a client error.
ErrorResponse
error
Error
*
request
Request
*
data
ID
401
Unauthorized - The client's identity is unknown to the server. Verify that you are accessing the correct Tenant and that your client ID and client secret are valid on that Tenant.
ErrorResponse
error
Error
*
request
Request
*
data
ID
503
Server error - The server is not ready to handle the request. This could be due to maintenance downtime or system resource constraints.
ErrorResponse
error
Error
*
request
Request
*
data
ID
Curl
JS
Ruby
Python
curl --location --globoff --request POST 'http://{base_url}/core/api/v1/mts/devices/{deviceId}/onboard' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
curl --location --globoff --request POST 'http://{base_url}/core/api/v1/mts/devices/{deviceId}/onboard' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json'
Responses
200
400
401
503
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {
    "deviceId": "1234",
    "message": "Returned new Certificates.",
    "rootCa": "abcd",
    "certificate": "abcd",
    "privateKey": "abcd",
    "mqttBrokerEndpoint": "acgmu9dvzb111-ats.iot.ap-southeast-1.amazonaws.com",
    "mqttBrokerPort": "9993",
    "mqttConnectionVariant": "aws"
  }
}
// OK - The request succeeded. 
{
  "request": {
    "body": {},
    "queryString": "",
    "uri": ""
  },
  "error": {
    "additionalInfo": {},
    "code": 0,
    "description": ""
  },
  "data": {
    "deviceId": "1234",
    "message": "Returned new Certificates.",
    "rootCa": "abcd",
    "certificate": "abcd",
    "privateKey": "abcd",
    "mqttBrokerEndpoint": "acgmu9dvzb111-ats.iot.ap-southeast-1.amazonaws.com",
    "mqttBrokerPort": "9993",
    "mqttConnectionVariant": "aws"
  }
}
﻿
﻿
Updated 20 Sep 2024
Did this page help you?
API to fetch route between two geolocations
Get Device Details