FusionAuth

FusionAuth System Configuration API

The System Configuration API from FusionAuth — 1 operation(s) for system configuration.

Documentation GitHub OpenAPI

Operations 2

PATCH /api/system-configuration Patch system configuration with id #

PUT /api/system-configuration Update system configuration with id #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/fusionauth:fusionauth-system-configuration-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  version: 1.66.0
  title: FusionAuth System Configuration API
  description: This is a FusionAuth server. Find out more at https://fusionauth.io. You need to set up an API key in the FusionAuth instance you are using to test out the API calls.
  license:
    name: Apache2
servers:
- url: http://localhost:9011
- url: https://sandbox.fusionauth.io
security:
- ApiKeyAuth: []
tags:
- name: System Configuration
paths:
  /api/system-configuration:
    patch:
      description: Updates, via PATCH, the system configuration.
      operationId: patchSystemConfigurationWithId
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemConfigurationRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemConfigurationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - System Configuration
      summary: Patch system configuration with id
      x-summary-source: derived
    put:
      description: Updates the system configuration.
      operationId: updateSystemConfigurationWithId
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SystemConfigurationRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemConfigurationResponse'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Errors'
      tags:
      - System Configuration
      summary: Update system configuration with id
      x-summary-source: derived
components:
  schemas:
    Errors:
      description: Standard error domain object that can also be used as the response from an API call.
      type: object
      properties:
        fieldErrors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        generalErrors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
    SystemTrustedProxyConfigurationPolicy:
      description: ''
      type: string
      enum:
      - All
      - OnlyConfigured
    EventLogConfiguration:
      type: object
      properties:
        numberToRetain:
          type: integer
    AuditLogConfiguration:
      type: object
      properties:
        delete:
          $ref: '#/components/schemas/DeleteConfiguration'
    CORSConfiguration:
      description: ''
      type: object
      properties:
        allowCredentials:
          type: boolean
        allowedHeaders:
          type: array
          items:
            type: string
        allowedMethods:
          type: array
          items:
            $ref: '#/components/schemas/HTTPMethod'
        allowedOrigins:
          type: array
          items:
            type: string
            format: URI
        debug:
          type: boolean
        exposedHeaders:
          type: array
          items:
            type: string
        preflightMaxAgeInSeconds:
          type: integer
        enabled:
          type: boolean
    UIConfiguration:
      type: object
      properties:
        headerColor:
          type: string
        logoURL:
          type: string
        menuFontColor:
          type: string
    SystemConfigurationRequest:
      description: Request for the system configuration API.
      type: object
      properties:
        systemConfiguration:
          $ref: '#/components/schemas/SystemConfiguration'
    ZonedDateTime:
      description: 'The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.'
      example: '1659380719000'
      type: integer
      format: int64
    SystemConfigurationResponse:
      description: Response for the system configuration API.
      type: object
      properties:
        systemConfiguration:
          $ref: '#/components/schemas/SystemConfiguration'
    SystemTrustedProxyConfiguration:
      description: ''
      type: object
      properties:
        trustPolicy:
          $ref: '#/components/schemas/SystemTrustedProxyConfigurationPolicy'
        trusted:
          type: array
          items:
            type: string
    ZoneId:
      description: Timezone Identifier
      example: America/Denver
      pattern: ^w+/w+$
      type: string
    UsageDataConfiguration:
      description: Config for Usage Data  Stats
      type: object
      properties:
        numberOfDaysToRetain:
          type: integer
        enabled:
          type: boolean
    SystemConfiguration:
      description: ''
      type: object
      properties:
        auditLogConfiguration:
          $ref: '#/components/schemas/AuditLogConfiguration'
        corsConfiguration:
          $ref: '#/components/schemas/CORSConfiguration'
        data:
          type: object
          additionalProperties:
            type: object
        eventLogConfiguration:
          $ref: '#/components/schemas/EventLogConfiguration'
        insertInstant:
          $ref: '#/components/schemas/ZonedDateTime'
        lastUpdateInstant:
          $ref: '#/components/schemas/ZonedDateTime'
        loginRecordConfiguration:
          $ref: '#/components/schemas/LoginRecordConfiguration'
        reportTimezone:
          $ref: '#/components/schemas/ZoneId'
        trustedProxyConfiguration:
          $ref: '#/components/schemas/SystemTrustedProxyConfiguration'
        uiConfiguration:
          $ref: '#/components/schemas/UIConfiguration'
        usageDataConfiguration:
          $ref: '#/components/schemas/UsageDataConfiguration'
        webhookEventLogConfiguration:
          $ref: '#/components/schemas/WebhookEventLogConfiguration'
    LoginRecordConfiguration:
      type: object
      properties:
        delete:
          $ref: '#/components/schemas/DeleteConfiguration'
    HTTPMethod:
      description: ''
      type: string
      enum:
      - GET
      - POST
      - PUT
      - DELETE
      - HEAD
      - OPTIONS
      - PATCH
    Error:
      description: Defines an error.
      type: object
      properties:
        code:
          type: string
        data:
          type: object
          additionalProperties:
            type: object
        message:
          type: string
    DeleteConfiguration:
      type: object
      properties:
        numberOfDaysToRetain:
          type: integer
        enabled:
          type: boolean
    WebhookEventLogConfiguration:
      description: The system configuration for Webhook Event Log data.
      type: object
      properties:
        delete:
          $ref: '#/components/schemas/DeleteConfiguration'
        enabled:
          type: boolean
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-provenance:
  method: harvested
  publisher: FusionAuth
  source: https://raw.githubusercontent.com/fusionauth/fusionauth-openapi/HEAD/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)