API: Activity
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}/activity
List Activity (listActivity)
IAM action: audit:ListEvents
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
principal | query | string (nullable) | |
action | query | string (nullable) | |
resource | query | string (nullable) | |
project_id | query | string (nullable) | |
outcome | query | "success" | "denied" | "failed" (nullable) | |
since | query | string (date-time) (nullable) | |
until | query | string (date-time) (nullable) | |
limit | query | integer (nullable) | |
cursor | query | string (nullable) |
Responses
200OK (ActivityPage)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of ActivityPage
| Field | Type | Description |
|---|---|---|
items | array of ActivityEventOut | |
next_cursor | string (nullable) |
GET/api/v1/orgs/{organization_id}/alerts
List Alerts (listAlerts)
IAM action: activity:ListAlerts
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string |
Responses
200OK (AlertsOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of AlertsOut
| Field | Type | Description |
|---|---|---|
items | array of AlertOut |
GET/api/v1/orgs/{organization_id}/billing/spend
Get Spend (getSpend)
IAM action: billing:DescribeSpend
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
month | query | string (nullable) |
Responses
200OK (SpendOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of SpendOut
| Field | Type | Description |
|---|---|---|
by_day | array of SpendDayOut | |
by_meter | array of SpendMeterOut | |
by_project | array of SpendProjectOut | |
by_resource | array of SpendResourceOut | |
end | string (date-time) | |
month | string | |
start | string (date-time) | |
total_micro | integer |
GET/api/v1/orgs/{organization_id}/notifications
List Notifications (listNotifications)
IAM action: notifications:ListNotifications
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
unread | query | boolean | |
limit | query | integer (nullable) | |
cursor | query | string (nullable) |
Responses
200OK (NotificationPage)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of NotificationPage
| Field | Type | Description |
|---|---|---|
items | array of NotificationOut | |
next_cursor | string (nullable) |
POST/api/v1/orgs/{organization_id}/notifications/read
Mark All Read (markAllRead)
IAM action: notifications:MarkNotificationsRead
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string |
Responses
200OK (MarkedOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of MarkedOut
| Field | Type | Description |
|---|---|---|
marked | integer |
GET/api/v1/orgs/{organization_id}/notifications/summary
Notifications Summary (notificationsSummary)
IAM action: notifications:ListNotifications
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string |
Responses
200OK (NotificationSummaryOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of NotificationSummaryOut
| Field | Type | Description |
|---|---|---|
latest_at | string (date-time) (nullable) | |
unread | integer |
POST/api/v1/orgs/{organization_id}/notifications/{notification_id}/read
Mark Notification Read (markNotificationRead)
IAM action: notifications:MarkNotificationsRead
| Parameter | In | Type | Description |
|---|---|---|---|
organization_id required | path | string | |
notification_id required | path | string |
Responses
200OK (MarkedOut)400Invalid request (ErrorOut)401Not authenticated (ErrorOut)403Access denied: the error names the action and the resource (ErrorOut)404Not found (also: the resource belongs to another organization) (ErrorOut)409Conflict or quota exceeded (ErrorOut)422Idempotency key reused for a different request (ErrorOut)429Rate limited (ErrorOut)
Fields of MarkedOut
| Field | Type | Description |
|---|---|---|
marked | integer |