get Registries

get

Get all registries under a subscription

Authorizations

bearerAuthapiKey

Path parameters

subscriptionIdstringRequired

Subscription ID

Query parameters

pageNumberintegerOptional

Page Number

pageSizeintegerOptional

Page Size

registryIdsstringOptional

A list of registry string IDs in array format. For example, ['registry0', 'registry12']. If empty, this field is ignored. Maximum IDs: 10,000

Responses

200

OK

application/json

400

Bad Request

application/json

404

Not Found

application/json

500

Internal Server Error

application/json

get

HTTPcURLJavaScriptPython

GET /omnicore/subscriptions/{subscriptionId}/registries HTTP/1.1
Host: api.korewireless.com
Authorization: Bearer JWT
Accept: */*

{
  "deviceRegistries": [
    {
      "id": "text",
      "name": "text",
      "parent": "text",
      "createdOn": "text",
      "updatedOn": "text",
      "credentials": [
        {
          "publicKeyCertificate": {
            "certificate": "text",
            "format": "X509_CERTIFICATE_PEM",
            "x509Details": {
              "expiryTime": "text",
              "issuer": "text",
              "publicKeyType": "text",
              "signatureAlgorithm": "text",
              "startTime": "text",
              "subject": "text"
            }
          },
          "id": "text"
        }
      ],
      "httpConfig": {
        "httpEnabledState": "HTTP_ENABLED"
      },
      "mqttConfig": {
        "mqttEnabledState": "MQTT_ENABLED"
      },
      "logLevel": "INFO",
      "isNatsRoute": true,
      "eventNotificationConfigs": [
        {
          "pubsubTopicName": "text",
          "subfolderMatches": "text"
        }
      ],
      "logNotificationConfig": {
        "pubsubTopicName": "text"
      },
      "stateNotificationConfig": {
        "pubsubTopicName": "text"
      },
      "customOnboardNotificationConfig": {
        "pubsubTopicName": "text"
      },
      "customOnboardEnabled": true,
      "numberOfDevices": 1,
      "numberOfGateways": 1
    }
  ],
  "pageNumber": 1,
  "pageSize": 1,
  "totalCount": 1
}

Authorization: apiKey

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

Curl

curl -L -X GET 'https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-H 'x-api-key: <API_KEY_VALUE>'

Python

import requests

url = "https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries"

payload={}
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer <TOKEN>',
  'x-api-key': '<API_KEY_VALUE>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {

  url := "https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")
  req.Header.Add("x-api-key", "<API_KEY_VALUE>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

JS

const axios = require('axios');

let config = {
  method: 'get',
  url: 'https://api.korewireless.com/omnicore/subscriptions/:subscriptionId/registries',
  headers: { 
    'Accept': 'application/json', 
    'Authorization': 'Bearer <TOKEN>', 
    'x-api-key': '<API_KEY_VALUE>'
  }
};

axios(config)
.then((response) => {
  console.log(JSON.stringify(response.data));
})
.catch((error) => {
  console.log(error);
});