Yext Knowledge API icon

Yext Knowledge API

Interact with Yext Knowledge API

Actions176

Domains → Create Domain

AI-generated

Summary

Create a new domain in Yext by specifying its hostname, integration details, SSL certificate settings, and ownership verification parameters.

Inputs

  • Name — Identifier for the domain resource.
  • Hostname (required) — Fully qualified domain name delegated to Yext.
  • Wildcard — Whether to allow single-level subdomain associations for this domain.
  • Destination (required) — Yext product usage for the domain; currently only 'PAGES' is supported.
  • Integration Type (required) — Type of domain integration with Yext; only 'USER_OWNED' is supported via API.
  • State — Current state of the domain in Yext's lifecycle.
  • Ownership Verification — Tokens and instructions to verify domain ownership using CNAME, TXT, or HTTP methods.
  • Managed Ssl — Configuration details for Yext-managed SSL certificate issuance and validation.
  • Managed Csr — Parameters for SSL certificate issuance using a managed CSR.
  • Custom Ssl Certificate — Custom SSL certificate and private key data to be used for the domain.
  • Errors — Errors or warnings related to the domain setup.
  • Create Time — Timestamp when the domain was created.
  • Update Time — Timestamp when the domain was last updated.
  • Delete Time — Timestamp when the domain was deleted.

Output shape

a single domain resource object representing the newly created domain

The output includes all domain properties as accepted in the input, reflecting the saved configuration. SSL configuration must be set with exactly one of 'managed_ssl', 'managed_csr', or 'custom_ssl_certificate'. Ownership verification details are required to complete domain verification. Only 'USER_OWNED' integration type and 'PAGES' destination are supported for creation via the API.

Discussion