Audit Logs

Query audit logs

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/audit-logs

Retrieves audit logs with optional filtering and pagination.

Query audit logs › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Query audit logs › query Parameters

limit

integer · int32 · min: 1 · max: 100

Maximum number of results to return (1-100)

Default: 20

offset

integer · int32 · min: 0

Number of results to skip for pagination

Default: 0

action

string

Filter by specific action (e.g., 'account.create')

startDate

string · date-time

Filter events after this date (ISO 8601 format)

endDate

string · date-time

Filter events before this date (ISO 8601 format)

actor

string

Filter by actor email address or subject identifier

success

boolean

Filter by success status (true for successful, false for failed)

Query audit logs › Responses

The request has succeeded.

Response containing a list of audit logs with pagination

Zuplo.AuditLogs.AuditLogsResponse

Zuplo.AuditLogs.AuditLog[] · required

Array of audit log entries

object · required

Pagination information

GET/v1/accounts/{accountName}/audit-logs

curl https://dev.zuplo.com/v1/accounts/:accountName/audit-logs

Example Responses

{
  "data": [
    {
      "action": "action",
      "metadata": {
        "key": {}
      },
      "actor": {
        "sub": "sub",
        "email": "email",
        "type": "type",
        "connection": "connection",
        "actingAs": {
          "sub": "sub",
          "email": "email"
        },
        "metadata": {
          "key": {}
        }
      },
      "resources": [
        {
          "type": "type",
          "id": "id",
          "metadata": {
            "key": {}
          }
        }
      ],
      "context": {
        "ipAddress": "ipAddress",
        "userAgent": "userAgent",
        "country": "country",
        "region": "region",
        "city": "city",
        "postalCode": "postalCode",
        "metroCode": "metroCode",
        "asOrg": "asOrg"
      },
      "route": {
        "source": "source",
        "url": "url",
        "method": "method"
      },
      "timestamp": "2024-08-25T15:00:00Z",
      "requestId": "requestId",
      "success": true,
      "error": "error"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "hasMore": true
  }
}

json

application/json

API Keys - Managers Build Logs

Zuplo Developer API

Audit Logs

Query audit logs

GET

https://dev.zuplo.com

/v1/accounts/{accountName}/audit-logs

Retrieves audit logs with optional filtering and pagination.

Query audit logs › path Parameters

accountName

string · required

The name of the account. You can find this in your Zuplo Portal under Settings > Project Information.

Query audit logs › query Parameters

limit

integer · int32 · min: 1 · max: 100

Maximum number of results to return (1-100)

Default: 20

offset

integer · int32 · min: 0

Number of results to skip for pagination

Default: 0

action

string

Filter by specific action (e.g., 'account.create')

startDate

string · date-time

Filter events after this date (ISO 8601 format)

endDate

string · date-time

Filter events before this date (ISO 8601 format)

actor

string

Filter by actor email address or subject identifier

success

boolean

Filter by success status (true for successful, false for failed)

Query audit logs › Responses

The request has succeeded.

Response containing a list of audit logs with pagination

Zuplo.AuditLogs.AuditLogsResponse

Zuplo.AuditLogs.AuditLog[] · required

Array of audit log entries

object · required

Pagination information

GET/v1/accounts/{accountName}/audit-logs

curl https://dev.zuplo.com/v1/accounts/:accountName/audit-logs

Example Responses

{
  "data": [
    {
      "action": "action",
      "metadata": {
        "key": {}
      },
      "actor": {
        "sub": "sub",
        "email": "email",
        "type": "type",
        "connection": "connection",
        "actingAs": {
          "sub": "sub",
          "email": "email"
        },
        "metadata": {
          "key": {}
        }
      },
      "resources": [
        {
          "type": "type",
          "id": "id",
          "metadata": {
            "key": {}
          }
        }
      ],
      "context": {
        "ipAddress": "ipAddress",
        "userAgent": "userAgent",
        "country": "country",
        "region": "region",
        "city": "city",
        "postalCode": "postalCode",
        "metroCode": "metroCode",
        "asOrg": "asOrg"
      },
      "route": {
        "source": "source",
        "url": "url",
        "method": "method"
      },
      "timestamp": "2024-08-25T15:00:00Z",
      "requestId": "requestId",
      "success": true,
      "error": "error"
    }
  ],
  "pagination": {
    "limit": 0,
    "offset": 0,
    "total": 0,
    "hasMore": true
  }
}

json

application/json

API Keys - Managers Build Logs