OPopenziti
Session

List sessions

Changed on

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

Request

Query parameters

limitinteger
offsetinteger
filterstring

Response

A list of sessions

Example response

{
  "data": [
    {
      "_links": {
        "key": {
          "comment": "comment",
          "href": "https://openapi-generator.tech",
          "method": "method"
        }
      },
      "createdAt": "2000-01-23T04:56:07.000+00:00",
      "id": "id",
      "tags": {},
      "updatedAt": "2000-01-23T04:56:07.000+00:00",
      "apiSession": {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "entity": "entity",
        "id": "id",
        "name": "name"
      },
      "apiSessionId": "apiSessionId",
      "edgeRouters": [
        {
          "appData": {},
          "capabilities": [
            "capabilities",
            "capabilities"
          ],
          "cost": 5248,
          "disabled": true,
          "hostname": "hostname",
          "isOnline": true,
          "name": "name",
          "noTraversal": true,
          "supportedProtocols": {
            "key": "supportedProtocols"
          },
          "syncStatus": "syncStatus",
          "version": "version",
          "urls": {
            "key": "urls"
          }
        },
        {
          "appData": {},
          "capabilities": [
            "capabilities",
            "capabilities"
          ],
          "cost": 5248,
          "disabled": true,
          "hostname": "hostname",
          "isOnline": true,
          "name": "name",
          "noTraversal": true,
          "supportedProtocols": {
            "key": "supportedProtocols"
          },
          "syncStatus": "syncStatus",
          "version": "version",
          "urls": {
            "key": "urls"
          }
        }
      ],
      "identityId": "identityId",
      "service": {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "entity": "entity",
        "id": "id",
        "name": "name"
      },
      "serviceId": "serviceId",
      "token": "token",
      "type": "Dial"
    },
    {
      "_links": {
        "key": {
          "comment": "comment",
          "href": "https://openapi-generator.tech",
          "method": "method"
        }
      },
      "createdAt": "2000-01-23T04:56:07.000+00:00",
      "id": "id",
      "tags": {},
      "updatedAt": "2000-01-23T04:56:07.000+00:00",
      "apiSession": {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "entity": "entity",
        "id": "id",
        "name": "name"
      },
      "apiSessionId": "apiSessionId",
      "edgeRouters": [
        {
          "appData": {},
          "capabilities": [
            "capabilities",
            "capabilities"
          ],
          "cost": 5248,
          "disabled": true,
          "hostname": "hostname",
          "isOnline": true,
          "name": "name",
          "noTraversal": true,
          "supportedProtocols": {
            "key": "supportedProtocols"
          },
          "syncStatus": "syncStatus",
          "version": "version",
          "urls": {
            "key": "urls"
          }
        },
        {
          "appData": {},
          "capabilities": [
            "capabilities",
            "capabilities"
          ],
          "cost": 5248,
          "disabled": true,
          "hostname": "hostname",
          "isOnline": true,
          "name": "name",
          "noTraversal": true,
          "supportedProtocols": {
            "key": "supportedProtocols"
          },
          "syncStatus": "syncStatus",
          "version": "version",
          "urls": {
            "key": "urls"
          }
        }
      ],
      "identityId": "identityId",
      "service": {
        "_links": {
          "key": {
            "comment": "comment",
            "href": "https://openapi-generator.tech",
            "method": "method"
          }
        },
        "entity": "entity",
        "id": "id",
        "name": "name"
      },
      "serviceId": "serviceId",
      "token": "token",
      "type": "Dial"
    }
  ],
  "meta": {
    "apiEnrollmentVersion": "apiEnrollmentVersion",
    "apiVersion": "apiVersion",
    "filterableFields": [
      "filterableFields",
      "filterableFields"
    ],
    "pagination": {
      "limit": 0.8008281904610115,
      "offset": 6.027456183070403,
      "totalCount": 1.4658129805029452
    }
  }
}

Changes

  • f7b51eaafbbbRevision changes
    • breaking

      the response property ////// became nullable for the status

    • breaking

      the response property ///////// became nullable for the status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

  • 19dfd92f02a2Revision changes
    • info

      added the non-success response with the status