Clerk Platform Api — Config

naftiko: 1.0.0-alpha2
info:
  label: Clerk Platform Api — Config
  description: 'Clerk Config capability. 4 operations. Lead operation: Get Instance Config.'
  tags:
  - Clerk
  - Config
  created: '2026-05-22'
  modified: '2026-05-22'
binds:
- namespace: env
  keys:
    CLERK_PARTNER_KEY: CLERK_PARTNER_KEY
capability:
  consumes:
  - type: http
    namespace: clerk-platform-api-config
    baseUri: https://api.clerk.com/v1
    description: Clerk clerk-platform-api Config business capability.
    resources:
    - name: platform-applications-applicationid-instances-envorinsid-config
      path: /platform/applications/{applicationID}/instances/{envOrInsID}/config
      operations:
      - name: PlatformGetConfig
        method: GET
        description: Get Instance Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: envOrInsID
          in: path
          type: string
          description: 'Environment type (e.g., "development", "production") or instance ID.

            '
          required: true
        - name: keys
          in: query
          type: array
          description: Config keys to retrieve. If not specified, all keys are returned.
          required: false
      - name: PlatformPatchConfig
        method: PATCH
        description: Update Instance Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: envOrInsID
          in: path
          type: string
          description: 'Environment type (e.g., "development", "production") or instance ID.

            '
          required: true
        - name: dry_run
          in: query
          type: boolean
          description: If true, preview the changes without applying them.
          required: false
        - name: destructive
          in: query
          type: boolean
          description: If true, allow clearing config keys by setting them to null.
          required: false
        - name: keys
          in: query
          type: array
          description: Config keys to return in the response. If not specified, only updated keys are returned.
          required: false
        - name: If-Match
          in: header
          type: string
          description: Config version for optimistic concurrency control.
          required: false
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: PlatformPutConfig
        method: PUT
        description: Replace Instance Config
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: envOrInsID
          in: path
          type: string
          description: 'Environment type (e.g., "development", "production") or instance ID.

            '
          required: true
        - name: dry_run
          in: query
          type: boolean
          description: If true, preview the changes without applying them.
          required: false
        - name: destructive
          in: query
          type: boolean
          description: If true, allow clearing config keys by setting them to null.
          required: false
        - name: If-Match
          in: header
          type: string
          description: Config version for optimistic concurrency control.
          required: false
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: platform-applications-applicationid-instances-envorinsid-config-schema
      path: /platform/applications/{applicationID}/instances/{envOrInsID}/config/schema
      operations:
      - name: PlatformGetConfigSchema
        method: GET
        description: Get Instance Config Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: envOrInsID
          in: path
          type: string
          description: 'Environment type (e.g., "development", "production") or instance ID.

            '
          required: true
        - name: keys
          in: query
          type: array
          description: Config keys to retrieve schema for. If not specified, all keys are returned.
          required: false