update Custom Onboard Request

post

https://api.korewireless.com/omnicorehttps://demo.api.korewireless.com/omnicore

/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateCustomOnboardRequest

Approve/Reject a Custom Onboard Request

Authorizations

bearerAuth & apiKey

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

x-api-keystringRequired

Path parameters

subscriptionidstringRequired

Subscription ID

registryIdstringRequired

Registry ID

deviceIdstringRequired

Device ID

Body

application/json

idstring · min: 3 · max: 256Required

namestringRead-onlyOptional

numIdstringRead-onlyOptional

parentstringRead-onlyOptional

registrystringRead-onlyOptional

blockedbooleanOptional

capresentbooleanRead-onlyOptional

subscriptionstringRead-onlyOptional

createdOnstringRead-onlyOptional

updatedOnstringRead-onlyOptional

gatewaystring[]Optional

isGatewaybooleanOptional

deviceErrorsstringRead-onlyOptional

clientOnlinebooleanRead-onlyOptional

lastConfigAckTimestringRead-onlyOptional

lastConfigSendTimestringRead-onlyOptional

lastErrorTimestringRead-onlyOptional

lastEventTimestringRead-onlyOptional

lastHeartbeatTimestringRead-onlyOptional

lastStateTimestringRead-onlyOptional

logLevelstring · enumOptionalPossible values:

customOnboardDatastringOptional

isApprovebooleanOptional

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

post

/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateCustomOnboardRequest

HTTPcURLJavaScriptPython

POST /omnicore/subscriptions/{subscriptionid}/registries/{registryId}/devices/{deviceId}/updateCustomOnboardRequest HTTP/1.1
Host: api.korewireless.com
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 776

{
  "id": "text",
  "blocked": true,
  "credentials": [
    {
      "expirationTime": "text",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "text"
      }
    }
  ],
  "gateway": [
    "text"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "isGateway": true,
  "logLevel": "INFO",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "config": {
    "acknowledged": true,
    "binaryData": "text",
    "cloudUpdateTime": "text",
    "deviceAckTime": "text",
    "version": 1
  },
  "state": {
    "binaryData": "text",
    "updateTime": "text"
  },
  "policy": {
    "Connect": true,
    "PublishState": true,
    "PublishEvents": true,
    "PublishEventsRegex": "text",
    "PublishLoopback": true,
    "SubscribeCommand": true,
    "SubscribeCommandRegex": "text",
    "SubscribeBroadcast": true,
    "SubscribeBroadcastRegex": "text",
    "SubscribeConfig": true
  },
  "customOnboardData": "text",
  "isApprove": true
}

{
  "info": "text"
}

Authorization: apiKey

name: x-api-key
in: header
type: apiKey

Curl

curl -L -X POST 'https://api.korewireless.com/omnicore/subscriptions/:subscriptionid/registries/:registryId/devices/:deviceId/updateCustomOnboardRequest' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'x-api-key: <API_KEY_VALUE>' \
--data-raw '{
  "id": "string",
  "blocked": true,
  "credentials": [
    {
      "expirationTime": "string",
      "publicKey": {
        "format": "RSA_PEM",
        "key": "string"
      }
    }
  ],
  "gateway": [
    "string"
  ],
  "gatewayConfig": {
    "gatewayAuthMethod": "GATEWAY_AUTH_METHOD_UNSPECIFIED",
    "gatewayType": "NON_GATEWAY"
  },
  "isGateway": true,
  "lastErrorStatus": {},
  "logLevel": "INFO",
  "metadata": {},
  "config": {
    "binaryData": "string",
    "version": 0
  },
  "state": {
    "binaryData": "string",
    "updateTime": "string"
  },
  "policy": {
    "Connect": true,
    "PublishState": true,
    "PublishEvents": true,
    "PublishEventsRegex": "string",
    "PublishLoopback": true,
    "SubscribeCommand": true,
    "SubscribeCommandRegex": "string",
    "SubscribeBroadcast": true,
    "SubscribeBroadcastRegex": "string",
    "SubscribeConfig": true
  },
  "customOnboardData": "string",
  "isApprove": true
}'

Python

Go

JS