Citrix Devices API

openapi: 3.1.0
info:
  title: Citrix ADC (NetScaler) NITRO Access Policies Devices API
  description: REST API for configuring and monitoring Citrix ADC (NetScaler) application delivery controllers, including load balancing virtual servers, services, service groups, SSL certificates, content switching, and system statistics.
  version: '14.1'
  contact:
    name: Citrix Support
    url: https://support.citrix.com/
  termsOfService: https://developer.cloud.com/citrix-developer-terms-of-use
servers:
- url: https://{netscaler-ip}/nitro/v1
  description: Citrix ADC NITRO API
  variables:
    netscaler-ip:
      default: 192.168.1.1
      description: NetScaler management IP address
security:
- nitroAuth: []
tags:
- name: Devices
  description: Device enrollment and lifecycle management
paths:
  /device/filter:
    post:
      operationId: filterDevices
      summary: Citrix Filter devices
      description: Search and filter enrolled devices based on criteria.
      tags:
      - Devices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeviceFilterRequest'
      responses:
        '200':
          description: Filtered device list
          content:
            application/json:
              schema:
                type: object
                properties:
                  filteredDevicesDataList:
                    type: array
                    items:
                      $ref: '#/components/schemas/Device'
        '401':
          description: Unauthorized
  /device/{deviceId}:
    get:
      operationId: getDevice
      summary: Citrix Get device details
      description: Retrieve detailed information about a specific enrolled device.
      tags:
      - Devices
      parameters:
      - name: deviceId
        in: path
        required: true
        description: Device unique identifier
        schema:
          type: string
      responses:
        '200':
          description: Device details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Device'
        '401':
          description: Unauthorized
        '404':
          description: Device not found
  /device/wipe:
    post:
      operationId: wipeDevice
      summary: Citrix Wipe a device
      description: Issue a full wipe command to a managed device.
      tags:
      - Devices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - deviceId
              properties:
                deviceId:
                  type: string
                  description: Device ID to wipe
      responses:
        '200':
          description: Wipe command sent
        '401':
          description: Unauthorized
        '404':
          description: Device not found
  /device/selectivewipe:
    post:
      operationId: selectiveWipeDevice
      summary: Citrix Selective wipe a device
      description: Issue a selective wipe to remove only corporate data from a device.
      tags:
      - Devices
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - deviceId
              properties:
                deviceId:
                  type: string
                  description: Device ID for selective wipe
      responses:
        '200':
          description: Selective wipe command sent
        '401':
          description: Unauthorized
        '404':
          description: Device not found
components:
  schemas:
    DeviceFilterRequest:
      type: object
      properties:
        start:
          type: integer
          description: Start index for pagination
        limit:
          type: integer
          description: Maximum number of results
        sortOrder:
          type: string
          enum:
          - ASC
          - DESC
          description: Sort order
        search:
          type: string
          description: Search text
    Device:
      type: object
      properties:
        id:
          type: string
          description: Device unique identifier
        serialNumber:
          type: string
          description: Device serial number
        deviceModel:
          type: string
          description: Device model name
        platform:
          type: string
          enum:
          - iOS
          - Android
          - Windows
          - macOS
          description: Device platform
        osVersion:
          type: string
          description: Operating system version
        lastAccess:
          type: string
          format: date-time
          description: Last access timestamp
        userName:
          type: string
          description: Enrolled user name
        jailbroken:
          type: boolean
          description: Whether the device is jailbroken or rooted
        managed:
          type: boolean
          description: Whether the device is managed
        compliant:
          type: boolean
          description: Whether the device is compliant with policies
  securitySchemes:
    nitroAuth:
      type: apiKey
      in: cookie
      name: NITRO_AUTH_TOKEN
      description: Session cookie from NITRO login
externalDocs:
  description: Citrix ADC NITRO API Reference
  url: https://developer-docs.netscaler.com/en-us/adc-nitro-api/current-release.html