Configuration API#

OSMO hosts a Swagger UI that provides a full overview of the available API endpoints.

The following table provides a list of API endpoints that admins can use to configure the service.

API Endpoint

Description

/api/configs/service

System-wide settings for the OSMO service

/api/configs/workflow

Default settings for workflow execution

/api/configs/dataset

Settings for dataset storage and handling

/api/configs/backend

Compute backend configurations

/api/configs/pool

Compute pool configurations for workload distribution

/api/configs/pod_template

Kubernetes pod template configurations

/api/configs/resource_validation

Rules for validating resource requirements

/api/configs/role

User roles and permissions

Admins can access the Swagger UI at http://osmo.example.com/api/docs to use the Swagger UI to configure the service.

Swagger UI