Domains API: Managed CSR | Yext Hitchhikers Platform
Managed CSRs are a top-level resource in the Domains API. This object represents a private key and a managed certificate signing request stored in Cloudflare. When a managed CSR is created, a new private key will be created in Cloudflare, which is inaccessible to the user or Yext. Then a CSR will also be created from the provided fields and returned. From there, this CSR can be used with any certificate authority to generate a public key. This public key will be associated with a domain and specified in the managed CSR settings section.
| Field | Description | Example |
|---|---|---|
Name name |
The unique identifier for the managed CSR. The domain will use a resource identifier that not only identifies it but also indicates what business it belongs to. It will follow the format: /accounts/{business_id}/csrs/{managed_csr_id}. The managed CSR ID will be in UUIDv7 format. |
/accounts/123456/csrs/abcdf-12343-defsg-12345 |
CSR Payload csr_payload |
The payload for the CSR, which follows the typical required fields when generating a certificate signing request. See the table below. | |
CSR csr |
A newline-encoded string, which is the certificate signing request, meant to be used to generate the public certificate with a certificate authority. | |
Create time created_time |
This is the UTC time when the domain association was created. |
CSR Payload
All of these fields are required and match the expected format of CSRs ( example article ).
| Field | Description | Example |
|---|---|---|
Country country |
The two-letter country code where your organization is located. | US |
State state |
The two-letter state/province code where your organization is located. | NY |
Locality locality |
The city/locality where your organization is located. | New York |
Organization organization |
The name of your organization. | Yext |
Organizational Unit organizational_unit |
An optional field to specify the division of your organization handling the certificate. | |
Common Name common_name |
The fully qualified domain name (FQDN) of your server. | yext.com |
SANs sans |
Additional hostnames that should be covered by this certificate | hitchhikers.yext.com |
Key Type key_type |
An optional field to specify the key type for the private key associated with the CSR. Options are rsa2048 and p256v1. If no choice is provided, rsa2048 will be used. |
rsa2048 |
<% elem.innerText %>