How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

FusionAuth System API

The System API from FusionAuth — 11 operation(s) for system.

FusionAuth System API is one of 37 APIs that FusionAuth publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include System. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 11 operations across 11 paths, and defines 37 schemas. It is described by OpenAPI 3.2.0, at version 1.66.0.

Requests are made against 2 base URLs: http://localhost:9011, https://sandbox.fusionauth.io.

11 operations 11 paths 37 schemas 5 GET6 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.66.0
Base URL
https://sandbox.fusionauth.io
Authentication
API Key, HTTP Bearer
License
Apache2
Resource Areas
1

Authentication & Security 2

FusionAuth System API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 11

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

System 11
POST
/api/system/audit-log
Creates an audit log with the message and user name (usually an email). Audit logs should be written anytime you make changes to the FusionAuth database. When using the FusionAuth App web interface,…
createAuditLogWithId body → 200default
POST
/api/system/audit-log/search
Searches the audit logs with the specified criteria and pagination.
searchAuditLogsWithId body → 200default
GET
/api/system/audit-log/{auditLogId}
Retrieves a single audit log for the given Id.
retrieveAuditLogWithId 1 param → 200default
POST
/api/system/event-log/search
Searches the event logs with the specified criteria and pagination.
searchEventLogsWithId body → 200default
GET
/api/system/event-log/{eventLogId}
Retrieves a single event log for the given Id.
retrieveEventLogWithId 1 param → 200default
POST
/api/system/login-record/search
Searches the login records with the specified criteria and pagination.
searchLoginRecordsWithId body → 200default
POST
/api/system/reindex
Requests Elasticsearch to delete and rebuild the index for FusionAuth users or entities. Be very careful when running this request as it will increase the CPU and I/O load on your database until the…
reindexWithId body → 200default
GET
/api/system/version
Retrieves the FusionAuth version string.
retrieveVersionWithId → 200default
GET
/api/system/webhook-attempt-log/{webhookAttemptLogId}
Retrieves a single webhook attempt log for the given Id.
retrieveWebhookAttemptLogWithId 1 param → 200default
POST
/api/system/webhook-event-log/search
Searches the webhook event logs with the specified criteria and pagination.
searchWebhookEventLogsWithId body → 200default
GET
/api/system/webhook-event-log/{webhookEventLogId}
Retrieves a single webhook event log for the given Id.
retrieveWebhookEventLogWithId 1 param → 200default

Schemas 37

The contract defines 37 schemas that model the data the API accepts and returns. The most detailed are WebhookEventLog (13 properties), AuditLogSearchCriteria (11 properties), AuditLog (9 properties), DisplayableRawLogin (8 properties). Each schema is shown below with its type and property counts.

EventLogSearchCriteria
object
Search criteria for the event log.
7 properties
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
VersionResponse
object
1 property
WebhookAttemptLog
object
A webhook call attempt log.
8 properties
WebhookAttemptLogResponse
object
Webhook attempt log response.
1 property
EventType
string
Models the event types that FusionAuth produces.
Location
object
Location information. Useful for IP addresses and other displayable data objects.
7 properties
WebhookEventLogSearchResponse
object
Webhook event log search response.
2 properties
WebhookEventLogSearchCriteria
object
Search criteria for the webhook event log.
8 properties
LoginRecordSearchResponse
object
A raw login record response
2 properties
AuditLogSearchRequest
object
1 property
WebhookAttemptResult
string
The possible states of an individual webhook attempt to a single endpoint.
EventLogSearchRequest
object
1 property
WebhookEventLogSearchRequest
object
Webhook event log search request.
1 property
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
EventRequest
object
Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
1 property
AuditLogSearchResponse
object
Audit log response.
2 properties
WebhookEventLog
object
13 properties
ReindexRequest
object
Reindex API request
1 property
WebhookEventLogResponse
object
Webhook event log response.
1 property
EventLogResponse
object
Event log response.
1 property
WebhookCallResponse
object
A webhook call response.
3 properties
EventInfo
object
Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
8 properties
EventLogSearchResponse
object
Event log response.
2 properties
EventLogType
string
Event Log Type
AuditLog
object
An audit log.
9 properties
WebhookEventResult
string
The possible result states of a webhook event. This tracks the success of the overall webhook transaction according to the {@link TransactionType} and configur…
AuditLogResponse
object
Audit log response.
1 property
LoginRecordSearchCriteria
object
7 properties
BaseEvent
object
Base class for all FusionAuth events.
5 properties
AuditLogRequest
object
2 properties
AuditLogSearchCriteria
object
11 properties
IdentityType
object
Model identity types provided by FusionAuth.
1 property
EventLog
object
Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc.
4 properties
LoginRecordSearchRequest
object
2 properties
Error
object
Defines an error.
3 properties
DisplayableRawLogin
object
A displayable raw login that includes application name and user loginId.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-system-api-openapi.yml Raw ↑

Other APIs FusionAuth publishes across the network.

FusionAuth Api Key API
FusionAuth Application API
FusionAuth Connector API
FusionAuth Consent API
FusionAuth Email API
FusionAuth Entity API
FusionAuth Form API
FusionAuth Group API
FusionAuth Health API
FusionAuth Identity API
FusionAuth Identity Provider API
FusionAuth Integration API
Where this information came from

This is an independent, third-party profile of FusionAuth System API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.