Authentication
The mogenius REST API authenticates every request with a Bearer token in theAuthorization header:
mo_pat:. (Interactive clients such as mocli and MCP clients sign in with OAuth and receive short-lived access tokens instead; for programmatic access an API key is the right choice.)
Creating an API key
An API key is always a personal key: it is tied to your user account and inherits your permissions. When you create it, you set its scope so the key is limited to exactly what the integration needs:- Scope — an organization, a cluster, or a workspace. The same personal key can be narrowed to a single cluster or workspace.
- Role — a role from the pre-defined groups.
- Name and expiration date — to identify and time-box the key.
YOUR_WORKSPACE_API_KEY or YOUR_CLUSTER_API_KEY — to match the level each endpoint requires.
Set Image
You can use the API to perform aset image for your deployments via the mogenius operator.
Helm Upgrade
You can use the API to perform aHelm upgrade on a Helm release via the mogenius operator. For this to work, the Helm repository must be installed on the cluster first. The variable REPO_NAME in the request below refers to this Helm repository.
The Helm upgrade can be performed with an API key on workspace level, or cluster level.
Deploy a Blueprint
Blueprints are pre-configured Helm charts. Deploying one via the API is a two-step flow:- Read the blueprint to get its chart coordinates and default values.
- Install that chart with the Helm install endpoint.
cluster-id header. Use a cluster-level API key (or a workspace-level key with editor permissions); installing requires editor/admin rights on the cluster.
1. List blueprints
id, displayName, description, category, and tags.
2. Get a blueprint’s details
repository and chart (name and version) plus its default install target (namespace, release) and default values. Use these to build the install request.
3. Install the chart
Install the blueprint’s chart as a standard Helm release. For repository-based charts, the Helm repository must be added to the cluster first (thechart value has the form REPO_NAME/CHART_NAME).
Manage Ports & Hostnames
You canget, add, and delete ports and hostnames from deployments, just like from the UI. mogenius will automatically create or update the corresponding service and ingress resources.
Here’s example requests with configuration options on each parameter. Make sure to remove the comments when copying the example.