Citrix

Citrix Machine Catalogs API

Manage machine catalogs and provisioning

GitHub OpenAPI

Operations 5

GET /MachineCatalogs Citrix List machine catalogs #
POST /MachineCatalogs Citrix Create a machine catalog #
GET /MachineCatalogs/{catalogId} Citrix Get a machine catalog #
PUT /MachineCatalogs/{catalogId} Citrix Update a machine catalog #
DELETE /MachineCatalogs/{catalogId} Citrix Delete a machine catalog #

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-machine-catalogs-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-machine-catalogs-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-machine-catalogs-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Citrix DaaS REST Machine Catalogs API
  description: REST API for managing Citrix Desktop as a Service (DaaS) cloud deployments, including machine catalogs, delivery groups, applications, sessions, and hypervisor connections.
  version: '1.0'
  contact:
    name: Citrix Support
    url: https://support.citrix.com/
  termsOfService: https://developer.cloud.com/citrix-developer-terms-of-use
servers:
- url: https://api.cloud.com/cvad/manage
  description: Citrix DaaS Production
security:
- bearerAuth: []
tags:
- name: Machine Catalogs
  description: Manage machine catalogs and provisioning
paths:
  /MachineCatalogs:
    get:
      operationId: listMachineCatalogs
      summary: Citrix List machine catalogs
      description: Retrieve all machine catalogs configured within the customer site.
      tags:
      - Machine Catalogs
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      responses:
        '200':
          description: List of machine catalogs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineCatalogCollection'
        '401':
          description: Unauthorized
    post:
      operationId: createMachineCatalog
      summary: Citrix Create a machine catalog
      description: Create a new machine catalog for provisioning virtual machines.
      tags:
      - Machine Catalogs
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMachineCatalogRequest'
      responses:
        '201':
          description: Machine catalog created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineCatalog'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
  /MachineCatalogs/{catalogId}:
    get:
      operationId: getMachineCatalog
      summary: Citrix Get a machine catalog
      description: Retrieve details of a specific machine catalog.
      tags:
      - Machine Catalogs
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/catalogId'
      responses:
        '200':
          description: Machine catalog details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineCatalog'
        '401':
          description: Unauthorized
        '404':
          description: Machine catalog not found
    put:
      operationId: updateMachineCatalog
      summary: Citrix Update a machine catalog
      description: Update properties of an existing machine catalog.
      tags:
      - Machine Catalogs
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/catalogId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateMachineCatalogRequest'
      responses:
        '200':
          description: Machine catalog updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MachineCatalog'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized
        '404':
          description: Machine catalog not found
    delete:
      operationId: deleteMachineCatalog
      summary: Citrix Delete a machine catalog
      description: Delete an existing machine catalog.
      tags:
      - Machine Catalogs
      parameters:
      - $ref: '#/components/parameters/CitrixCustomerId'
      - $ref: '#/components/parameters/CitrixInstanceId'
      - $ref: '#/components/parameters/catalogId'
      responses:
        '204':
          description: Machine catalog deleted
        '401':
          description: Unauthorized
        '404':
          description: Machine catalog not found
components:
  schemas:
    MachineCatalog:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the machine catalog
        name:
          type: string
          description: Name of the machine catalog
        description:
          type: string
          description: Description of the machine catalog
        allocationType:
          type: string
          enum:
          - Static
          - Random
          description: How machines are allocated to users
        provisioningType:
          type: string
          enum:
          - MCS
          - PVS
          - Manual
          description: Provisioning method for machines
        sessionSupport:
          type: string
          enum:
          - SingleSession
          - MultiSession
          description: Session support type
        machineCount:
          type: integer
          description: Number of machines in the catalog
        zone:
          type: object
          properties:
            id:
              type: string
              description: Zone identifier
            name:
              type: string
              description: Zone name
    UpdateMachineCatalogRequest:
      type: object
      properties:
        name:
          type: string
          description: Updated name
        description:
          type: string
          description: Updated description
    MachineCatalogCollection:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/MachineCatalog'
    CreateMachineCatalogRequest:
      type: object
      required:
      - name
      - allocationType
      - provisioningType
      - sessionSupport
      properties:
        name:
          type: string
          description: Name for the new machine catalog
        description:
          type: string
          description: Description for the machine catalog
        allocationType:
          type: string
          enum:
          - Static
          - Random
          description: Machine allocation type
        provisioningType:
          type: string
          enum:
          - MCS
          - PVS
          - Manual
          description: Provisioning method
        sessionSupport:
          type: string
          enum:
          - SingleSession
          - MultiSession
          description: Session support type
  parameters:
    catalogId:
      name: catalogId
      in: path
      required: true
      description: Machine catalog 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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.0 bearer token from Citrix Cloud authentication
externalDocs:
  description: Citrix DaaS REST APIs Documentation
  url: https://developer-docs.citrix.com/en-us/citrix-daas-service-apis/citrix-daas-rest-apis/overview.html