List Gateways

get https://api.lumeo.com/v1/apps/{application_id}/gateways

List all the gateways assigned to this application.

Path Params

application_id

string

required

The application id.

Query Params

gateway_ids[]

array of uuids

Filter: Gateway ID(s)

gateway_ids[]

gateway_names[]

array of strings

Filter: Gateway Name(s)

gateway_names[]

created_ts_since

date-time

Filter: Lower bound for creation time (inclusive)

created_ts_until

date-time

Filter: Upper bound for creation time (exclusive)

updated_ts_since

date-time

Filter: Lower bound for update time (inclusive)

updated_ts_until

date-time

Filter: Upper bound for update time (exclusive)

gateway_models[]

array of strings

Filter: Gateway Model Name(s)

gateway_models[]

statuses[]

array of strings

Filter: Gateway Status(es)

statuses[]

local_ips[]

array of strings

Filter: Gateway local IP(s)

local_ips[]

versions[]

array of strings

Filter: Gateway Version(s)

versions[]

pagination

required

Specifies which type of pagination to choose.

next_cursor

string

Specifies the cursor for the next page. Can be found in the last paginated request. Only available with pagination = cursor.

prev_cursor

string

Specifies the cursor for the previous page. Can be found in the last paginated request. Only available with pagination = cursor.

page

integer

≥ 1

Specifies which page should be returned. Only available with pagination = offset.

limit

integer

Limits the number of items returned.

tagged_with[]

array of uuids

List only entities tagged with any of the given tag IDs.

tagged_with[]

include_tagged_with_descendants

boolean

Defaults to false

When listing entities tagged with a given set of tag IDs, include entities that are tagged with any descendant of those tags.

only_untagged

boolean

Defaults to false

List only untagged entities.

Response

Language

Credentials

Bearer


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://api.lumeo.com/v1/apps/application_id/gateways?pagination=cursor&include_tagged_with_descendants=false&only_untagged=false' \
3
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "pagination": "cursor",
3
  "next_cursor": "eyJkYXRldGltZSI6BENEYzNzQ0IiwidHlwZSI6Ik5leHQifQ==",
4
  "prev_cursor": "eyJkYXhUMTY6Mjk6NTcuODg3MjAyWiIsInBhcmFtX2hhc2gi==",
5
  "next_cursor_url": "https://lumeo.com/v1/example?pagination=cursor&next_cursor=eyJkYXRldGltZSI6BENEYzNzQ0IiwidHlwZSI6Ik5leHQifQ==",
6
  "prev_cursor_url": "https://lumeo.com/v1/example?pagination=cursor&next_cursor=eyJkYXhUMTY6Mjk6NTcuODg3MjAyWiIsInBhcmFtX2hhc2gi==",
7
  "page_elements": 10
8
}

200OK