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 Key API

The Key API from FusionAuth — 7 operation(s) for key.

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

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

This API exposes 9 operations across 7 paths, and defines 12 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.

9 operations 7 paths 12 schemas 1 DELETE2 GET5 POST1 PUT

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 Key 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 9

Across 7 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Key 9
GET
/api/key
Retrieves all the keys.
retrieveKeysWithId → 200default
POST
/api/key/generate
Generate a new RSA or EC key pair or an HMAC secret.
generateKey body → 200default
POST
/api/key/generate/{keyId}
Generate a new RSA or EC key pair or an HMAC secret.
generateKeyWithId 1 param body → 200default
POST
/api/key/import
Import an existing RSA or EC key pair or an HMAC secret.
importKey body → 200default
POST
/api/key/import/{keyId}
Import an existing RSA or EC key pair or an HMAC secret.
importKeyWithId 1 param body → 200default
POST
/api/key/search
Searches keys with the specified criteria and pagination.
searchKeysWithId body → 200default
DELETE
/api/key/{keyId}
Deletes the key for the given Id.
deleteKeyWithId 1 param → 200default
GET
/api/key/{keyId}
Retrieves the key for the given Id.
retrieveKeyWithId 1 param → 200default
PUT
/api/key/{keyId}
Updates the key with the given Id.
updateKeyWithId 1 param body → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Key (16 properties), CertificateInformation (10 properties), KeySearchCriteria (6 properties), Error (3 properties). Each schema is shown below with its type and property counts.

KeyRequest
object
Key API request object.
1 property
KeyType
string
Errors
object
Standard error domain object that can also be used as the response from an API call.
2 properties
Error
object
Defines an error.
3 properties
ZonedDateTime
integer
The number of milliseconds since the unix epoch: January 1, 1970 00:00:00 UTC. This value is always in UTC.
KeyAlgorithm
string
KeySearchRequest
object
Search request for Keys
1 property
KeySearchCriteria
object
Search criteria for Keys
6 properties
CertificateInformation
object
10 properties
KeySearchResponse
object
Key search response
2 properties
KeyResponse
object
Key API response object.
2 properties
Key
object
Domain for a public key, key pair or an HMAC secret. This is used by KeyMaster to manage keys for JWTs, SAML, etc.
16 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fusionauth-key-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 Key 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.