Clerk Platform Api — Domains

naftiko: 1.0.0-alpha2
info:
  label: Clerk Platform Api — Domains
  description: 'Clerk Domains capability. 9 operations. Lead operation: Update Application Domain.'
  tags:
  - Clerk
  - Domains
  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-domains
    baseUri: https://api.clerk.com/v1
    description: Clerk clerk-platform-api Domains business capability.
    resources:
    - name: platform-applications-applicationid-domain
      path: /platform/applications/{applicationID}/domain
      operations:
      - name: PlatformUpdateApplicationDomain
        method: PATCH
        description: Update Application Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: platform-applications-applicationid-domains
      path: /platform/applications/{applicationID}/domains
      operations:
      - name: PlatformListApplicationDomains
        method: GET
        description: List Application Domains
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
      - name: PlatformCreateApplicationDomain
        method: POST
        description: Create Application Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: platform-applications-applicationid-domains-domainidorname
      path: /platform/applications/{applicationID}/domains/{domainIDOrName}
      operations:
      - name: PlatformGetApplicationDomain
        method: GET
        description: Get Application Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: domainIDOrName
          in: path
          type: string
          description: Domain ID or domain name.
          required: true
      - name: PlatformDeleteApplicationDomain
        method: DELETE
        description: Delete Application Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: domainIDOrName
          in: path
          type: string
          description: Domain ID or domain name.
          required: true
    - name: platform-applications-applicationid-domains-domainidorname-status
      path: /platform/applications/{applicationID}/domains/{domainIDOrName}/status
      operations:
      - name: PlatformGetApplicationDomainStatus
        method: GET
        description: Get Application Domain Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: domainIDOrName
          in: path
          type: string
          description: Domain ID or domain name.
          required: true
    - name: platform-applications-applicationid-domains-domainidorname-dns-check
      path: /platform/applications/{applicationID}/domains/{domainIDOrName}/dns_check
      operations:
      - name: PlatformTriggerDNSCheck
        method: POST
        description: Trigger DNS Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: applicationID
          in: path
          type: string
          description: Application ID.
          required: true
        - name: domainIDOrName
          in: path
          type: string
          description: Domain ID or domain name.
          required: true
    - name: platform-domains
      path: /platform/domains
      operations:
      - name: PlatformListDomains
        method: GET
        description: List Domains
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: name
          in: query
          type: string
          description: Filter domains whose name contains this substring (case-insensitive).
          required: false
        - name: include_development
          in: query
          type: string
          description: When `true`, include development instance domains. Defaults to production only.
          required: false
        - name: limit
          in: query
          type: integer
          description: Number of results to return per page (1-500, default 10).
          required: false
        - name: starting_after
          in: query
          type: string
          description: 'Cursor for pagination. Provide the ID of the last domain from the

            previous page to get the next page of results.

            '
          required: false
        - name: ending_before
          in: query
          type: string
          description: 'Cursor for pagination. Provide the ID of the first domain from the

            previous page to get the previous page of results.

            '
          required: false
    - name: platform-domains-domainidorname
      path: /platform/domains/{domainIDOrName}
      operations:
      - name: PlatformGetDomain
        method: GET
        description: Get Domain
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: domainIDOrName
          in: path
          type: string
          description: Domain ID or domain name.
          required: true