Internal API Reference

This API can only be accessed from inside a container running on Cycle. For our main API documentation, please see here.

Inside every container running on Cycle, there is a Unix socket mounted at /var/run/cycle/api/api.sock. You can send HTTP requests over this socket to access information about the local environment, access secrets, and much more.

The way this internal API functions is very similar to how Cycle's main API works, though the purpose is different. The internal API is primarily used by instances to learn about their environment, and dynamically update as deployments change. In the future, we expect you'll be able to use the internal API to register service containers and much more.

The internal API returns identical JSON responses to the main API. There is also a websocket based API that you can tune into for streaming platform updates.

API Libraries

We've released an official NodeJS (Typescript) library, with Go support on the way. With the exception of the Notification Pipeline, all queries can be made with cURL as well.

Socket Path
/var/run/cycle/api/api.sock