Skip to content

OSCAR API

OSCAR exposes a secure REST API available at the Kubernetes master's node IP through an Ingress Controller or a Gateway API HTTPRoute. This API has been described following the OpenAPI Specification and it is available below.

ℹ️

The bearer token used to run a service can be either the OSCAR service access token or the user's Access Token if the OSCAR cluster is integrated with EGI Check-in.

The /system/quotas endpoints report CPU, memory, volume, and MinIO bucket quota information when those subsystems are enabled. Administrators can update per-user MinIO bucket limits through /system/quotas/user/{userId} by setting the minio.buckets and minio.storage_per_bucket fields.

When a request would push a user over their MinIO bucket quota, the service and bucket creation endpoints (/system/services and /system/buckets) respond with 403 Forbidden and a machine-readable JSON body:

{
  "status": "error",
  "code": "QuotaExceeded",
  "error": "MinIO bucket quota exceeded for user <userId>: limit <limit>, current <current>, requested new buckets <requested>",
  "details": {
    "owner": "<userId>",
    "limit": <limit>,
    "current": <current>,
    "requested": <requested>
  }
}