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

Insforge Configuration API

Manage realtime retention settings.

Insforge Configuration API is one of 11 APIs that Insforge publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against the base URL https://api.insforge.dev.

2 operations 1 paths 3 schemas 1 GET1 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.insforge.dev
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Insforge Configuration API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth).

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PATCH. Each is listed below with its method, path, parameters, and response codes.

Configuration 2

Manage realtime retention settings.

GET
/api/realtime/config
Get Realtime Config
→ 200
PATCH
/api/realtime/config
Update Realtime Config
body → 200400

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (4 properties), UpdateRealtimeConfigRequest (1 property), RealtimeConfig (1 property). Each schema is shown below with its type and property counts.

RealtimeConfig
object
1 property 1 required
UpdateRealtimeConfigRequest
object
1 property 1 required
ErrorResponse
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

insforge-configuration-api-openapi.yml Raw ↑

Other APIs Insforge publishes across the network.

Insforge Admin API
Insforge Channels API
Insforge Client API
Insforge Messages API
Insforge Payment Webhooks API
Insforge Permissions API
Insforge Razorpay Payments API
Insforge S3 Access Keys API
Insforge S3 Protocol API
Insforge Stripe Payments API