Citrix

Citrix Sessions API

Manage and monitor active sessions

GitHub OpenAPI

Operations 7

GET /Sessions Citrix List sessions #
GET /Sessions/{sessionId} Citrix Get a session #
POST /Sessions/{sessionId}/$logoff Citrix Log off a session #
POST /Sessions/{sessionId}/$disconnect Citrix Disconnect a session #
POST /Sessions/List Citrix List active sessions #
POST /Sessions/Disconnect Citrix Disconnect a session #
POST /Sessions/Logoff Citrix Log off a session #

Documentation

📖
Documentation
https://developer.citrix.com/citrix-virtual-apps-and-desktops/citrix-cvad-rest-apis
📖
Authentication
https://developer.citrix.com/citrix-virtual-apps-and-desktops/citrix-cvad-rest-apis/docs/how-to-get-started
📖
Documentation
https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/latest/
📖
APIReference
https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/latest/api-reference/
📖
Documentation
https://developer.citrix.com/citrix-daas/citrix-daas-rest-apis
📖
GettingStarted
https://developer.citrix.com/citrix-daas/citrix-daas-rest-apis/docs/getting-started
📖
Documentation
https://developer-docs.citrix.com/en-us/citrix-cloud/citrix-cloud-api-overview/get-started-with-citrix-cloud-apis.html
📖
GettingStarted
https://developer-docs.citrix.com/en-us/citrix-cloud/citrix-cloud-api-overview/citrix-cloud-api-walkthrough.html
📖
Authentication
https://developer-docs.citrix.com/en-us/citrix-cloud/citrix-cloud-api-overview/get-started-with-citrix-cloud-apis.html
📖
Documentation
https://developer-docs.citrix.com/en-us/storefront/storefront-web-api/overview.html
📖
GettingStarted
https://developer-docs.citrix.com/en-us/storefront/storefront-web-api/getting-started.html
📖
Documentation
https://docs.citrix.com/en-us/citrix-endpoint-management/rest-apis.html
📖
Documentation
https://developer-docs.citrix.com/en-us/secure-private-access/access-security/overview.html
📖
GettingStarted
https://developer-docs.citrix.com/en-us/secure-private-access/access-security/getting-started.html

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/citrix/refs/heads/main/openapi/citrix-sessions-api-openapi.yml

Other Resources

🔗
SDKs
https://developer-docs.citrix.com/projects/netscaler-nitro-api/en/latest/getting-started/
🔗
Reference
https://developer-docs.citrix.com/en-us/storefront/storefront-web-api/apis/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/citrix-sessions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

citrix-sessions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Citrix Sessions API
  version: '1.0'
  contact:
    name: Citrix Support
    url: https://support.citrix.com/
  termsOfService: https://developer.cloud.com/citrix-developer-terms-of-use
  description: 'Operations tagged Sessions across 2 of this provider''s published API definitions: citrix-daas-openapi.yml, citrix-storefront-web-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.cloud.com/cvad/manage
  description: Citrix DaaS Production
- url: https://{storefront-server}/Citrix/Store
  description: StoreFront Server
  variables:
    storefront-server:
      default: storefront.example.com
      description: StoreFront server hostname
tags:
- name: Sessions
  description: Manage and monitor active sessions
paths:
  /Sessions:
    get:
      operationId: listSessions
      summary: Citrix List sessions
      description: Retrieve all active sessions within the customer site.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      responses:
        '200':
          description: List of sessions
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionCollection'
        '401':
          description: Unauthorized
      security:
      - bearerAuth: []
    servers:
    - url: https://api.cloud.com/cvad/manage
      description: Citrix DaaS Production
  /Sessions/{sessionId}:
    get:
      operationId: getSession
      summary: Citrix Get a session
      description: Retrieve details of a specific session.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/sessionId'
      responses:
        '200':
          description: Session details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Session'
        '401':
          description: Unauthorized
        '404':
          description: Session not found
      security:
      - bearerAuth: []
    servers:
    - url: https://api.cloud.com/cvad/manage
      description: Citrix DaaS Production
  /Sessions/{sessionId}/$logoff:
    post:
      operationId: logoffSession
      summary: Citrix Log off a session
      description: Log off an active user session.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/sessionId'
      responses:
        '204':
          description: Session logoff initiated
        '401':
          description: Unauthorized
        '404':
          description: Session not found
      security:
      - bearerAuth: []
    servers:
    - url: https://api.cloud.com/cvad/manage
      description: Citrix DaaS Production
  /Sessions/{sessionId}/$disconnect:
    post:
      operationId: disconnectSession
      summary: Citrix Disconnect a session
      description: Disconnect an active user session without logging off.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/sessionId'
      responses:
        '204':
          description: Session disconnect initiated
        '401':
          description: Unauthorized
        '404':
          description: Session not found
      security:
      - bearerAuth: []
    servers:
    - url: https://api.cloud.com/cvad/manage
      description: Citrix DaaS Production
  /Sessions/List:
    post:
      operationId: listSessions
      summary: Citrix List active sessions
      description: Retrieve all active HDX sessions for the authenticated user.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CsrfToken'
      responses:
        '200':
          description: List of active sessions
          content:
            application/json:
              schema:
                type: object
                properties:
                  sessions:
                    type: array
                    items:
                      $ref: '#/components/schemas/Session_2'
        '401':
          description: Not authenticated
      security:
      - csrfToken: []
    servers:
    - url: https://{storefront-server}/Citrix/Store
      description: StoreFront Server
      variables:
        storefront-server:
          default: storefront.example.com
          description: StoreFront server hostname
  /Sessions/Disconnect:
    post:
      operationId: disconnectSession
      summary: Citrix Disconnect a session
      description: Disconnect an active HDX session without logging off.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CsrfToken'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - sessionId
              properties:
                sessionId:
                  type: string
                  description: Session ID to disconnect
      responses:
        '200':
          description: Session disconnected
        '401':
          description: Not authenticated
        '404':
          description: Session not found
      security:
      - csrfToken: []
    servers:
    - url: https://{storefront-server}/Citrix/Store
      description: StoreFront Server
      variables:
        storefront-server:
          default: storefront.example.com
          description: StoreFront server hostname
  /Sessions/Logoff:
    post:
      operationId: logoffSession
      summary: Citrix Log off a session
      description: Log off an active HDX session.
      tags:
      - Sessions
      parameters:
      - $ref: '#/components/parameters/CsrfToken'
      requestBody:
        required: true
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              required:
              - sessionId
              properties:
                sessionId:
                  type: string
                  description: Session ID to log off
      responses:
        '200':
          description: Session logged off
        '401':
          description: Not authenticated
        '404':
          description: Session not found
      security:
      - csrfToken: []
    servers:
    - url: https://{storefront-server}/Citrix/Store
      description: StoreFront Server
      variables:
        storefront-server:
          default: storefront.example.com
          description: StoreFront server hostname
components:
  parameters:
    sessionId:
      name: sessionId
      in: path
      required: true
      description: Session unique identifier
      schema:
        type: string
    CitrixInstanceId:
      name: Citrix-InstanceId
      in: header
      required: true
      description: Citrix DaaS site instance ID
      schema:
        type: string
    CitrixCustomerId:
      name: Citrix-CustomerId
      in: header
      required: true
      description: Citrix Cloud customer ID
      schema:
        type: string
    CsrfToken:
      name: Csrf-Token
      in: header
      required: true
      description: CSRF token read from the session cookie
      schema:
        type: string
  schemas:
    SessionCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Session'
    Session:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the session
        userName:
          type: string
          description: Username of the session owner
        state:
          type: string
          enum:
          - Active
          - Disconnected
          description: Current session state
        startTime:
          type: string
          format: date-time
          description: When the session started
        machineName:
          type: string
          description: Name of the machine hosting the session
        clientName:
          type: string
          description: Name of the client device
        applicationNames:
          type: array
          items:
            type: string
          description: Applications running in the session
    Session_2:
      type: object
      properties:
        sessionId:
          type: string
          description: Session unique identifier
        appName:
          type: string
          description: Name of the application
        publishedName:
          type: string
          description: Published name of the resource
        initialApp:
          type: string
          description: Initial application that created the session
        isActive:
          type: boolean
          description: Whether the session is currently active
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token from Citrix Cloud authentication
    csrfToken:
      type: apiKey
      in: header
      name: Csrf-Token
      description: CSRF token from session cookie for POST requests
x-refined-from:
- citrix-daas-openapi.yml
- citrix-storefront-web-openapi.yml