domains · version 0.1.0

Verify, rotate, or update a docs domain

PATCH /api/projects/{projectId}/domains/{domainId}

Request

PATCH https://sourced.sh/api/projects/{projectId}/domains/{domainId}

Parameters

Request body

Required.

application/json

type: object
properties:
  verify: boolean
  rotate: boolean
  domain: string

Responses

200

Domain updated.

application/json

type: object
required: project, domain
properties:
  project (required): Project
    Project:
      type: object
      required: id, name, createdAt
      properties:
        id (required): string
        name (required): string
        apiName: string
        mode: string enum flagship | stainless_compatible | custom | openapi | stainless_migration
          New writes use `flagship` or `stainless_compatible`; legacy `custom`, `openapi`, and `stainless_migration` records may still be returned.
        status: string enum created | active | archived
        createdAt (required): string
        updatedAt: string
        runCount: integer
  domain (required): DomainConfig
    DomainConfig:
      type: object
      required: id, domain, status, verificationToken, cnameTarget
      properties:
        id (required): string
        projectId: string
        domain (required): string
        status (required): string enum pending | verified | failed
        verificationToken (required): string
        cnameTarget (required): string
        lastVerifiedAt: string
        createdAt: string
        updatedAt: string

401

403

404

422

DNS records were checked but the domain could not be verified.

application/json

type: object
required: error, domain, dnsVerification
properties:
  error (required): string
  message: string
  domain (required): DomainConfig
    DomainConfig:
      type: object
      required: id, domain, status, verificationToken, cnameTarget
      properties:
        id (required): string
        projectId: string
        domain (required): string
        status (required): string enum pending | verified | failed
        verificationToken (required): string
        cnameTarget (required): string
        lastVerifiedAt: string
        createdAt: string
        updatedAt: string
  dnsVerification (required): object

Back to version index