About Session Recording REST APIs

Use the Session Recording REST APIs to automate the administration of resources among session recording sites.

Use these APIs to automate the following tasks:

• List sites and servers and their corresponding recordings, events, and comments metadata.
• Create and manage recording policies, event detection policies, and event respond policies.
• Manage session recording server properties.
• Archive or delete recordings based on the retention period.

Currently, REST APIs are categorized as the following:

• CloudInterface APIs: Provides a similar API interface with the on-prem Session Recording API.
• ServerSite APIs: Manages session recording servers and load-balanced sites.
• ArchiveDelete APIs: Archives or deletes recording files, search archived recordings, and lists all archived recordings.
• Dashboard APIs: Gets management dashboard data and modify dashboard threshold settings.
• Email APIs: Manages email notification settings and subscriptions.
• AsyncTask APIs: Gets the status and results of asynchronously executed archive/delete tasks and activity feeds.

Who can use this API service

An onboarded Citrix DaaS customer with a Session Recording Full admin role can use these APIs to develop automated programs and manage site resources.

Getting started

Read Get started with Citrix Cloud APIs to ensure that you have obtained the customerId and bearer token.

Rate limits

Call rates are limited to 10 launches per second per customer ID.