Enable the Studio API

Overview

The Studio API lets you manage your organizations by API (users, computers, groups, collections, schedules, remote experiences) — see Manage Organizations for the organization-side feature.

Before an organization administrator can enable and generate API keys from their organization’s settings, the Studio API must be enabled at the instance level, through the reemo-infra Ansible role.

Unlike the Internal API, the Studio API is exposed on the existing portal host (/api/studio-api): it does not require a dedicated hostname, mTLS certificate, or separate PKI.

Endpoint Reference

Note

The full reference of Studio API endpoints (routes, request/response schemas) is available at /api-docs/ on this documentation.

Configuration Variables

STUDIOAPI_ENABLED

Enables the Studio API for the instance. Boolean value (true / false). Default: false.

STUDIOAPI_RESTRICT_IP

List of IP addresses or ranges allowed to call the Studio API, each identified by a name. Leave empty to disable filtering.

Note

These two variables enable the feature at the instance level only. Each organization must then be enabled individually by an instance administrator, and generate its own API keys from its settings — see Manage Organizations and Organization Settings.

Example Configuration

This setting applies either in a portal_manager environment or in an infra_manager environment, depending on your deployment topology.

infra_manager:  # or portal_manager, depending on your topology
  vars:
    STUDIOAPI_ENABLED: true
    STUDIOAPI_RESTRICT_IP:
      - name: site1
        ip: "1.1.1.1/32"
      - name: site2
        ip: "1.2.2.2/32"

Points to Note

• This configuration is applied at deployment time (reemo-infra Ansible role), not from the interface.

• Once the Studio API is enabled for the instance, it remains disabled by default for each organization: see the Studio API bullet in Manage Organizations.