API introduction

1 minute read

The CloudBees cloud-native platform REST API enables interaction with your platform data through standard HTTP methods and JSON-formatted responses. It allows you to:

  • POST data to create or modify resources across the CloudBees platform.

  • GET data to retrieve information about configurations, environments, organizations and more.

  • Build custom integrations that extend the functionality of the CloudBees platform.

  • Leverage the platform to create tailored workflows and solutions that meet your specific needs.

Key features of the API

  • RESTful Design: All endpoints are based on REST principles, making the API predictable to use.

  • JSON Data Format: All requests and responses use JSON, ensuring compatibility with modern development frameworks.

  • Flexible Integration: Whether you’re building automation scripts or custom applications, the API provides the tools you need to manage resources and streamline workflows across the CloudBees platform.

API audience

This API is helpful for:

  • Developers: Build applications and integrations on top of the CloudBees platform.

  • System Administrators: Automate workflows and manage environments programmatically.

  • Product Teams: Retrieve real-time data to inform decision-making and manage feature rollouts.

Explore the API examples on the next page to get started!