Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

APIs.io Engineering Platform Audit Logs API

The Audit Logs API from APIs.io Engineering Platform — 4 operation(s) for audit logs.

This API exposes 4 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 2015-07-09.

Requests are made against 4 base URLs: http://apigateway.{region}.amazonaws.com, https://apigateway.{region}.amazonaws.com, http://apigateway.{region}.amazonaws.com.cn, https://apigateway.{region}.amazonaws.com.cn.

4 operations 4 paths 12 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2015-07-09
Base URL
https://{bucketname}.s3.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

APIs.io Engineering Platform Audit Logs API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Audit Logs 4
GET
/accounts/{account_id}/audit_logs
APIs.io Engineering Platform Get account audit logs
audit-logs-get-account-audit-logs 13 params → 4XX200
GET
/organizations/{organization_id}/audit_logsdeprecated
APIs.io Engineering Platform Get organization audit logs
audit-logs-get-organization-audit-logs 13 params → 4XX200
GET
/user/audit_logs
APIs.io Engineering Platform Get user audit logs
audit-logs-get-user-audit-logs 12 params → 4XX200
GET
/audit/logs
APIs.io Engineering Platform Get team audit logs
getAuditLogs 5 params → 200401500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are aaa_audit-logs (10 properties), aaa_api-response-common (3 properties), aaa_api-response-common-failure (3 properties), getAuditLogs (1 property). Each schema is shown below with its type and property counts.

ascDescDefaultDesc
string
getAuditLogs
object
1 property
aaa_audit_logs_response_collection
aaa_api-response-common
object
3 properties 3 required
aaa_identifier
string
Identifier
auditLogsLimitQuery
integer
untilDateQuery
string
aaa_api-response-common-failure
object
3 properties 3 required
cursor
string
sinceDateQuery
string
aaa_audit-logs
object
10 properties
aaa_messages
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

engineering-platform-audit-logs-api-openapi.yml Raw ↑