Domain: Create

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json

Configuration for the domain to be created.

hostname
required
string

Fully qualified domain name that will be delegated to Yext.

wildcard
boolean
Default: false

If set to true, Domain Associations can be created for single-level subdomains of the given hostname.

destination
required
string
Value: "PAGES"

The Yext product the domain will be used for. Currently, only PAGES is supported.

integration_type
required
string
Enum: "USER_OWNED" "CUSTOM" "LEGACY_YEXT_MANAGED"

How the domain will be integrated with Yext. Only USER_OWNED is supported for domains created via the API.

object

SSL certificate will be automatically managed by Yext. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

SSL certificate will be issued using the given Managed CSR. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

Responses

Request samples

Content type
application/json
{
  • "hostname": "www.example.com",
  • "wildcard": false,
  • "destination": "PAGES",
  • "integration_type": "USER_OWNED",
  • "managed_ssl": {
    },
  • "managed_csr": {
    },
  • "custom_ssl_certificate": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {}
}

Domain: List

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

hostname
Array of strings
Example: hostname=www.example.com,test.example.com

The hostname to filter results by. If not provided, results for all hostnames will be returned.

show_deleted
boolean
Default: false
page_size
integer [ 0 .. 50 ]
Default: 10

Number of results to return per page. Sizes above the maximum will be clamped at the maximum value.

page_token
string

Token to retrieve the next page of results. If not provided, the first page of results will be returned.

view
string
Default: "BASIC"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Domain: Get

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

view
string
Default: "FULL"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {}
}

Domain: Update

Update the configurations for the specified domain. Also triggers a check for Yext or SSL verification, if the Domain is not yet ACTIVE. See the update_mask parameter for fields that can be updated, any other provided fields will be ignored.

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

force_move
boolean
Default: false

If true, and the domain is in a MOVE_REQUIRED state, will move ownership of the domain to this account.

update_mask
Array of strings
Default: "*"
Items Enum: "*" "managed_ssl.certificate_authority" "custom_ssl_certificate" "managed_csr.custom_public_certificate"

A comma-separated list of fields to update.

Request Body schema: application/json
object

SSL certificate will be automatically managed by Yext. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

SSL certificate will be issued using the given Managed CSR. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

object

The provided custom SSL certificate will be used for serving requests to the domain. Exactly one of managed_ssl, managed_csr, or custom_ssl_certificate must be set for a domain.

Responses

Request samples

Content type
application/json
{
  • "managed_ssl": {
    },
  • "managed_csr": {
    },
  • "custom_ssl_certificate": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {}
}

Domain: Delete

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

force
boolean
Default: false

If true, Domain Associations using this domain will also be deleted. If not set or false, and if Domain Associations exist using this domain, an error will be returned.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Migrate Legacy Pages Domain

Migrates a legacy Pages domain to a Domains API domain resource.

path Parameters
accountId
required
string
hostname
required
string

The hostname of the legacy domain to migrate.

query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Domain Association: Create

Creating a Domain Association will begin serving the contents of the associated resource at the Domain Association's hostname (given DNS for the hostname is already set up).

path Parameters
accountId
required
string
domainId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

force_move
boolean
Default: false

If true, and the domain is in a MOVE_REQUIRED state, will move ownership of the domain to this account.

Request Body schema: application/json
hostname
string

For parent Domain's with wildcard=false, this will equal parent Domain's hostname. For parent Domain's with wildcard=true, this can be a single-level subdomain of the parent Domain's hostname.

object

The Pages site to associate with the parent Domain resource.

Responses

Request samples

Content type
application/json
{
  • "hostname": "www.example.com",
  • "site": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Domain Association: List

path Parameters
accountId
required
string
domainId
required
string <uuid>

Set to "-" to reference Domain Associations from all domains in this account.

query Parameters
v
required
string

A date in YYYYMMDD format.

referenced_resources
Array of strings
Example: referenced_resources=accounts/123456/sites/6789,accounts/98765/sites/5678

Comma-separated list of associated resources to filter by.

page_size
integer [ 0 .. 50 ]
Default: 10

Number of results to return per page. Sizes above the maximum will be clamped at the maximum value.

page_token
string

Token to retrieve the next page of results. If not provided, the first page of results will be returned.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Domain Association: Get

path Parameters
accountId
required
string
domainId
required
string <uuid>
domainAssociationId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Domain Association: Update

path Parameters
accountId
required
string
domainId
required
string <uuid>
domainAssociationId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
object

The Pages site to associate with the parent Domain resource.

Responses

Request samples

Content type
application/json
{
  • "site": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Domain Association: Delete

Deleting a Domain Association will stop serving the contents of the associated resource from the Domain Association's hostname.

path Parameters
accountId
required
string
domainId
required
string <uuid>
domainAssociationId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}

Managed CSR: Create

Creates a Certificate Signing Request (CSR) resource that can be used to provision SSL certificates. Once created, this resource can be referenced by Domains with the managed_csr SSL integration to provision certificates using this CSR and a public certificate.

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{
  • "csr_payload": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Managed CSR: List

path Parameters
accountId
required
string
query Parameters
v
required
string

A date in YYYYMMDD format.

page_size
integer [ 0 .. 50 ]
Default: 10

Number of results to return per page. Sizes above the maximum will be clamped at the maximum value.

page_token
string

Token to retrieve the next page of results. If not provided, the first page of results will be returned.

view
string
Default: "BASIC"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Managed CSR: Get

path Parameters
accountId
required
string
managedCsrId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

view
string
Default: "FULL"
Enum: "FULL" "BASIC"

FULL returns all details, while BASIC omits certain SSL information. Using BASIC will also usually result in a lower response latency relative to using FULL.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "response": {
    }
}

Managed CSR: Delete

path Parameters
accountId
required
string
managedCsrId
required
string <uuid>
query Parameters
v
required
string

A date in YYYYMMDD format.

Responses

Response samples

Content type
application/json
{
  • "meta": {
    }
}