Skip to content

understanding-the-api.md

Latest commit

 

History

History
10 lines (6 loc) · 832 Bytes

understanding-the-api.md

File metadata and controls

10 lines (6 loc) · 832 Bytes
Raw

Understanding the API

The Cloud Manager API is composed of two components:

  • An inbound HTTP-based API which can be used by Cloud Manager customers to read and manipulate the state of their CI/CD pipelines.
  • An outbound event system which allows Cloud Manager customers to receive events when key events happen in their CI/CD pipelines.

While it is possible to use only one or the other of these components, in most cases integrations will use both components. That said, it is best to start with just one, get it working, and then move on to the other component.

The steps to get started are different for these two components. Read Create API Integration to get started with the inbound API and Create Event Integration to get started with the event API.