API: Overview

Generated from the API's OpenAPI schema. Paths are relative to https://cloud.tebibhost.com. Authentication, errors, pagination and idempotency are on the API overview.

GET/api/v1/orgs/{organization_id}/overview

Get Overview (getOverview)

The home page: what runs, money and spend, what needs attention, recent activity.

Any member of the organization may call it (a project-limited member has a home page too); each section needs the permission of its own API and is null when the caller lacks it.

IAM action: org:DescribeProjectcompute:DescribeVMcompute:DescribeVolumebilling:GetBillingaudit:ListEvents

Parameter	In	Type	Description
organization_id required	path	string

Responses

• 200 OK (OverviewOut)
• 400 Invalid request (ErrorOut)
• 401 Not authenticated (ErrorOut)
• 403 Access denied: the error names the action and the resource (ErrorOut)
• 404 Not found (also: the resource belongs to another organization) (ErrorOut)
• 409 Conflict or quota exceeded (ErrorOut)
• 422 Idempotency key reused for a different request (ErrorOut)
• 429 Rate limited (ErrorOut)

Fields of OverviewOut

Field	Type	Description
activity	array of OverviewActivityOut (nullable)
attention	array of OverviewAttentionOut
country	string
generated_at	string (date-time)
local_currency	string (nullable)	Shown next to USD at the published FX rate (GET /api/v1/fx-rates)
money	OverviewMoneyOut (nullable)
organization_id	string
organization_name	string
projects	OverviewProjectsOut (nullable)
vms	OverviewVmsOut (nullable)