GET /api/v3/gateway
List all gateways

Returns a list of all gateways belonging to an account as per the specified criteria. This API is paginated and returns 20 gateways by default. A gateway is uniquely identified by a 'gateway_key'. This key should be used in all the other API referencing a particular gateway.

Params

Param name Description
page
optional

Page number of results to be fetched, Default 1


Value: Must be Integer.
per
optional

Number of gateways records to be returned in one page, Default 20


Value: Must be Integer.
order_by
optional

Field on which resultant gateways should be sorted


Value: Must be a String
order
optional

Order, asc or desc, in which results should be sorted


Value: Must be a String
pretty
optional

Return a pretty formatted response if true, Default is false


Value: Must be a Boolean
search
optional

Keywords based on which gateways should be searched. Currently you can search gateways on - name or tag


Value: Must be a String
scope
optional

Matching condition if multiple keywords are specified for search. Valid values are “all” or “any”. Default is “all”


Value: Must be a String

Examples

Request - listing all gateways without any criteria
  curl -X GET  -H "Content-Type:application/json" -H "X-Auth-Token:WtUFnj8pvSxVnH9e_xkq7A" https://api.datonis.io/api/v3/gateway

Response (returns first 20 records)
{
  "gateway": [
    {
      "gateway_key": "a1aad6t93b",
      "gateway_type": null,
      "name": "gosling123",
      "gateway_version": null,
      "tags": "bavdhan,pune",
      "adapters": [

      ]
    },
    {
      "gateway_key": "e54986t366",
      "gateway_type": "kura",
      "name": "trial",
      "gateway_version": "4.5.160",
      "tags": "hji",
      "adapters": [
        {
          "type": null,
          "configuration": "{}",
          "enabled": true,
          "adapter_pid": "com.altizon.gateway.SimulatorAdapter"
        },
        {
          "type": null,
          "configuration": "{}",
          "enabled": false,
          "adapter_pid": "com.altizon.gateway.OPCUAAdapter"
        }
      ]
    }
  ],
  "total_count": 1,
  "page": 1
}