About REST APIs in Citrix Workspace Environment Management™

The Citrix Workspace Environment Management (WEM) offering, which is part of Citrix DaaS™ (formerly Citrix Virtual Apps and Desktops™ service), provides a set of REST APIs. Use them to automate the management of WEM-managed Windows devices.

What you can manage

As an IT administrator, you can use the REST APIs to manage and optimize the resources of your Windows devices. Currently, you can perform the following management tasks:

• Manage your configuration sets
• Manage your assignment targets (formerly user-level AD objects)
• Manage your directory objects (formerly machine-level AD objects)
• Manage your actions, such as applications, printers, network drives, virtual drives, registry entries, environment variables, and group policy objects
• Manage your backups of configuration sets and settings
• Manage the files in your file repository, such as exported reports, script files, and Group Policy (ADMX) templates
• Optimize resource utilization

More management capabilities will be supported in future releases.

Deployment types

The REST APIs are available for the following two deployment types. The resource paths, request bodies, and responses are the same for both. What differs is the base URL that you call and the way that you authenticate.

• WEM service: The cloud-hosted service that is delivered through Citrix Cloud™. Requests are authorized with a Citrix Cloud bearer token. For more information, see WEM service.
• WEM on-premises: The WEM web console server that runs in your own environment. Requests are authorized with a session token that you obtain from the on-premises login API. For more information, see On-premises deployment.

WEM service

Prerequisites

This API service is useful in scenarios where you want to optimize the resources of your Windows devices. To use the service, ensure that the following conditions are met:

1. The WEM service is available and enabled in Citrix Cloud.
2. You have a customerId for the Citrix Cloud service APIs.
3. You have a bearer token for authorization to the Citrix Cloud service APIs.

For information about how to generate the customerId and bearer token, see the Get started with Citrix Cloud APIs section.

Base URLs

Base URLs vary from region to region. A list of base URLs is as follows:

• United States (US): api.wem.cloud.com
• European Union (EU): eu-api.wem.cloud.com
• Japan (JP): jp-api.wem.citrixcloud.jp
• Asia Pacific South (APS): aps-api.wem.cloud.com

Error codes with REST APIs for WEM

The WEM REST APIs support standard error codes for Citrix Cloud service APIs. The same error codes apply to both deployment types. For more information, see Citrix Cloud service error codes.

Where to go next

Follow the guidance in the following sections to manage your Windows devices:

• On-premises deployment: Authenticate against a WEM web console server in your own environment.
• Sample codes: Call the APIs from C#, JavaScript, PowerShell, and Python.
• Use cases and integrations: Work through an end-to-end example.
• API Exploration: Browse the full API reference and try requests.
• What’s new: See the APIs added in each release.