AuditLogs API

v1.0 • REST • JSON

Full CRUD management for auditlog accounts. Create, retrieve, update, and delete auditlog records with built-in pagination and role-based access control support.

GET POST PUT DELETE 5 Endpoints
Base URL https://bogusapi.com/api/auditlogs

Quick Reference

GET
/api/auditlogs List all auditlogs (paginated)
200 GET
/api/auditlogs/{id} Get one auditlog by ID
200 POST
/api/auditlogs Create a new auditlog
201 PUT
/api/auditlogs/{id} Replace auditlog data
204 DEL
/api/auditlogs/{id} Remove a auditlog
204 GET
/api/auditlogs/{id} AuditLog not found example
404
GET /api/auditlogs 200 OK

Get All AuditLogs

Retrieves a paginated list of all auditlogs in the system. Use the page and limit query parameters to navigate large result sets. The response envelope includes total count and page metadata.

Query Parameters
ParameterTypeDefaultDescription
page integer 1 Page number, 1-based index
limit integer 10 Number of records per page
Response: 200 OK
GET /api/auditlogs/{id} 200 OK

Get Single AuditLog

Fetch the full profile for a specific auditlog using their numeric ID. Returns all auditlog fields including assigned role names and account metadata.

Path Parameters
ParameterTypeRequiredDescription
id integer Required Unique auditlog identifier
Response: 200 OK
GET /api/auditlogs/{id} 404 Not Found

AuditLog Not Found

Returned when the requested auditlog ID does not exist in the system. Use this example to test error-handling logic and build graceful fallback UI for missing auditlog resources.

Response: 404 Not Found
POST /api/auditlogs 201 Created

Create AuditLog

Registers a new auditlog with the provided details. On success, returns the newly created auditlog object including the auto-generated ID, timestamp, and resolved role names.

Request Body
Field Type Required Description
entityName string Required Entity name
entityId integer Optional Entity id
action string Required Action
performedBy string Required Performed by
details string Required Details
createdAt datetime Optional Created at
Body
Response: 201 Created
PUT /api/auditlogs/{id} 200 OK

Update AuditLog

Fully replaces an existing auditlog's data with the values in the request body. A successful update returns 200 OK with response body.

Request Body
Field Type Required Description
entityName string Required Entity name
entityId integer Optional Entity id
action string Required Action
performedBy string Required Performed by
details string Required Details
createdAt datetime Optional Created at
Body
Response: 200 OK
DELETE /api/auditlogs/{id} 204 No Content

Delete AuditLog

Permanently removes a auditlog from the system by their ID. This action is irreversible once deleted, the auditlog record and all associated data cannot be recovered through the API.

Path Parameters
ParameterTypeRequiredDescription
id integer Required ID of the auditlog to delete
Response: 204 No Content