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

Clerk Config API

Operations for managing instance configuration. The config API provides a unified interface for reading and updating instance settings, including authentication methods, SSO connections, and other instance-level configuration options.

Clerk Config API is one of 104 APIs that Clerk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Config. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 4 operations across 2 paths, and defines 6 schemas. It is described by OpenAPI 3.2.0, at version BETA.

Requests are made against a single base URL, https://api.clerk.com/v1.

4 operations 2 paths 6 schemas 2 GET1 PATCH1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
BETA
Base URL
https://api.clerk.com/v1
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • platform_api_access_token — Platform API access token.

Paths & Operations 4

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

Config 4

Operations for managing instance configuration. The config API provides a unified interface for reading and updating instance settings, including authentication methods, SSO conne…

GET
/platform/applications/{applicationID}/instances/{envOrInsID}/config
Get Instance Config
PlatformGetConfig 3 params → 200400401403404
PATCH
/platform/applications/{applicationID}/instances/{envOrInsID}/config
Update Instance Config
PlatformPatchConfig 6 params body → 200400401402403404409422
PUT
/platform/applications/{applicationID}/instances/{envOrInsID}/config
Replace Instance Config
PlatformPutConfig 5 params body → 200400401402403404409422
GET
/platform/applications/{applicationID}/instances/{envOrInsID}/config/schema
Get Instance Config Schema
PlatformGetConfigSchema 3 params → 200400401403404

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are PlatformConfigPatchResponse (4 properties), PlatformConfigSchemaResponse (4 properties), ClerkError (4 properties), ClerkErrors (3 properties). Each schema is shown below with its type and property counts.

ClerkError
object
4 properties 3 required
PlatformConfigSchemaResponse
object
JSON Schema describing the available configuration options.
4 properties
ClerkErrors
object
3 properties 1 required
PlatformConfigResponse
object
Instance configuration response containing key-value pairs and metadata.
1 property
PlatformConfigPatchRequest
object
Configuration updates to apply. Keys should match config key names.
PlatformConfigPatchResponse
object
Configuration patch response containing the result of the operation.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

clerk-com-config-api-openapi.yml Raw ↑

Other APIs Clerk publishes across the network.

Clerk Account Portal API
Clerk Active Sessions API
Clerk Actor Tokens API
Clerk Agent Tasks API
Clerk Allow-list / Block-list API
Clerk API Keys API
Clerk Application Transfers API
Clerk Applications API
Clerk Backup Codes API
Clerk Beta Features API
Clerk Billing API
Clerk Checkouts API
Where this information came from

This is an independent, third-party profile of Clerk Config 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.