Configure dedicated APIs

The Control plane->API section of the Admiral UI offers a way to configure three types of APIs:

  • public: This is the default API which is brought up. This is used by the Shippable UI, webhooks posted to SCMs by Shippable.
  • internal(optional): If configured, all the internal Shippable services will use this API.
  • console (optional): If configured, all the builds will use this API to send logs.

For most installations, the default setting of public API is enough. Configuring dedicated APIs is a highly specialized configuration and needs to be used only to address very specific performance requirements.

Configure multiple APIs