UCCX Configuration REST API

See also

Sources

1. 1
   Omitting credentials or supplying incorrect credentials to a UCCX API returns 401 Unauthorized.

   API Authentication - Contact Center Express · API Authentication, failure behaviour · Checked 2026-09-22
2. 2
   The Unified CCX Administration Web Interface chapter of the Release 15.0 Administration and Operations Guide does not mention the Configuration REST API, REST or adminapi.

   Cisco Unified Contact Center Express Administration and Operations Guide, Release 15.0 - Unified CCX Administration Web Interface · Unified CCX Administration Web Interface, full chapter · Checked 2026-09-22
3. 3
   A Unified CCX administration user is an end user configured in Unified Communications Manager who has been given Administrator capability in Unified CCX, and application users created during installation hold administrator capability by default.

   Cisco Unified Contact Center Express Administration and Operations Guide, Release 15.0 - Unified CCX Administration Web Interface · Unified CCX Administration Web Interface, administration user description · Checked 2026-09-22
4. 4
   Cisco's getting-started material states the Configuration APIs are available with all three Unified CCX licence packages.

   Getting started with Cisco Unified Contact Center Express · Getting Started, Configuration API licensing note · Checked 2026-09-22
5. 5
   Cisco states that attributes editable in the Unified CCX AppAdmin web interface can be modified through the Configuration REST APIs.

   Introduction - Contact Center Express · Introduction, scope note following the supported operations list · Checked 2026-09-22
6. 6
   The Unified CCX Administration web interface is reached at https://<servername>/appadmin, a different path from the /adminapi path used by the Configuration REST API.

   Cisco Unified Contact Center Express Administration and Operations Guide, Release 15.0 - Unified CCX Administration Web Interface · Unified CCX Administration Web Interface, access URL step · Checked 2026-09-22
7. 7
   GET https://<server>/adminapi/application returns applications with self, id, applicationName, type, description, maxsession and enabled, and script-based applications additionally carry a ScriptApplication element naming the script file and a dispatch id.

   Get List of Applications - Contact Center Express · Get List of Applications, URI and sample response element names · Checked 2026-09-22
8. 8
   Authentication to the UCCX APIs is HTTPS basic authentication.

   API Authentication - Contact Center Express · API Authentication, authentication scheme statement · Checked 2026-09-22
9. 9
   The CSQ list endpoint accepts a detail query parameter, where detail=full returns expanded CSQ data and detail=fetchRequeueCsqList combined with a mediaType parameter returns the requeue-eligible CSQ list.

   Get List of CSQs - Contact Center Express · Get List of CSQs, detail=full and detail=fetchRequeueCsqList variants · Checked 2026-09-22
10. 10
    GET https://<server>/adminapi/csq/{id} returns CSQ attributes including queueType, queueAlgorithm, resourcePoolType, serviceLevel, serviceLevelPercentage, selectionCriteria and a poolSpecificInfo element carrying skillGroup and skillCompetency detail.

    Get CSQ - Contact Center Express · Get CSQ, sample response element names · Checked 2026-09-22
11. 11
    GET https://<server>/adminapi/csq returns the list of Contact Service Queues, with success code 200 and failure codes 401 and 405.

    Get List of CSQs - Contact Center Express · Get List of CSQs, first endpoint variant · Checked 2026-09-22
12. 12
    CSQ objects returned by the Configuration API carry a queueType distinguishing voice, chat and email queues, and email CSQs return additional fields including emailAuthType, channelProvider, pollingInterval, folderName and account credentials.

    Get CSQ - Contact Center Express · Get CSQ, email CSQ sample response · Checked 2026-09-22
13. 13
    The documented sample response for the Configuration API data source list includes a password element for each data source.

    Get List of Data Sources - Contact Center Express · Get List of Data Sources, password element in the sample response · Checked 2026-09-22
14. 14
    GET https://<server>/adminapi/dataSource returns configured JDBC data sources including id, self, data source name, JDBC URL, driver, username and maximum connections, with success 200 and failures 401, 404 and 405.

    Get List of Data Sources - Contact Center Express · Get List of Data Sources, URI and sample response element names · Checked 2026-09-22
15. 15
    Cisco positions the Configuration REST APIs as covering Day 1 and Day 2 configuration, stating that all initial system configuration and the configuration tasks normally done after installation can be performed through them.

    UCCX Overview - Contact Center Express · UCCX Overview, Configuration APIs integration point · Checked 2026-09-22
16. 16
    The Release 15.0 Unified CCX Documentation Guide lists the Cisco Unified Contact Center Express Developer Guide as the document describing all the configuration REST APIs and points it to developer.cisco.com rather than to a cisco.com HTML book.

    Cisco Unified Contact Center Express Documentation Guide, Release 15.0 - Documentation Guide · Documentation Guide, Cisco Unified Contact Center Express Developer Guide row · Checked 2026-09-22
17. 17
    The DevNet Configuration API reference pages carry no release version or last-updated date, so a reader cannot tell from the page which UCCX releases a documented endpoint applies to.inferred

    Introduction - Contact Center Express · Introduction, page header and footer · Checked 2026-09-22
18. 18
    GET https://<server>/adminapi/document/{path} returns repository document folders and files with path, folder name, size, date modified and modifying user, with success 200 and failures 401, 405 and 500.

    Get Document Files and Folder - Contact Center Express · Get Document Files and Folder, URI and sample response · Checked 2026-09-22
19. 19
    Cisco announced end of life for version 12.5 and 12.6 on-premises contact center applications including UCCX on June 30 2025, with end of sale December 31 2025, end of software maintenance releases December 31 2026, and last date of support December 31 2027.

    End-of-Sale and End-of-Life Announcement for the Cisco Version 12.5/12.6 of On-Premises Contact Center applications (UCCE, PCCE, UCCX, CVP) and associated On-Premises software and licenses · End-of-life milestones table · Checked 2026-09-22
20. 20
    The Configuration API documents five operations per object: LIST via GET on the collection, GET on a single instance, CREATE via POST, MODIFY via PUT, and DELETE.

    Introduction - Contact Center Express · Introduction, supported operations list · Checked 2026-09-22
21. 21
    Cisco describes the Unified CCX Configuration API as REST APIs for the configuration of inbound and outbound applications on UCCX, mirroring what the Unified CCX Application Administration interface provides.

    CiscoDevNet/uccx-sample-code · README, project description for the Unified CCX Configuration API · Checked 2026-09-22
22. 22
    The credentials accepted by the UCCX APIs are the administrator username and password configured during installation.

    API Authentication - Contact Center Express · API Authentication, credentials paragraph · Checked 2026-09-22
23. 23
    The instanceId path component is optional and is required only when a GET, PUT or DELETE targets a specific instance of an object.

    Introduction - Contact Center Express · Introduction, Instance ID component description · Checked 2026-09-22
24. 24
    Cisco documents the Configuration APIs as one of several distinct UCCX developer integration points alongside the CTI Protocol, Scripting, the Cisco Identity Service, the Finesse REST APIs and the Customer Collaboration Platform REST APIs.

    UCCX Overview - Contact Center Express · UCCX Overview, points of integration list · Checked 2026-09-22
25. 25
    All Configuration API methods support Application/XML and Application/JSON as input MIME types.

    Introduction - Contact Center Express · Introduction, MIME types statement · Checked 2026-09-22
26. 26
    The Unified CCX chapter of the Release 15.0 solution release notes lists no new, changed or deprecated Configuration REST API behaviour.

    Release Notes for Cisco Unified Contact Center Express Solution, Release 15.0 - Cisco Unified Contact Center Express · Release Notes 15.0, Unified CCX New Features, Updated Features and Deprecated Features sections · Checked 2026-09-22
27. 27
    Cisco's UCCX API authentication documentation describes no OAuth, bearer-token or single-sign-on alternative to basic authentication for the Configuration API.inferred

    API Authentication - Contact Center Express · API Authentication, full page body · Checked 2026-09-22
28. 28
    Cisco does not publish a per-endpoint role authorisation matrix for the UCCX Configuration API; role restrictions appear only as scattered per-endpoint notes.inferred

    API Authentication - Contact Center Express · API Authentication, full page body · Checked 2026-09-22
29. 29
    Cisco's AppAdmin-parity statement is scoped to editable attributes and does not amount to a documented guarantee that every UCCX administration function has a Configuration API equivalent.inferred

    Introduction - Contact Center Express · Introduction, scope note following the supported operations list · Checked 2026-09-22
30. 30
    Cisco's getting-started walkthrough configures a Postman request against an /adminapi endpoint on the UCCX server FQDN using Basic Auth with the UCCX administrator username and password.

    Getting started with Cisco Unified Contact Center Express · Getting Started, Postman Authorization tab step · Checked 2026-09-22
31. 31
    Both HTTP and HTTPS are documented as supported protocols for the Unified CCX Configuration REST API.

    Introduction - Contact Center Express · Introduction, protocol component of the URL structure · Checked 2026-09-22
32. 32
    A tool that reads the full UCCX Configuration API surface will retrieve credential material, because both the data source list and email CSQ records return account password fields.inferred

    Get List of Data Sources - Contact Center Express · Get List of Data Sources, password element in the sample response · Checked 2026-09-22
33. 33
    GET https://<server>/adminapi/resource/{id} returns an agent record including userID, firstName, lastName, extension, skillMap, autoAvailable, type, team, primarySupervisorOf and secondarySupervisorOf, with success 200 and failures 401, 404 and 405.

    Get Resource - Contact Center Express · Get Resource, URI and sample response element names · Checked 2026-09-22
34. 34
    Unified CCX resources correspond to end users in the Unified Communications Manager environment, and the resource instance id is that user ID.

    Get Resource - Contact Center Express · Get Resource, parameter description for id · Checked 2026-09-22
35. 35
    At least one Configuration API list endpoint is documented as reachable by users holding Agent and Supervisor roles, with Agent-role access limited to the chat and email media types.

    Get List of CSQs - Contact Center Express · Get List of CSQs, detail=fetchRequeueCsqList variant, permissions note · Checked 2026-09-22
36. 36
    Cisco's UCCX sample code repository, which includes Configuration API samples, is MIT licensed and is explicitly stated not to be guaranteed bug free or production quality, with support offered on a best-effort basis through DevNet forums.

    CiscoDevNet/uccx-sample-code · README, disclaimer and support sections · Checked 2026-09-22
37. 37
    The DevNet sandbox release for Configuration API development, 12.5(1) SU1, falls within the release family whose end of software maintenance is December 31 2026.inferred

    End-of-Sale and End-of-Life Announcement for the Cisco Version 12.5/12.6 of On-Premises Contact Center applications (UCCE, PCCE, UCCX, CVP) and associated On-Premises software and licenses · End-of-life milestones table, read against the DevNet sandbox release statement · Checked 2026-09-22
38. 38
    The Cisco DevNet Contact Center Express sandbox, offered for developing against the CTI Protocol, the Configuration APIs and Scripting, runs Contact Center Express 12.5(1) SU1.

    Contact Center Express - Cisco DevNet · Contact Center Express DevNet landing page, sandbox section · Checked 2026-09-22
39. 39
    GET https://<server>/adminapi/{script|prompt}/download/{filePath} returns the raw file, such as an .aef script or a .wav prompt, rather than an XML or JSON representation.

    Download Script/Prompt - Contact Center Express · Download Script/Prompt, URI template and sample URIs · Checked 2026-09-22
40. 40
    GET https://<server>/adminapi/script returns script repository folder and file metadata only, comprising path, name, size, date modified and last modifying user, with success 200 and failures 401, 405 and 500.

    Get List for Script Files and Folder - Contact Center Express · Get List for Script Files and Folder, URI and sample response · Checked 2026-09-22
41. 41
    The Configuration API exposes UCCX scripts only as repository artefacts, as file metadata and as downloadable bytes, and does not expose script steps, variables or call-flow branching in any structured form.inferred

    Get List for Script Files and Folder - Contact Center Express · Get List for Script Files and Folder, sample response; read together with Download Script/Prompt · Checked 2026-09-22
42. 42
    Scripting is documented as its own UCCX integration point in which customers create telephony and multimedia application scripts in a visual programming environment, separate from the Configuration APIs.

    UCCX Overview - Contact Center Express · UCCX Overview, Scripting integration point · Checked 2026-09-22
43. 43
    A client of the UCCX Configuration API must be prepared for a server certificate that its trust store does not validate unless the operator has installed a CA-signed certificate on the UCCX node.inferred

    Getting started with Cisco Unified Contact Center Express · Getting Started, Postman Settings step · Checked 2026-09-22
44. 44
    The Contact Center Express Serviceability API is a separate runtime and diagnostics surface exposing parameters such as serviceStates, diskusage, jvmStats and systemPerformance, and is not part of the /adminapi Configuration API.

    Serviceability API Parameters - Contact Center Express · Serviceability API Parameters, parameter list · Checked 2026-09-22
45. 45
    Cisco's getting-started walkthrough instructs the reader to set Postman SSL certificate verification to OFF when calling the UCCX API.

    Getting started with Cisco Unified Contact Center Express · Getting Started, Postman Settings step · Checked 2026-09-22
46. 46
    Cisco states that the Unified CCX Standard licence package is only available for CCX versions 11.0 and below.

    Configuration API Overview - Contact Center Express · Configuration API Overview, What license level is needed to use the Configuration API? · Checked 2026-09-22
47. 47
    Team is a documented Configuration API object defined as a group of agents reporting to the same supervisor, with one primary supervisor and optional secondary supervisors, exposed through list, get, create, modify and delete operations.

    Team - Contact Center Express · Team, object description and operation sub-headings · Checked 2026-09-22
48. 48
    Unified CCX Release 15.0 no longer supports TLS 1.0 and TLS 1.1, and adds CLI commands to list, export, import and reset the system TLS cipher configuration.

    Release Notes for Cisco Unified Contact Center Express Solution, Release 15.0 - Cisco Unified Contact Center Express · Release Notes 15.0, Cipher Management new feature and deprecated features list · Checked 2026-09-22
49. 49
    The Unified CCX Configuration REST API addresses objects through the URL template <protocol>://<uccx-server>/adminapi/<object>/<instanceId>.

    Introduction - Contact Center Express · Introduction, URL structure description · Checked 2026-09-22
50. 50
    Unified CCX user IDs used as Configuration API resource identifiers may contain special characters except the forward slash and the backslash.

    Get Resource - Contact Center Express · Get Resource, note on the id parameter · Checked 2026-09-22

Documents

Cite this page

WarmTransfer. (2026, September 22). UCCX Configuration REST API. WarmTransfer. https://warmtransfer.net/knowledge/uccx-configuration-api

@misc{warmtransfer-uccx-configuration-api,
  title  = {UCCX Configuration REST API},
  author = {{WarmTransfer}},
  year   = {2026},
  url    = {https://warmtransfer.net/knowledge/uccx-configuration-api},
  note   = {Verified 2026-09-22}
}