Skip to content

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

ParameterInTypeDescription
organization_id requiredpathstring
principalquerystring (nullable)
actionquerystring (nullable)
resourcequerystring (nullable)
project_idquerystring (nullable)
outcomequery"success" | "denied" | "failed" (nullable)
sincequerystring (date-time) (nullable)
untilquerystring (date-time) (nullable)
limitqueryinteger (nullable)
cursorquerystring (nullable)

Responses

  • 200 OK (ActivityPage)
  • 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 ActivityPage
FieldTypeDescription
itemsarray of ActivityEventOut
next_cursorstring (nullable)

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

List Alerts (listAlerts)

IAM action: activity:ListAlerts

ParameterInTypeDescription
organization_id requiredpathstring

Responses

  • 200 OK (AlertsOut)
  • 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 AlertsOut
FieldTypeDescription
itemsarray of AlertOut

GET/api/v1/orgs/{organization_id}/billing/spend

Get Spend (getSpend)

IAM action: billing:DescribeSpend

ParameterInTypeDescription
organization_id requiredpathstring
monthquerystring (nullable)

Responses

  • 200 OK (SpendOut)
  • 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 SpendOut
FieldTypeDescription
by_dayarray of SpendDayOut
by_meterarray of SpendMeterOut
by_projectarray of SpendProjectOut
by_resourcearray of SpendResourceOut
endstring (date-time)
monthstring
startstring (date-time)
total_microinteger

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

List Notifications (listNotifications)

IAM action: notifications:ListNotifications

ParameterInTypeDescription
organization_id requiredpathstring
unreadqueryboolean
limitqueryinteger (nullable)
cursorquerystring (nullable)

Responses

  • 200 OK (NotificationPage)
  • 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 NotificationPage
FieldTypeDescription
itemsarray of NotificationOut
next_cursorstring (nullable)

POST/api/v1/orgs/{organization_id}/notifications/read

Mark All Read (markAllRead)

IAM action: notifications:MarkNotificationsRead

ParameterInTypeDescription
organization_id requiredpathstring

Responses

  • 200 OK (MarkedOut)
  • 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 MarkedOut
FieldTypeDescription
markedinteger

GET/api/v1/orgs/{organization_id}/notifications/summary

Notifications Summary (notificationsSummary)

IAM action: notifications:ListNotifications

ParameterInTypeDescription
organization_id requiredpathstring

Responses

  • 200 OK (NotificationSummaryOut)
  • 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 NotificationSummaryOut
FieldTypeDescription
latest_atstring (date-time) (nullable)
unreadinteger

POST/api/v1/orgs/{organization_id}/notifications/{notification_id}/read

Mark Notification Read (markNotificationRead)

IAM action: notifications:MarkNotificationsRead

ParameterInTypeDescription
organization_id requiredpathstring
notification_id requiredpathstring

Responses

  • 200 OK (MarkedOut)
  • 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 MarkedOut
FieldTypeDescription
markedinteger