POST/api/v1/workspaces/{workspace_id}/domains

Add a domain

Adds a domain to a workspace and returns the DNS records to create at your DNS provider.

API token required20 per minute per IP

Guide: Custom domain

Code samples and Try it

Path parameters

#
  • workspace_idstringRequired

    The workspace's id, from the address of its settings page (markdrop.in/settings/workspaces/<workspace-id>) or from List workspaces.

Request body

#

application/json, required

  • hoststringRequired

    The full hostname, like docs.acme.com. 3–253 characters.

  • kind"app" | "cdn"Required

    app serves documents and files; cdn serves files only.

Responses

#
  • 201Created.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
201 response: 26 fields (DomainResponse)
  • idstring
  • hoststring
  • kind"app" | "cdn"
  • status"pending" | "verified" | "failed" | "lapsed"
  • created_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • verified_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • last_checked_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • last_errorstring | null
  • attachedboolean

    Default false.

  • is_primaryboolean

    Default false.

  • dns_record_namestring | null
  • dns_record_typestring | null

    Default "TXT".

  • dns_record_valuestring | null
  • dns_target_namestring | null
  • dns_target_typestring | null
  • dns_target_valuestring | null
  • warningstring | null
  • liveboolean

    Default false.

  • routing_okboolean | null
  • txt_okboolean | null
  • failuresinteger

    Default 0.

  • first_failed_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • lapsed_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • expires_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • apex_certainboolean | null

    Default true.

  • dns_routing_optionsarray of object
    3 fields inside
    • typestring
    • namestring
    • valuestring
Did this page help?