Citrix Virtual Apps and Desktops REST APIs

How to get details about a specific site

Use REST APIs to get details about a specific customer site.

Follow the prerequisites and examples to get started with this API.

You can make API requests using the PowerShell code, C# code, Python, or any tool that supports invoking the REST API.

Prerequisites to get details about a specific site

Get details about a specific site using any REST API tool

Learn from the following example to get details about a specific customer site using any REST API tool.

Request

GET https://[DdcServerAddress]/cvad/manage/Sites/{nameOrId} HTTP/1.1 Accept: application/json Content-Type: application/json; charset=utf-8 Authorization: CWSAuth bearer=<token-from-prerequisites> Citrix-CustomerId: loy6oujtu6a4

Response

HTTP/1.1 200 OK citrix-transactionid: 2edd8219-94e7-4157-8831-ce70f1360c95 content-Length: 4262 content-Type: application/json; charset=utf-8 date: "Thu, 10 Feb 2022 07:17:33 GMT" Server: Citrix Systems, Inc. { "OrchestationApiVersion": 99, "LicenseServerName": null, "LicenseServerPort": null, "LicenseServerUri": null, "LicensingModel": "UserDevice", "SiteConfigurationComplete": false, "PrimaryZone": { "Id": "00000000-0000-0000-0000-000000000000", "Uid": null, "Name": "Initial Zone" }, "ProductCode": "Unknown", "ProductEdition": "Unknown", "ProductVersion": "7.34", "SiteServices": [ { "ServiceName": "Delegated Administration", "ServiceType": "Admin", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "TestAdminAccessMultiple", "TestAdminAccessMultipleExclusiveAccess", "FeatureToggle", "Citrix Cloud Identity Support", "HiddenPermissionsAndRoles", "HiddenRolesSettable", "TenantSpecificScope" ] }, { "ServiceName": "Configuration", "ServiceType": "Config", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "ControllerVersioning", "ExportFeatureTable", "LicenseServerUri", "BurnInDateAsString", "ZonesSupport", "FeatureToggle", "ZoneExternalUidSupport", "MultiTenantSupport" ] }, { "ServiceName": "Configuration Logging", "ServiceType": "Log", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "EnhancedDataStoreCmdlet", "MultipleDataStore", "PropertyFiltering", "FeatureToggle", "AdminLevel" ] }, { "ServiceName": "AD Identity", "ServiceType": "Acct", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "DelegatedAdministration", "ConfigurationLogging", "FeatureToggle" ] }, { "ServiceName": "Host", "ServiceType": "Hyp", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "LocalStorageCaching", "PersonalvDiskStorage", "DelegatedAdministration", "ConfigurationLogging", "VirtualGpu ", "SecurityGroup", "CloudProvisioning", "PublicProvisioningSdk", "ConfigurationObjectCapabilities", "ZonesSupport", "SslThumbprintSdk", "ConnectionCapabilityAutoRefresh", "FeatureToggle", "TemporaryStorage", "HypervisorLocalizedStrings" ] }, { "ServiceName": "App Library", "ServiceType": "AppLib", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "FeatureToggle", "AppLibAppVApplicationsPolicyCmdlet" ] }, { "ServiceName": "Machine Creation", "ServiceType": "Prov", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "PersonalvDiskStorage", "DelegatedAdministration", "ConfigurationLogging", "VirtualGpu", "ResetAdministratorPasswords", "CloudProvisioning", "ApplicationScanning", "FastImageUpdate", "PublicProvisioningSdk", "AppDisks", "Workflow4", "FeatureToggle", "WriteBackCache", "FullDiskClone", "WriteBackCacheDiskIndexTracking", "CatalogSizeHinting" ] }, { "ServiceName": "Broker", "ServiceType": "Broker", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "AnonymousSessions", "AnyViaAGSetting", "ApplicationFolders", "ApplicationGroups", "ApplicationTagging", "ApplicationUsageLimits", "AppProtection", "AutomaticRestartForUntaggedMachines", "AutoscaleForcedLogOffs", "CatalogTags", "ConfigurationLogging", "ConnectionLeasing", "DefaultMinFunctionalLevel", "DefaultReuseMachinesWithoutShutdownInOutage", "DelegatedAdministration", "DesktopGroupRebootCycleTags", "DesktopsFaulted", "DynamicSessionTimeouts", "ExplicitPreferredControllerHC", "FlushScopeCache", "FunctionalLevelL5", "FunctionalLevelL7", "FunctionalLevelL7_20", "FunctionalLevelL7_25", "FunctionalLevelL7_30", "FunctionalLevelL7_6", "FunctionalLevelL7_7", "FunctionalLevelL7_8", "FunctionalLevelL7_9", "FunctionalLevelSupport", "HdxSslControl", "ImportMachineFromProvisioningScheme", "LicenseServerProbe", "LimitSdkMaxRecordCount", "LocalHostCacheCapability", "MachineCommands", "MachineConfiguration", "MachineLogOnType", "MachinePublishedName", "MachineSpecificSupportedPowerActions", "MachineTagging", "MaintenanceModeReason", "Metadata", "MultipleRebootSchedulesPerGroup", "MultipleRebootWarnings", "MultiSession", "MultiTypeLicensing", "PerAppMachineConfigurations", "PerControllerLicensingStatus", "PersonalvDiskStorage", "PvdAbsoluteThrottling", "RdsAutoscaling", "RebootSchedule", "RemotePCConfiguration", "ReserveMachine", "RestrictAutoscaleTag", "RestrictToTag", "ScheduledNaturalReboot", "SessionLinger", "SessionPreLaunch", "SessionRecordingControl", "SimplifiedApplicationSupport", "SingleAppPerSession", "TagDescriptions", "TagRemoveAllVisibleRelations", "TagUsageReporting", "TestDatabaseConnection", "TrialOperationVerification", "UnconfiguredMachinesLog", "UserDeviceLicensing", "UseVerticalScalingForRdsLaunches", "VdiHalfHourGranularity", "VmToolsReporting", "XmlServiceKeys", "ZonePreference", "ZonesSupport" ] }, { "ServiceName": "Monitor", "ServiceType": "Monitor", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "EnhancedDataStoreCmdlet", "MultipleDataStore", "FeatureToggle" ] }, { "ServiceName": "Storefront", "ServiceType": "Sf", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "EnhancedDiagnostics", "FullStoreFrontURLs", "FeatureToggle" ] }, { "ServiceName": "Trust", "ServiceType": "Trust", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "FeatureToggle", "BearerTokenViaPoSH" ] }, { "ServiceName": "VdaUpdateService", "ServiceType": "Vus", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "FeatureToggle" ] }, { "ServiceName": "Environment Test", "ServiceType": "EnvTest", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "ConfigurationSettings", "ObjectDiscoveryLimitSetting", "FeatureToggle" ] }, { "ServiceName": "Analytics", "ServiceType": "Analytics", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "FeatureToggle" ] }, { "ServiceName": "Orchestration", "ServiceType": "Orch", "CurrentSchemaVersion": null, "DesiredSchemaVersion": null, "Capabilities": [ "FeatureToggle", "XAExpress v1", "GetCatalogsAndCatalogDetailsAsyncR74", "DoMachineSearchAsyncR75", "GetDeliveryGroupsAsyncR75", "GetDeliveryGroupApplicationsAsyncR75", "GetDeliveryGroupsDesktopsAsyncR75", "GetContainersParentDistinguishedNameR75", "GetApplicationGroupDeliveryGroupsAsyncR77", "GetAppVServersAsyncR77", "GetApplicationFtasAsyncR77", "GetAppVPackagesAsyncR77", "GetHypervisorResourcesR76", "GetHypervisorsAndResourcePoolsR79", "AddTotalItemsInMachineAndSessionSearchR77", "DoDeliveryGroupSearchR78", "GetMachineCatalogMachinesAsync77", "ApplicationsPaginationSupportR78", "GetMachineCatalogDeliveryGroupAssociationsR78", "GetDeliveryGroupApplicationsLimitR78", "GetDeliveryGroupsApplicationGroupsLimitR78", "AppVManagementServerSupportR78", "SupportSessionCountAsMachineSearchPropertyR79", "AddScopeInMachineAndSessionSearchResponseR79", "GetDeliveryGroupsMachineCatalogsLimitR79", "ApplicationRefinementR78", "ApplicationRefinementR79", "GetMachineCatalogLastMasterImageAsyncR78", "GetMachineCatalogDetailsWithFieldsR79", "ApplicationFieldsSupportR79", "GetDeliveryGroupsDesktopsLimitR78", "GetDeliveryGroupsLimitR79", "GetMachineCatalogMachineAccountsLimitR80", "GetApplicationRecommendNameForAddApplicationR81", "SiteSecurityKeyManagementR83", "CreatePvsCatalogFromMachinesR83", "AppProtectionAndMachineLogonTypeR85", "ScheduledNaturalRebootR86", "RestartScheduleOnMaintainedMachinesR87", "LoadManageMachinesR87", "StartDeliveryGroupRebootCycleR87", "TagBasedAutoscaleR87", "OrchestrationSupportR87", "OrchestrationSupportR88", "OrchestrationSupportR89", "OrchestrationSupportR90", "OrchestrationSupportR91", "OrchestrationSupportR92", "OrchestrationSupportR93", "OrchestrationSupportR94", "DrainingUntilShutdownR87", "AddMachinesToCatalogViaCsvFileR86", "GroupPolicyBatchPrioritizationR87", "MachineSearchWithSkipR87", "ChangeApplicationIconR87", "ConfigLogSearchR87", "MachineCatalogManageTagsR87", "VdiHalfHourOrchR87", "RemotePCWOLR87", "DynamicSessionTimeoutsR87", "FmaDAAdminGroupSync", "MCSCatalogImport" ] } ], "EnabledFeatures": [ "AppCentricTroubleshooting", "AppDNA", "ApplicationDashboard", "ApplicationGroups", "ApplicationLaunchFailureTracking", "ApplicationMonitorData", "ApplicationProbing", "AppVSingleAdmin", "AppVSingleAdminHttpStreaming", "AppVSingleAdminIsolationGroups", "AppVSingleAdminShortcutEnumeration", "AutoReconnectBreakdown", "AwsCaptureInstanceProperties", "AwsPluginEnabled", "AzureGermany", "AzureManagedDisks", "AzureResourceGraphEnabled", "AzureRMPlugin", "AzureRmPluginEnabled", "CitrixManagedObjects", "CloudFeatureOverride", "CloudHostedMachines", "CloudProvisioningOptimizations", "CombinedProvisioningAndPowerManagement", "ConfigLoggingDBPurge", "ConfigurationLogging", "ConfigurationLoggingCloud", "CustomAzureResourceGroups", "CustomReporting", "CustomRole", "CVADCSPSupport", "DAExclusiveAccess", "DedicatedFullDiskClone", "DefaultReuseMachinesWithoutShutdownInOutage", "DelegatedXmlTrust", "DesktopProbing", "DesktopUsage", "directorcloudalerts", "DiskUtilization", "FmaDACustomRoles", "GcpPluginEnabled", "GPOLogonDurationBreakdown", "GpuMonitoring", "HclPluginPreferenceExecuteOnCloudDdc", "HdxInsightIntegration", "HistoricalMonitorData", "HypervisorHealth", "LicenseConcurrency", "LinuxVDAShadowing", "LocalAppLaunch", "LocalHostCache", "LogOnPerformanceV2", "machineconsolidation", "ManagedAnonymous", "ManagedDiskPreview", "MCSBatchPowerActions", "MCSMasterImageNote", "MCSParallelizeBatchPowerActions", "MultiGeo", "MultiSessionApplications", "MultiSessionDesktops", "NutanixAhvXiPluginEnabled", "odatav4webapi", "OneMonthMonitorDataRetention", "ProactiveNotifications", "ProactiveNotificationsV2", "ProfileLoadBreakdown", "ProfileManagement", "PublishedContent", "rdsautoscaling", "RDSLicensingHealthDirector", "RegistrationWebhook", "RemotePC", "RenderJSPanel", "ResourceUtilization", "RestrictToTag", "SendLicensingEventToEventHub", "SessionRecordingControl", "SingleSessionApplications", "SingleSessionDesktops", "SkywayOrchestrationAPI", "StartupMetrics", "SyncZonesToResourceLocations", "UnconfiguredMachinesLog", "UniversalClaimsTenantContext", "VerticalLoadBalancing", "WebStudio", "WebStudioDeliveryGroupsNode", "WebStudioDeliveryGroupsWizard", "WebStudioDeliveryGroupsWizardEdit", "WebStudioDeliveryGroupsWizardPhase2", "WebStudioDeliveryGroupsWizardPhase3", "WebStudioDeliveryGroupsWizardPhase4", "XmlIDCredentialsWithPassword", "ZonePreferenceFeature", "StorageOptimization", "AdvancedWorkspaceResiliency", "aes256peerkeys", "appinstancespervdalimit", "applibraryincontainer", "applibrarysinglevirtualsite", "appopdataingestion", "AppProtection", "AppProtectionContextualAccess", "AppUsagePrediction", "AppVDualAdminCloud", "AppZoneData", "asbmanagerenabled", "automaticrestartforuntaggedmachines", "autoscaleforcedlogoffs", "AutoscaleMinIdleUntaggedPercent", "AutoscaleParallelPowerActionQueuing", "AutoTagRules", "AzureADLogonVda", "AzureCustomPropertiesCaseInsensitive", "azuredisabletablestorage", "AzureEnableDiskTypeSelection", "AzureEnableIdentityDiskStorageType", "AzureEnablePersistVMWithMCSIO", "AzureEphemeralOsDiskTempDisk", "AzureImportJsonVMTemplate", "azuremultiplecatalogsameresourcegroup", "AzureTempDiskAsWriteBackCacheDisk", "BlockCredentialForwarding", "cataloglimits", "catalogpublishdesktops", "catalogresourcelocationconfig", "catalogtags", "ccsrestendpoint", "cdfcaptureazureupload", "citrixmanagedcapacityincvad", "cmdconsumptionalert", "cmdgen2vms", "cmdnatgatewaysupport", "cmdorchestrationtpapienabled", "cmdreversefederation", "cmdstandardssdsupport", "cmdtrustedplatform", "cmdvpnsupport", "CompressedSiteConfiguration", "configurationincontainer", "configurationloggingincontainer", "configurationloggingsinglevirtualsite", "configurationsinglevirtualsite", "connectionfailurev2", "ConnectorLhcPowerManagement", "ConnectorLhcPowerManagementRebootSchedule", "connectorlogsazureupload", "ConnectorStateReport", "containerautoheal", "cvadcontentsecuritypolicy", "daasglobalization", "daasstaticvdabackup", "dbmonitoringservice", "ddcautoheal", "delegatedadmin", "delegatedadmin2", "delegatedadminincontainer", "delegatedadminsinglevirtualsite", "DeliveryGroupResourceLeasing", "detectreadreplicadbfailover", "directorasaservice", "directorcspenablement", "directorloadindextrendsplit", "directornmascloudintegration", "directorratelimiting", "directorsessionlaunchpoi", "DirectorUniversalClaims", "DisableReadReplicaUsage", "disableunusedmonitorfeaturedaas", "disableunusedmonitorfeatureforxae", "diskmonitoring", "DistributedTracingSendToCasEventHub", "DistributedTracingSendToNewRelic", "dynamicsessiontimeouts", "EnableCCAuthCircuitBreaker", "enablecontainersonddc", "enabledecommission", "EnablePersistPrepVMInstructionDisk", "EnumerateAppResultsCache", "envtestsinglevirtualsite", "FeatureControlledPluginLoading", "FilterCsvExport", "FmaDAAdminGroupSync", "FmaDAAdminSync", "FmaDaCloudDirector", "fmadelegatedadmininthecloud", "fmaismcloudtrust", "fmaservicediscovery", "fmaserviceregistrationdelayuntilready", "fmaserviceregistrationv2", "fmaservicesexclusivelyincontainers", "fmaservicesexclusivelyinserviceregistry", "GcpPluginLogToSplunk", "googleanalytics", "grouppolicyasyncrestapi", "GroupPolicyModeling", "grouppolicyreread", "hcloverwebsockets", "HclSplunkLoggingEnabled", "hostedserviceui", "httprouter_v2", "HypervisorServiceCallbacksSplunkLoggingEnabled", "infrastructureanalytics", "interactivesessionbreakdown", "jsalerts", "jstrends", "JSTrends2", "legacystudioretirement", "LimitSdkMaxRecordCount", "logonconsolidation", "MachineConsoleAccess", "MCSAzureDedicatedHosts", "McsBasedMachineManagerLongPolling", "mcscatalogexport", "McsHybridAadJoinSupport", "MCSNonDomainJoinedMachines", "McsSplunkLoggingEnabled", "MCSTrustServiceAccounts", "MisconfigurationCheck", "monitorincontainer", "monitormicroservice", "monitorsinglevirtualsite", "MsixPackagePublishing", "mtdirector", "mtdirector36", "mtdirector37", "mtdirector38", "mtdirector39", "mtdirector40", "mtdirector41", "mtservicefmaadminroles", "multiplerebootschedulespergroup", "MultiTenantCVADS", "MultiTypeLicensing", "NFuseSelectServerOnly", "noalertstitlebar", "nutanixnewworkflow", "odatacloudauth", "opdataingestion", "OptimizeDirectorApiCalls", "OrchestrationLimitApiRecord", "OrchestrationLimitApiRecordPhase2", "OrchSetManageAndMonitor", "performanceanalytics", "PerformanceAnalyticsDataSanctity", "performanceanalyticsvisibility", "pollingv2", "ProvSchemeEditProperty", "purgebrokernamecache", "PvsMachineMetrics", "randomremotepccatalogs", "RebootScheduleAdditionalOptions", "redisdefinitionmigration", "RegistrationErrors", "RemoteHclProvider", "RemoteHclSessionDurabilityAws", "RemoteHclSessionDurabilityDefault", "RemoteHclSessionDurabilityIbm", "RemoteHclSessionDurabilityNutanix", "RemoteHclSessionDurabilityScvmm", "RemoteHclSessionDurabilityVsphere", "RemoteHclSessionDurabilityXen", "RenderJSCapacityManagement", "RendezvousConnection", "RendezvousConnectionV2", "sample1", "sample4", "sampleh", "samplet1", "schedulednaturalreboot", "searchusersapicancellation", "sessionrecording", "sessionscountv2", "setmanageandmonitor", "SingleAppPerSession", "SmartScaleMonitoring", "SyncConnectorlessZones", "tagbasedautoscale", "techpreviewfeature4", "tenantdeletionenabled", "testcanary", "testcanary2", "trustincontainer", "trustsinglevirtualsite", "UniversalClaims", "UniversalClaimsSync", "UseConnectorStateForBrokering", "usersearchdb", "uxvdapayloaddataingestion", "vdadatacollection", "VdaFmaTrustKeyRegistration", "vdaprocessdataingestion", "vdihalfhourgranularity", "VusEndpoints", "VusPaginatedMachineSync", "warnonkmsrearmfailure", "WebStudioMachineProfileSupport", "webstudiomultisite", "webstudiomultitypelicensing", "WebStudioNonDomainJoinedMachines", "webstudiovdacheck", "wem", "workerinstancemetadata", "workerinstancemetadata2", "xaeinmtdirector", "xaemcsapp", "xaeusagereport", "xdeallowstudioconfig", "xdeglobalization", "XDSecurityAnalyticsActions", "xiuzhentest3", "xmltrustfromheadertokenenabled", "XmlTrustFromServiceKey", "testfullfeature" ], "BaseOU": null, "ColorDepth": "TwentyFourBit", "ConnectionLeasingEnabled": false, "DefaultMinimumFunctionalLevel": "L7_20", "DefaultDesktopIconId": "1", "DnsResolutionEnabled": false, "LicenseGraceSessionsRemaining": null, "LicensedSessionsActive": null, "LicensingGraceHoursLeft": null, "LicensingGracePeriodActive": null, "PeakConcurrentLicenseUsers": null, "ReuseMachinesWithoutShutdownInOutageAllowed": false, "DefaultSecureIcaRequired": false, "TotalUniqueLicenseUsers": null, "TrustRequestsSentToTheXmlServicePort": null, "LicensingAlerts": null, "Id": "012f7438-bf8e-42ba-b1b3-2eb75d098f57", "Name": "cloudxdsite" }

Get details about a specific site using PowerShell

Learn from the following example to get details about a specific customer site using any PowerShell code.

function GetSiteDetail { param ( [Parameter(Mandatory=$true)] [string] $customerid, [Parameter(Mandatory=$true)] [string] $sitenameorid, [Parameter(Mandatory=$true)] [string] $bearerToken ) $requestUri = [string]::Format("https://[DdcServerAddress]/cvad/manage/Sites/{0}", $sitenameorid) $headers = @{ "Accept" = "application/json"; "Authorization" = "CWSAuth Bearer=$bearerToken"; "Citrix-CustomerId" = $customerid; } $response = Invoke-RestMethod -Uri $requestUri -Method GET -Headers $headers return $response } $customerid = "n2ypkklgy6cv" $siteid = "12f7438-bf8e-42ba-b1b3-2eb75d098f57" $bearerToken = "eyJ..." $response = GetSiteDetail $customerid $siteid $bearerToken

Get details about a specific site using C# code

Learn from the following example to get details about a specific customer site using any C# code.

public static async Task<string> GetSiteDetail( string customerid, string sitenameorid, string bearerToken) { var requestUri = string.Format("https://[DdcServerAddress]/cvad/manage/Sites/{0}", sitenameorid); using (var client = new HttpClient()) { client.DefaultRequestHeaders.Accept.ParseAdd("application/json"); client.DefaultRequestHeaders.Add("Citrix-CustomerId", customerid); client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("CWSAuth Bearer=" + bearerToken); var response = await client.GetAsync(requestUri); if (response != null) { var content = await response.Content.ReadAsStringAsync(); return content; } return null; } }

Get details about a specific site using Python

Learn from the following example to get details about a specific customer site using Python.

import requests def GetSiteDetail(bearerToken, customerid, sitenameorid): request_uri = "https://[DdcServerAddress]/cvad/manage/Sites/{0}".format(sitenameorid) headers = { 'Authorization': 'CWSAuth Bearer=%s' % bearerToken, 'Citrix-CustomerId': customerid, 'Content-Type': 'application/json', 'Accept': 'application/json' } response = requests.get(request_uri, headers = headers) return response.json()
Resources
Citrix Virtual Apps and Desktops REST APIs OpenAPI Specification
Copy Download
How to get details about a specific site