ZuploZuplo
LoginStart for Free
  • Documentation
  • API Reference
Information
Analytics
    Get recent requests for a given deployment in the last 24 hoursgetGet statistics on requests by status code for a given deploymentget
API Keys - Buckets
    Lists bucketsgetCreates a bucketpostGets a bucketgetDeletes a bucketdeleteUpdates a bucketpatch
API Keys - Consumers
    Lists consumersgetCreates a consumerpostGets a consumergetDeletes a consumerdeleteUpdates a consumerpatchRoll consumer keyspost
API Keys - Keys
    Lists keysgetCreates an API keypostCreates multiple API keyspostGets an API keygetDeletes an API keydeleteUpdates an API keypatch
API Keys - Managers
    Lists managersgetCreates a managerpostDeletes a managerdelete
Audit Logs
    Query audit logsgetQuery audit log eventsgetAggregated audit log statsget
Build Logs
    Get build logsget
Client mTLS CA Certificates
    List Client mTLS CA CertificatesgetCreate Client mTLS CA CertificatepostDelete Client mTLS CA CertificatedeleteUpdate Client mTLS CA Certificatepatch
Custom Domains
    Get Custom DomainsgetCreate Custom DomainpostDelete a Custom DomaindeleteUpdate a Custom Domainpatch
Deployments
    Gets a deployment statusgetLists deploymentsgetUpload deployment sourcepostGet a deploymentgetDeletes a deploymentdeleteRe-deploy a deploymentpost
Environments
    Query environmentsgetGet an environmentget
MCP Servers
    API MCP ServerpostDocs MCP Serverpost
Metering - Features
    List featuresgetCreate featurepostGet featuregetDelete featuredelete
Metering - Meters
    List metersgetCreate meterpostGet metergetUpdate meterputDelete meterdeleteList meter group by valuesgetQuery metergetQuery meterpost
Metering - Plans
    List plansgetCreate a planpostGet plangetUpdate a planputDelete plandeleteArchive plan versionpostPublish planpost
Projects
    Create projectpost
Runtime Logs
    List request logsgetGet request log detailget
Tunnel Services
    Gets a provisioning statusgetGets a service configurationgetConfigures tunnel servicesput
Tunnels
    Lists tunnelsgetCreates a tunnelpostGets a tunnelgetDeletes a tunneldeleteRotates the tokenpostGets a teardown statusget
Variables
    Creates a variablepostUpdates a variablepatch
Other endpoints
    OpenAPI SpecificationgetLists accountsgetLists projectsgetWho Am Iget
Schemas
powered by Zudoku
Zuplo Developer API
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

Query audit log events

GET
https://dev.zuplo.com
/v1/audit-logs/{bucketId}/events

Search audit log events for a bucket. Supports filtering by event type, actor, subject, and time range.

Query audit log events › path Parameters

bucketId
​string · required

Bucket id or bucket name.

Query audit log events › 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
type
​string

Filter by event type (reverse-DNS, e.g. 'com.zuplo.apikey.create')

actorSub
​string

Filter by actor subject identifier

subject
​string

Filter by event subject

startDate
​string · date-time

Filter events at or after this time (ISO 8601)

endDate
​string · date-time

Filter events at or before this time (ISO 8601)

Query audit log events › Responses

The request has succeeded.

Audit log events response
Zuplo.AuditLogsV1.AuditLogsEventsResponse
​Zuplo.AuditLogsV1.AuditLogEvent[] · required
​Zuplo.AuditLogsV1.AuditLogsPagination · required

Pagination for audit log events

GET/v1/audit-logs/{bucketId}/events
curl https://dev.zuplo.com/v1/audit-logs/:bucketId/events
Example Responses
{ "data": [ { "specversion": "specversion", "id": "id", "source": "source", "type": "type", "time": "2024-08-25T15:00:00Z", "datacontenttype": "datacontenttype", "subject": "subject", "bucketid": "bucketid", "actorsub": "actorsub", "actortype": "actortype", "actoremail": "actoremail", "actorconnection": "actorconnection", "resources": [ { "type": "type", "id": "id" } ], "requestid": "requestid", "success": true, "httpmethod": "httpmethod", "httpurl": "httpurl", "httpstatus": 0, "ipaddress": "ipaddress", "useragent": "useragent", "country": "country", "region": "region", "city": "city", "data": { "key": {} }, "extensions": { "key": {} } } ], "pagination": { "limit": 0, "offset": 0, "total": 0, "hasMore": true } }
json
application/json

Aggregated audit log stats

GET
https://dev.zuplo.com
/v1/audit-logs/{bucketId}/stats

Returns top-N event counts grouped by event type or actor sub.

Aggregated audit log stats › path Parameters

bucketId
​string · required

Bucket id or bucket name.

Aggregated audit log stats › query Parameters

groupBy
​string · required

Column to group by: type | actorSub

limit
​integer · int32 · min: 1 · max: 100

Maximum number of groups to return (1-100)

Default: 25
startDate
​string · date-time

Filter events at or after this time (ISO 8601)

endDate
​string · date-time

Filter events at or before this time (ISO 8601)

Aggregated audit log stats › Responses

The request has succeeded.

Audit log stats response
Zuplo.AuditLogsV1.AuditLogsStatsResponse
groupBy
​string · required

Column that was grouped by

​Zuplo.AuditLogsV1.AuditLogsStatsEntry[] · required
GET/v1/audit-logs/{bucketId}/stats
curl 'https://dev.zuplo.com/v1/audit-logs/:bucketId/stats?groupBy=<string>'
Example Responses
{ "groupBy": "groupBy", "data": [ { "key": "key", "count": 0 } ] }
json
application/json

API Keys - ManagersBuild Logs