Skip to content

Rest API

Custom Pod Autoscalers expose a REST API that allows for interaction with the Custom Pod Autoscaler outside of configuration, at runtime.

Accessing the API

The API exposes the API at the port specified in your configuration file (default 5000), and with the URL prefix /api/<API_VERSION>.

Within a container the API can be accessed at http://localhost:<PORT>/api/<API_VERSION>.

Configuring the API

See the apiConfig section of the configuration reference.

API Versions

The API is versioned with major versions, starting with v1. The API version does not neccessarily align with the major versions of the Custom Pod Autoscaler, which is versioned with Semantic Versioning.