Search the organization's Trails, newest first

Without from, the last 7 days. Unknown parameters are 400. A search that reads too much is 400 lookup_too_broad: narrow the window or add filters.

GET

https://audit.ezghcloud.com/v1/organizations/{orgId}/events

View as Markdown

Authorization

apiKeyoptionalHTTP
oauthoptionalHTTP
sessionCookieoptionalAPI key in cookie

Path parameters

orgIdstringrequired
The organization.

format: uuid

Query parameters

fromoptionalstring
Inclusive, RFC 3339. Default: 7 days ago.

format: date-time
tooptionalstring
Exclusive, RFC 3339.

format: date-time
eventSourceoptionalstring
widgets.ezghcloud.com
eventNameoptionalstring
CreateWidget
eventTypeoptionalstring
ApiCall, ServiceEvent or SignIn.
principalIdoptionalstring
accessKeyIdoptionalstring
resourceNameoptionalstring
Events that touched this resource.
errorCodeoptionalstring
readOnlyoptionalboolean
hasErroroptionalboolean
projectIdoptionalstring
format: uuid
limitoptionalinteger
Default 20.

format: int32, maximum: 100, minimum: 1
cursoroptionalstring
The previous page's nextCursor, for the same filters.

Returns

200

A page of events.

JSON

eventsarray ofobjectrequired
21 properties
- eventCategorystringrequired
- eventIdstringrequired
  format: uuid
- eventNamestringrequired
  The operation: CreateWidget, LookupEvents.
- eventSourcestringrequired
  <namespace>.ezghcloud.com.
- eventTimestringrequired
  format: date-time
- eventTypestringrequired
  ApiCall, ServiceEvent or SignIn.
- eventVersionstringrequired
  "1.0".
- organizationIdstringrequired
  format: uuid
- readOnlybooleanrequired
- regionstringrequired
- resourcesarray ofobjectrequired
  2 properties
  resourceNamestringrequired
  typestringrequired
  Organization, Project, Widget…
- userIdentityobjectrequired
  Who made the call.
  
  7 properties
  isRootbooleanrequired
  accessKeyIdoptionalstring | null
  invokedByoptionalstring | null
  A service event's cause: the public namespace that made the change.
  
  principalIdoptionalstring | null
  sessionContextoptionalSessionContextornull
  2 variants
  One of the following:
  SessionContext
  View SessionContext schema →
  5 properties
  mfaAuthenticatedbooleanrequired
  clientIdoptionalstring | null
  The OAuth client, for oauth.
  
  credentialoptionalstring | null
  session, apiKey or oauth.
  
  sessionIssuedAtoptionalstring | null
  ssoProviderIdoptionalstring | null
  null
  typeoptionalstring | null
  User, Bot, Root or EzghService.
  
  userNameoptionalstring | null
- additionalEventDataoptionalobject | null
- errorCodeoptionalstring | null
- errorMessageoptionalstring | null
- projectIdoptionalstring | null
- requestIdoptionalstring | null
- requestParametersoptionalobject | null
  Path and query parameters and the body's top-level fields, secrets hidden.
- responseElementsoptionalobject | null
  A successful write's identifiers.
- sourceIpAddressoptionalstring | null
- userAgentoptionalstring | null
nextCursoroptionalstring | null

400

invalid_request, invalid_cursor, invalid_query (with line and column), or lookup_too_broad.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.

401

unauthenticated: no credential, or one that doesn't check out.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.

403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.

404

not_found: unknown, malformed, or in an organization the caller isn't in.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.

429

too_many_requests or too_many_queries, with Retry-After; or quota_exceeded (with quota), never with Retry-After.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.

500

internal_error: a bug; the details are in the logs, under the request ID.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.

503

unavailable: a dependency the request needs is down. Retry after Retry-After.

JSON

errorobjectrequired
6 properties
- codestringrequired
  maxLength: 64, pattern: ^[a-z][a-z0-9_]*$
- messagestringrequired
  maxLength: 1024
- columnoptionalinteger
  invalid_query: where the SQL went wrong.
- lineoptionalinteger
  invalid_query: where the SQL went wrong.
- quotaoptionalobject
  quota_exceeded: the quota that refused the request. Trails Query's are audit.queries.queriesPerHour and audit.queries.bytesReadPerHour, rate quotas with a PT1H window. Never with Retry-After.
  
  11 properties
  idstringrequired
  kindallocationorrateorusageorconcurrencyrequired
  limitintegerrequired
  minimum: 0
  scopeorganizationorprojectorresourcerequired
  inFlightoptionalinteger
  minimum: 0
  periodStartoptionalstring
  format: date-time
  regionoptionalstring
  resetsAtoptionalstring
  format: date-time
  scopeResourceNameoptionalstring
  usedoptionalinteger
  minimum: 0
  windowoptionalstring
  rate only: an ISO 8601 duration, PT1S to PT1H.
- reasonoptionalstring
  query_failed: the query's own error code.