Object storage

S3-compatible object storage.

A bucket

GET/services/{service_id}/object-storage

Needs the permission storage:read

Its endpoint, size and usage.

Path

service_idrequiredstring (uuid)

Response 200

namerequiredstring
endpointrequiredstring
consolerequiredstring
regionrequiredstring
size_gbrequiredinteger | null
used_gbrequirednumber | null
runningrequiredboolean
backupobject | null
staterequiredstring
max_age_hoursrequiredinteger
last_write_atrequiredstring (date-time) | null
checked_atrequiredstring (date-time) | null
curl "https://portal.nimag.net/api/v1/services/{service_id}/object-storage" \
  -H "Authorization: Bearer nck_…"
{
  "name": "string",
  "endpoint": "string",
  "console": "string",
  "region": "string",
  "size_gb": 0,
  "used_gb": 0,
  "running": true,
  "backup": {
    "state": "string",
    "max_age_hours": 0,
    "last_write_at": "2026-01-31T12:00:00Z",
    "checked_at": "2026-01-31T12:00:00Z"
  }
}

Object storage plans

GET/storage-plans

Any key

Response 200

namerequiredstring
kindstringdefault "storage"
size_gbrequiredinteger
max_age_hoursinteger | null
extrasrequiredstring[]
extras_enstring[]default []
pricesobject[]default []
monthsrequiredinteger
amountrequirednumber
currencyrequiredstring
curl "https://portal.nimag.net/api/v1/storage-plans" \
  -H "Authorization: Bearer nck_…"
[
  {
    "name": "string",
    "kind": "storage",
    "size_gb": 0,
    "max_age_hours": 0,
    "extras": [
      "string"
    ],
    "extras_en": [],
    "prices": []
  }
]