Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yext Domains API

The Domains API from Yext — 7 operation(s) for domains.

Yext Domains API is one of 23 APIs that Yext publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domains. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 7 paths, and defines 10 schemas. It is described by OpenAPI 3.0.0, at version 2.0.

Requests are made against a single base URL, https://api.yextapis.com/v2.

15 operations 7 paths 10 schemas 3 DELETE6 GET2 PATCH4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
2.0
Base URL
https://api.yextapis.com/v2
Authentication
API Key, API Key
Resource Areas
1

Authentication & Security 2

Yext Domains API declares 2 security schemes for authenticating requests. An API key is passed in the query as api_key (api_key). An API key is passed in the header as api-key (api-key). By default, every request must be authenticated.

Paths & Operations 15

Across 7 paths, the API surfaces 15 operations — 3 DELETE, 6 GET, 2 PATCH, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Domains 15
POST
/accounts/{accountId}/domains
Domain: Create
createDomain 2 params body → 201default
GET
/accounts/{accountId}/domains
Domain: List
listDomains 8 params → 200default
GET
/accounts/{accountId}/domains/{domainId}
Domain: Get
getDomain 4 params → 200default
PATCH
/accounts/{accountId}/domains/{domainId}
Domain: Update
updateDomain 5 params body → 200default
DELETE
/accounts/{accountId}/domains/{domainId}
Domain: Delete
deleteDomain 4 params → 202default
POST
/accounts/{accountId}/domains/migratepagesdomain/{hostname}
Migrate Legacy Pages Domain
migratePagesDomain 3 params → 201default
POST
/accounts/{accountId}/domains/{domainId}/associations
Domain Association: Create
createDomainAssociation 4 params body → 201default
GET
/accounts/{accountId}/domains/{domainId}/associations
Domain Association: List
listDomainAssociations 7 params → 200default
GET
/accounts/{accountId}/domains/{domainId}/associations/{domainAssociationId}
Domain Association: Get
getDomainAssociation 4 params → 200default
PATCH
/accounts/{accountId}/domains/{domainId}/associations/{domainAssociationId}
Domain Association: Update
updateDomainAssociation 6 params body → 201default
DELETE
/accounts/{accountId}/domains/{domainId}/associations/{domainAssociationId}
Domain Association: Delete
deleteDomainAssociation 4 params → 202default
POST
/accounts/{accountId}/csrs
Managed CSR: Create
createManagedCsr 2 params body → 201default
GET
/accounts/{accountId}/csrs
Managed CSR: List
listManagedCsrs 5 params → 200default
GET
/accounts/{accountId}/csrs/{managedCsrId}
Managed CSR: Get
getManagedCsr 4 params → 200default
DELETE
/accounts/{accountId}/csrs/{managedCsrId}
Managed CSR: Delete
deleteManagedCsr 3 params → 202default

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are ResponseError (4 properties), managed_csr (3 properties), custom_ssl_certificate (3 properties), site (2 properties). Each schema is shown below with its type and property counts.

site
object
The Pages site to associate with the parent [Domain](tag/Domains/operation/createDomain) resource.
2 properties
ResponseMetaWithError
previousPageToken
string
The token to use to retrieve the previous page of results. If empty, this is the first page.
nextPageToken
string
The token to use to retrieve the next page of results. If empty, this is the last page.
managed_csr
object
SSL certificate will be issued using the given [Managed CSR](tag/Domains/operation/createManagedCsr). Exactly one of managedssl, managedcsr, or customsslcertif…
3 properties
totalSize
integer
The total number of items that match the filter criteria, ignoring pagination.
custom_ssl_certificate
object
The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of managedssl, managedcsr, or customsslcertificate must be set…
3 properties 2 required
ResponseMeta
object
1 property
certificate_authority
string
ResponseError
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yext-domains-api-openapi.yml Raw ↑

Other APIs Yext publishes across the network.

Yext Account Settings API
Yext Accounts API
Yext Administrative API API
Yext Analytics API
Yext Computations API
Yext Configuration API
Yext Connectors API
Yext Content API API
Yext Health Check API
Yext Knowledge Manager API
Yext Licenses API
Yext Listings API