Skip to content
Workshape Catalyst Operator Docs

Governance

List the latest audit activities

Section titled “List the latest audit activities”

GET /api/v1/instance/audit-activities

Operation
audit_activities.list
Accepts
sessionCookie, sessionToken
Scope
governance:read
Rights
audit.view
Effect
reading
Rate class
read

Answers

  • 200 The result

    application/json: object

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

List the latest audit events

Section titled “List the latest audit events”

GET /api/v1/instance/audit-events

Operation
audit_events.list
Accepts
sessionCookie, sessionToken
Scope
governance:read
Rights
audit.view
Effect
reading
Rate class
read

Parameters

  • limit integer in query, optional, default 50, minimum 1, maximum 200
  • cursor string in query, optional, minLength 1

Answers

  • 200 One page of the list

    application/json: object

    • items array of AuditEvent required
    • nextCursor string optional
  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.

Read model usage and budget of the instance

Section titled “Read model usage and budget of the instance”

GET /api/v1/instance/usage

Operation
usage.get_summary
Accepts
sessionCookie, sessionToken
Scope
governance:read
Rights
usage.view
Effect
reading
Rate class
read

Answers

  • 200 The result

    application/json: UsageSummary

  • 400 BAD_REQUEST: The request cannot be read.
  • 401 UNAUTHENTICATED: No credential was presented, or the credential is not valid.
  • 403 FORBIDDEN: The caller lacks the scope or the right this operation requires.
  • 422 VALIDATION_FAILED: Path, query or body do not match the operation's schema.
  • 429 RATE_LIMITED: The caller sent too many requests of this operation's rate class. details.retryAfterSeconds and the Retry-After header give the seconds to wait. The numbers are the instance's, set under rateLimits in its release config.
  • 500 INTERNAL: The instance failed. The message never carries details.