Wallaroo API Guide

Reference Guide for the Wallaroo API

The Wallaroo API provides users the ability to commands to a Wallaroo instance via a RCP-like HTTP API interface. This allows organizations to develop applications that can administrate Wallaroo from their own custom applications.

Wallaroo API URLs

Each instance of Wallaroo provides the Wallaroo API specifications through the following URLs.
Wallaroo uses the following format for its URLs. For more information, see the DNS Integration Guide.

https://{Wallaroo Prefix}{Service}{Wallaroo Suffix}.

Wallaroo Instance API URLhttps://{Wallaroo Prefix}.api.{Wallaroo Suffix}/v1/apiAddress for the Wallaroo instance’s API. API requests will be submitted to this instance.
Wallaroo Instance API Documentationhttps://{Wallaroo Prefix}.api.{Wallaroo Suffix}/v1/api/docsA HTML rendered view of the Wallaroo API specification.
Wallaroo Documentation Sitehttps://docs.wallaroo.ai/Wallaroo Documentation Site
Wallaroo Enterprise Keycloak Servicehttps://{Wallaroo Prefix}.keycloak.{Wallaroo Suffix}Keycloak administration console for managing users and groups. It is recommended not to interfere with this service unless necessary.
Wallaroo Enterprise Token Request URLhttps://{Wallaroo Prefix}.keycloak.{Wallaroo Enterprise Suffix}/auth/realms/master/protocol/openid-connect/tokenThe Keycloak token retrieval URL.

For example, if the Wallaroo Enterprise Prefix is wallaroo and the suffix is example.com, the URLs would be as follows:

PageExample URL
Wallaroo Instance API URLhttps://wallaroo.api.example.com/v1/api
Wallaroo Instance API Documentationhttps://wallaroo.api.example.com/v1/api/docs
Wallaroo Documentation Sitehttps://docs.wallaroo.ai/
Wallaroo Enterprise Keycloak Servicehttps://wallaroo.keycloak.example.com
Wallaroo Token Request URLhttps://wallaroo.keycloak.example.com/auth/realms/master/protocol/openid-connect/token

Wallaroo API Connection Guide

How to authenticate and connect to the Wallaroo MLOps API and Pipeline Inference URL API.

Wallaroo MLOps API Essentials Guide

Basic Guide for the Wallaroo API

Wallaroo MLOps API Reference Guide