UCP API Documentation

The Universal Control Plane API is a REST API, available using HTTPS, that enables programmatic access to swarm resources that are managed by UCP. UCP exposes the full Docker Engine API, so you can extend your existing code with UCP features. The API is secured with role-based access control so that only authorized users can make changes and deploy applications to your Docker swarm.

The UCP API is accessible in the same IP addresses and domain names that you use to access the web UI. It's the same API that the UCP web UI uses, so everything you can do on the UCP web UI from your browser, you can also do programmatically.

The system manages swarm resources by using collections, which you access through the /collection endpoint. For example, GET /defaultCollection/<userid> retrieves the default collection for a user. Learn more about resource collections.

  • The /roles endpoint lets you enumerate and create custom permissions for accessing collections.

  • The /accounts endpoint enables managing users, teams, and organizations.

  • The /configs endpoint gives you access to the swarm's configuration.