Documentation
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Paginated API for Gateways list

Overview

Paginated API for Gateways provides an efficient way to retrieve large sets of gateway records from the Network Server using pagination.
It is designed for scalable environments where the number of gateways can be significant, ensuring controlled and performant data retrieval.

Key Capabilities

  • Pagination support (limit/offset-based or equivalent mechanisms)
  • Retrieval of gateway lists by customer, provider, or group
  • Filtering by gateway attributes and status
  • Optimized responses for large datasets
  • Metadata support (gateway ID, MAC address, status, and related fields)

Typical Use Cases

  • Displaying gateway inventories in management dashboards
  • Performing bulk gateway audits
  • Synchronizing gateway data with external inventory systems
  • Filtering gateways by organizational structure or status

Default parameters:

  • limit - 100
  • page - from the first page (the last added gateway is displayed first in the list)
  • sorting direction - DESC

Sorting keys:

sortField:

  • CREATED_TIME
  • NAME
  • GATEWAY_MAC
  • GATEWAY_MODEL_NAME
  • IS_PUBLIC
  • IS_LOGGING_ENABLED
  • IS_UDP_ALLOWED
  • IS_NOT_MQTTS_ALLOWED
  • STATUS

How to get Customer Gateways Paginated 

curl -X GET "https://{host}/api/v2/customer/{customer_ID}/gateways" -H "accept: */*" -H "X-Authorization: Bearer {token}"

Example with filters:

curl -X GET "https://{host}/api/v2/customer/{customer_ID}/gateways?limit=50&page=1&sortDirection=ASC&sortField=STATUS" -H "accept: */*" -H "X-Authorization: Bearer {token}"
  • {host} = Network Server or OAM host
  • {customer_ID} = Customer ID in the Network Server/OAM

How to get Gateway Group Gateways Paginated 

curl -X GET "https://{host}/api/v2/gatewayGroup/{Gateway_Group_ID}/gateways" -H "accept: */*" -H "X-Authorization: Bearer {token}"

Example with filters:

curl -X GET "https://{host}/api/v2/gatewayGroup/{Gateway_Group_ID}/gateways?limit=10&page=3&sortDirection=DESC&sortField=GATEWAY_MAC" -H "accept: */*" -H "X-Authorization: Bearer {token}"
  • {host} = Network Server or OAM host
  • {gateway_Group_ID} = Gateway Group ID in the Network Server/OAM

How to get Provider Gateways Paginated 

curl -X GET "https://{host}/api/v2/provider/{provider_ID}/gateways" -H "accept: */*" -H "X-Authorization: Bearer {provider_token}"

Example with filters:

curl -X GET "https://{host}/api/v2/provider/{provider_ID}/gateways?limit=20&page=0&sortDirection=DESC&sortField=NAME" -H "accept: */*" -H "X-Authorization: Bearer {provider_token}"
  • {host} = Network Server or OAM host
  • {provider_ID} = Provider ID in the Network Server/OAM