Convex Custom Domains API

openapi: 3.2.0
info:
  title: Convex Management Custom Domains API
  description: Management API for provisioning and managing Convex projects and deployments.
  license:
    name: LicenseRef-Convex
    identifier: LicenseRef-Convex
  version: 1.0.0
servers:
- url: https://api.convex.dev/v1
  description: Platform API
tags:
- name: Custom Domains
  description: Create, list, and delete custom domains
paths:
  /deployments/{deployment_name}/create_custom_domain:
    post:
      tags:
      - Custom Domains
      summary: Create custom domain
      operationId: createCustomDomain
      parameters:
      - name: deployment_name
        in: path
        description: Deployment name
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformDeleteCustomDomainArgs'
        required: true
      responses:
        '200':
          description: ''
      security:
      - PAT: []
      - OAuth Team Token: []
      - Team Token: []
      - OAuth Project Token: []
      x-operation-id-source: normalized
      x-operation-id-original: create custom domain
  /deployments/{deployment_name}/delete_custom_domain:
    post:
      tags:
      - Custom Domains
      summary: Delete custom domain
      description: Remove a custom domain from a deployment.
      operationId: deleteCustomDomain
      parameters:
      - name: deployment_name
        in: path
        description: Deployment name
        required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlatformDeleteCustomDomainArgs'
        required: true
      responses:
        '200':
          description: ''
      security:
      - PAT: []
      - OAuth Team Token: []
      - Team Token: []
      - OAuth Project Token: []
      x-operation-id-source: normalized
      x-operation-id-original: delete custom domain
  /deployments/{deployment_name}/custom_domains:
    get:
      tags:
      - Custom Domains
      summary: List custom domains
      description: Get all custom domains configured for a deployment.
      operationId: listCustomDomains
      parameters:
      - name: deployment_name
        in: path
        description: Deployment name
        required: true
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformListCustomDomainsResponse'
      security:
      - PAT: []
      - OAuth Team Token: []
      - Team Token: []
      - OAuth Project Token: []
      x-operation-id-source: normalized
      x-operation-id-original: list custom domains
components:
  schemas:
    PlatformListCustomDomainsResponse:
      type: object
      required:
      - domains
      properties:
        domains:
          type: array
          items:
            $ref: '#/components/schemas/PlatformCustomDomainResponse'
          description: List of custom domains configured for this deployment.
    RequestDestination:
      type: string
      enum:
      - convexCloud
      - convexSite
    PlatformCustomDomainResponse:
      type: object
      required:
      - creationTime
      - deploymentName
      - requestDestination
      - domain
      properties:
        creationTime:
          type: integer
          format: int64
          description: Timestamp in milliseconds when this domain was created.
        deploymentName:
          type: string
          description: The deployment name this domain is configured for.
        requestDestination:
          $ref: '#/components/schemas/RequestDestination'
          description: The destination for this custom domain (convexCloud or convexSite).
        domain:
          type: string
          description: The custom domain name.
        verificationTime:
          type:
          - integer
          - 'null'
          format: int64
          description: 'Timestamp in milliseconds when this domain was verified, or null if not

            yet verified.'
    PlatformDeleteCustomDomainArgs:
      type: object
      required:
      - requestDestination
      - domain
      properties:
        requestDestination:
          $ref: '#/components/schemas/RequestDestination'
          description: The destination for this custom domain (convexCloud or convexSite).
        domain:
          type: string
          description: The custom domain name to delete.
  securitySchemes:
    OAuth_Project_Token:
      type: http
      scheme: bearer
      description: Obtained through a [Convex OAuth application](https://docs.convex.dev/management-api).
    OAuth_Team_Token:
      type: http
      scheme: bearer
      description: Obtained through a [Convex OAuth application](https://docs.convex.dev/management-api).
    PAT:
      type: http
      scheme: bearer
      bearerFormat: PAT
      description: Personal access token created in the Convex dashboard under user settings.
    Preview_Deploy_Key:
      type: http
      scheme: bearer
      description: Preview deploy key scoped to a project. Allowed only when operating on preview deployments in the key's project.
    Team_Token:
      type: http
      scheme: bearer
      description: Created in the dashboard under team settings for any team you can manage.
x-provenance:
  method: harvested
  publisher: Convex
  source: https://api.convex.dev/v1/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)