Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

fauna Schema API

Fetch, update, validate, and manage a database's schema as FSL files. Supports staged schema changes with status checking, committing, and abandoning.

fauna Schema API is one of 9 APIs that fauna publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 7 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 1.

Requests are made against a single base URL, https://db.fauna.com.

7 operations 7 paths 11 schemas 2 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1
Base URL
https://db.fauna.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

fauna Schema API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Fauna authentication secret passed as a bearer token. Secrets can be keys, tokens, or JWTs from third-party identity providers.

Paths & Operations 7

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

Schema 7

Fetch, update, validate, and manage a database's schema as FSL files. Supports staged schema changes with status checking, committing, and abandoning.

GET
/schema/1/files
Get schema files
getSchemaFiles 2 params → 200401403
POST
/schema/1/update
Update schema files
updateSchemaFiles 2 params body → 200400401403409
POST
/schema/1/validate
Validate schema files
validateSchemaFiles 2 params body → 200400401
GET
/schema/1/status
Get staged schema status
getStagedSchemaStatus 1 param → 200401403
POST
/schema/1/staged/commit
Commit staged schema
commitStagedSchema 1 param → 200400401
POST
/schema/1/staged/abandon
Abandon staged schema
abandonStagedSchema 1 param → 200401
POST
/import
Import a GraphQL schema
importGraphQLSchema 1 param body → 200400401

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are QueryStats (8 properties), ErrorResponse (5 properties), GraphQLError (4 properties), SchemaValidationResponse (3 properties). Each schema is shown below with its type and property counts.

SchemaFile
object
2 properties
GraphQLErrorResponse
object
1 property
SchemaAbandonResponse
object
1 property
GraphQLError
object
4 properties
ErrorResponse
object
5 properties
SchemaCommitResponse
object
1 property
SchemaFilesResponse
object
2 properties
SchemaValidationResponse
object
3 properties
SchemaUpdateResponse
object
2 properties
SchemaStatusResponse
object
3 properties
QueryStats
object
Operational statistics for the query execution.
8 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

fauna-schema-api-openapi.yml Raw ↑

Other APIs fauna publishes across the network.

Fauna Event Streaming API
Fauna Event Feeds API
Fauna GraphQL API
Fauna JavaScript Driver
Fauna Python Driver
Fauna .NET Driver
fauna EventFeeds API
fauna Query API