Domain: Create
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
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 |
integration_type required | string Enum: "USER_OWNED" "CUSTOM" "LEGACY_YEXT_MANAGED" How the domain will be integrated with Yext. Only |
object SSL certificate will be automatically managed by Yext.
Exactly one of | |
object SSL certificate will be issued using the given Managed CSR.
Exactly one of | |
object The provided custom SSL certificate will be used for serving requests to the domain.
Exactly one of |
Responses
Request samples
- Payload
{- "hostname": "www.example.com",
- "wildcard": false,
- "destination": "PAGES",
- "integration_type": "USER_OWNED",
- "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST",
- "validation_method": "HTTP"
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "custom_public_certificate": "-----BEGIN CERTIFICATE-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE-----\n"
}, - "custom_ssl_certificate": {
- "public_certificate": "-----BEGIN CERTIFICATE-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE-----\n",
- "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG\n...\n-----END PRIVATE KEY-----\n"
}
}
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "wildcard": false,
- "destination": "PAGES",
- "integration_type": "USER_OWNED",
- "state": "ACTIVE",
- "ownership_verification": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST",
- "validation_method": "HTTP",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "http_validation": {
- "body": "0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI"
}, - "txt_validation": {
- "delegated_dcv_domain": "string",
- "delegated_dcv_cname_target": "string",
- "txt_records": [
- {
- "domain": "_acme-challenge.www.example.com",
- "value": "-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos"
}
]
}
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "custom_ssl_certificate": {
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "delete_time": "2019-08-24T14:15:22Z"
}
}
Domain: List
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
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"
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "domains": [
- {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "wildcard": false,
- "destination": "PAGES",
- "integration_type": "USER_OWNED",
- "state": "ACTIVE",
- "ownership_verification": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST",
- "validation_method": "HTTP",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "http_validation": {
- "body": "0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI"
}, - "txt_validation": {
- "delegated_dcv_domain": "string",
- "delegated_dcv_cname_target": "string",
- "txt_records": [
- {
- "domain": "_acme-challenge.www.example.com",
- "value": "-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos"
}
]
}
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "custom_ssl_certificate": {
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "delete_time": "2019-08-24T14:15:22Z"
}
], - "next_page_token": "eyJ0b2tlbiI6InB4Zl9wYWdlX3Rva2VuIn0=",
- "total_size": 100
}
}
Domain: Get
path Parameters
accountId required | string |
domainId required | string <uuid> |
query Parameters
v required | string A date in |
view | string Default: "FULL" Enum: "FULL" "BASIC"
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "wildcard": false,
- "destination": "PAGES",
- "integration_type": "USER_OWNED",
- "state": "ACTIVE",
- "ownership_verification": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST",
- "validation_method": "HTTP",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "http_validation": {
- "body": "0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI"
}, - "txt_validation": {
- "delegated_dcv_domain": "string",
- "delegated_dcv_cname_target": "string",
- "txt_records": [
- {
- "domain": "_acme-challenge.www.example.com",
- "value": "-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos"
}
]
}
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "custom_ssl_certificate": {
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "delete_time": "2019-08-24T14:15:22Z"
}
}
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 |
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 | |
object SSL certificate will be issued using the given Managed CSR.
Exactly one of | |
object The provided custom SSL certificate will be used for serving requests to the domain.
Exactly one of |
Responses
Request samples
- Payload
{- "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST"
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "custom_public_certificate": "-----BEGIN CERTIFICATE-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE-----\n"
}, - "custom_ssl_certificate": {
- "public_certificate": "-----BEGIN CERTIFICATE-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE-----\n",
- "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDBj08sp5++4anG\n...\n-----END PRIVATE KEY-----\n"
}
}
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "wildcard": false,
- "destination": "PAGES",
- "integration_type": "USER_OWNED",
- "state": "ACTIVE",
- "ownership_verification": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST",
- "validation_method": "HTTP",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "http_validation": {
- "body": "0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI"
}, - "txt_validation": {
- "delegated_dcv_domain": "string",
- "delegated_dcv_cname_target": "string",
- "txt_records": [
- {
- "domain": "_acme-challenge.www.example.com",
- "value": "-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos"
}
]
}
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "custom_ssl_certificate": {
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "delete_time": "2019-08-24T14:15:22Z"
}
}
Domain: Delete
path Parameters
accountId required | string |
domainId required | string <uuid> |
query Parameters
v required | string A date in |
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
- 202
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}
}
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 |
Responses
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "domains": [
- {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "wildcard": false,
- "destination": "PAGES",
- "integration_type": "USER_OWNED",
- "state": "ACTIVE",
- "ownership_verification": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "managed_ssl": {
- "certificate_authority": "GOOGLE_TRUST",
- "validation_method": "HTTP",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}, - "http_validation": {
- "body": "0NW3MkWCrnT_5dwos0fKtwrPAqMygpcUqLqDNibb0xLXH3Zjag6wSqPfcvWTGkRr.r54qAqCZSs4xyyeamMffaxyR1FWYVb5OvwUh8EcrhpI"
}, - "txt_validation": {
- "delegated_dcv_domain": "string",
- "delegated_dcv_cname_target": "string",
- "txt_records": [
- {
- "domain": "_acme-challenge.www.example.com",
- "value": "-sXIiCspHlmE7GU-vV-6oBR-M6BU-4d1A4Ak3O1cGos"
}
]
}
}, - "managed_csr": {
- "managed_csr_id": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "custom_ssl_certificate": {
- "hostname_validation": {
- "cname_target": "idzm5s34j5.yext.pgscdncf.com.",
- "txt_domain": "_yext-domain.www.example.com",
- "txt_value": "3713b5c7-743b-4b7e-9c5c-b1f8c9523da5",
- "http_body": "35f00e6a-61c2-4857-b2cc-4c736f86b5ac"
}
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z",
- "delete_time": "2019-08-24T14:15:22Z"
}
], - "domain_associations": [
- {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
]
}
}
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 |
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 |
object The Pages site to associate with the parent Domain resource. |
Responses
Request samples
- Payload
{- "hostname": "www.example.com",
- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}
}
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
}
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 |
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
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "domain_associations": [
- {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
], - "next_page_token": "eyJ0b2tlbiI6InB4Zl9wYWdlX3Rva2VuIn0=",
- "total_size": 100
}
}
Domain Association: Get
path Parameters
accountId required | string |
domainId required | string <uuid> |
domainAssociationId required | string <uuid> |
query Parameters
v required | string A date in |
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
}
Domain Association: Update
path Parameters
accountId required | string |
domainId required | string <uuid> |
domainAssociationId required | string <uuid> |
query Parameters
v required | string A date in |
Request Body schema: application/json
object The Pages site to associate with the parent Domain resource. |
Responses
Request samples
- Payload
{- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}
}
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/domains/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0/associations/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "hostname": "www.example.com",
- "site": {
- "name": "accounts/123456/sites/6789",
- "primary": false
}, - "errors": [
- {
- "name": "string",
- "code": 0,
- "type": "FATAL_ERROR",
- "message": "string"
}
], - "create_time": "2019-08-24T14:15:22Z",
- "update_time": "2019-08-24T14:15:22Z"
}
}
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 |
Responses
Response samples
- 202
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}
}
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 |
Request Body schema: application/json
required | object |
Responses
Request samples
- Payload
{- "csr_payload": {
- "common_name": "www.example.com",
- "sans": [
- "test.example.com",
- "other.example.net"
], - "organization": "Example Inc.",
- "organizational_unit": "IT Department",
- "key_type": "rsa2048",
- "locality": "San Francisco",
- "state": "California",
- "country": "US"
}
}
Response samples
- 201
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "csr_payload": {
- "common_name": "www.example.com",
- "sans": [
- "test.example.com",
- "other.example.net"
], - "organization": "Example Inc.",
- "organizational_unit": "IT Department",
- "key_type": "rsa2048",
- "locality": "San Francisco",
- "state": "California",
- "country": "US"
}, - "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE REQUEST-----\n",
- "created_time": "2019-08-24T14:15:22Z"
}
}
Managed CSR: List
path Parameters
accountId required | string |
query Parameters
v required | string A date in |
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"
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "managed_csrs": [
- {
- "name": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "csr_payload": {
- "common_name": "www.example.com",
- "sans": [
- "test.example.com",
- "other.example.net"
], - "organization": "Example Inc.",
- "organizational_unit": "IT Department",
- "key_type": "rsa2048",
- "locality": "San Francisco",
- "state": "California",
- "country": "US"
}, - "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE REQUEST-----\n",
- "created_time": "2019-08-24T14:15:22Z"
}
], - "next_page_token": "eyJ0b2tlbiI6InB4Zl9wYWdlX3Rva2VuIn0=",
- "total_size": 100
}
}
Managed CSR: Get
path Parameters
accountId required | string |
managedCsrId required | string <uuid> |
query Parameters
v required | string A date in |
view | string Default: "FULL" Enum: "FULL" "BASIC"
|
Responses
Response samples
- 200
- default
{- "meta": {
- "uuid": "4f72b877-e2d0-4de4-9324-b9cf2c03e1a0"
}, - "response": {
- "name": "accounts/123456/csrs/4f72b877-e2d0-4de4-9324-b9cf2c03e1a0",
- "csr_payload": {
- "common_name": "www.example.com",
- "sans": [
- "test.example.com",
- "other.example.net"
], - "organization": "Example Inc.",
- "organizational_unit": "IT Department",
- "key_type": "rsa2048",
- "locality": "San Francisco",
- "state": "California",
- "country": "US"
}, - "csr": "-----BEGIN CERTIFICATE REQUEST-----\nMIIC2DCCAcCAQAwgY4xCzAJBgNVBAYTAlVTMRMwEQYDVQQIEwpDYWxpZm9ybmlh\n...\n-----END CERTIFICATE REQUEST-----\n",
- "created_time": "2019-08-24T14:15:22Z"
}
}