Citrix Machines API

openapi: 3.1.0
info:
  title: Citrix ADC (NetScaler) NITRO Access Policies Machines 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: Machines
  description: Manage individual machines in catalogs
paths:
  /Machines:
    get:
      operationId: listMachines
      summary: Citrix List machines
      description: Retrieve all machines registered within the customer site.
      tags:
      - Machines
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      responses:
        '200':
          description: List of machines
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineCollection'
        '401':
          description: Unauthorized
  /Machines/{machineId}:
    get:
      operationId: getMachine
      summary: Citrix Get a machine
      description: Retrieve details of a specific machine.
      tags:
      - Machines
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/machineId'
      responses:
        '200':
          description: Machine details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Machine'
        '401':
          description: Unauthorized
        '404':
          description: Machine not found
components:
  parameters:
    CitrixInstanceId:
      name: Citrix-InstanceId
      in: header
      required: true
      description: Citrix DaaS site instance ID
      schema:
        type: string
    machineId:
      name: machineId
      in: path
      required: true
      description: Machine unique identifier
      schema:
        type: string
    CitrixCustomerId:
      name: Citrix-CustomerId
      in: header
      required: true
      description: Citrix Cloud customer ID
      schema:
        type: string
  schemas:
    MachineCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/Machine'
    Machine:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the machine
        name:
          type: string
          description: Machine name
        dnsName:
          type: string
          description: DNS name of the machine
        registrationState:
          type: string
          enum:
          - Registered
          - Unregistered
          description: Registration state with the delivery controller
        powerState:
          type: string
          enum:
          - true
          - false
          - Suspended
          - Unknown
          description: Current power state
        inMaintenanceMode:
          type: boolean
          description: Whether the machine is in maintenance mode
        currentSessionCount:
          type: integer
          description: Number of active sessions on the machine
  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