Session
List sessions
Retrieves a list of active sessions resources; supports filtering, sorting, and pagination.
Sessions are tied to an API session and are moved when an API session times out or logs out. Active sessions (i.e. Ziti SDK connected to an edge router) will keep the session and API session marked as active.
get/sessions
Query parameters
limitinteger
offsetinteger
filterstring
Response
A list of sessions
Example response
{
"data": [
{
"_links": {
"key": {
"method": "method",
"comment": "comment",
"href": "https://openapi-generator.tech"
}
},
"type": "Dial",
"tags": {},
"token": "token",
"createdAt": "2000-01-23T04:56:07.000+00:00",
"apiSession": {
"_links": {
"key": {
"method": "method",
"comment": "comment",
"href": "https://openapi-generator.tech"
}
},
"name": "name",
"id": "id",
"entity": "entity"
},
"edgeRouters": [
{
"hostname": "hostname",
"urls": {
"key": "urls"
},
"cost": 5248,
"name": "name",
"noTraversal": true,
"disabled": true,
"isOnline": true,
"supportedProtocols": {
"key": "supportedProtocols"
},
"appData": {},
"syncStatus": "syncStatus"
},
{
"hostname": "hostname",
"urls": {
"key": "urls"
},
"cost": 5248,
"name": "name",
"noTraversal": true,
"disabled": true,
"isOnline": true,
"supportedProtocols": {
"key": "supportedProtocols"
},
"appData": {},
"syncStatus": "syncStatus"
}
],
"identityId": "identityId",
"service": {
"_links": {
"key": {
"method": "method",
"comment": "comment",
"href": "https://openapi-generator.tech"
}
},
"name": "name",
"id": "id",
"entity": "entity"
},
"id": "id",
"serviceId": "serviceId",
"apiSessionId": "apiSessionId",
"updatedAt": "2000-01-23T04:56:07.000+00:00"
},
{
"_links": {
"key": {
"method": "method",
"comment": "comment",
"href": "https://openapi-generator.tech"
}
},
"type": "Dial",
"tags": {},
"token": "token",
"createdAt": "2000-01-23T04:56:07.000+00:00",
"apiSession": {
"_links": {
"key": {
"method": "method",
"comment": "comment",
"href": "https://openapi-generator.tech"
}
},
"name": "name",
"id": "id",
"entity": "entity"
},
"edgeRouters": [
{
"hostname": "hostname",
"urls": {
"key": "urls"
},
"cost": 5248,
"name": "name",
"noTraversal": true,
"disabled": true,
"isOnline": true,
"supportedProtocols": {
"key": "supportedProtocols"
},
"appData": {},
"syncStatus": "syncStatus"
},
{
"hostname": "hostname",
"urls": {
"key": "urls"
},
"cost": 5248,
"name": "name",
"noTraversal": true,
"disabled": true,
"isOnline": true,
"supportedProtocols": {
"key": "supportedProtocols"
},
"appData": {},
"syncStatus": "syncStatus"
}
],
"identityId": "identityId",
"service": {
"_links": {
"key": {
"method": "method",
"comment": "comment",
"href": "https://openapi-generator.tech"
}
},
"name": "name",
"id": "id",
"entity": "entity"
},
"id": "id",
"serviceId": "serviceId",
"apiSessionId": "apiSessionId",
"updatedAt": "2000-01-23T04:56:07.000+00:00"
}
],
"meta": {
"apiEnrollmentVersion": "apiEnrollmentVersion",
"apiVersion": "apiVersion",
"pagination": {
"offset": 6.027456183070403,
"limit": 0.8008281904610115,
"totalCount": 1.4658129805029452
},
"filterableFields": [
"filterableFields",
"filterableFields"
]
}
}