WebstoreCustomDomainDto

Represents a custom domain attached to a webstore, together with the state of its ownership and SSL verification.

idstringRequired

The identifier the domain was registered under with the hosting provider.

hostnamestringRequired

The domain the webstore is served from, without a scheme (e.g., store.example.com).

statusstringRequired

The verification state of the domain as reported by the hosting provider. The domain only serves the webstore once it is active.

verification_errorsstring[]Required

The errors raised by the last ownership verification attempt. Empty when the last attempt raised none.

created_atstringOptional

The date and time the domain was attached to the webstore.

ownership_verificationWebstoreCustomDomainOwnershipVerificationDtoOptional

Represents the DNS record that has to be published to prove ownership of a webstore's custom domain.

namestringRequired

The name to publish the record under.

typestringRequired

The kind of DNS record to publish (e.g., txt).

valuestringRequired

The value the record has to hold.

ownership_verification_httpWebstoreCustomDomainOwnershipVerificationHttpDtoOptional

Represents the token file that has to be served over HTTP to prove ownership of a webstore's custom domain.

http_bodystringRequired

The body that URL has to return.

http_urlstringRequired

The URL on the domain the token file has to be served from.

sslWebstoreCustomDomainSslDtoOptional

Represents the SSL certificate issued for a webstore's custom domain.

idstringRequired

The identifier the certificate was issued under.

methodstringRequired

How control of the domain is validated for the certificate (e.g., txt, http, email).

statusstringRequired

The state of the certificate (e.g., pending_validation, active). The domain only serves traffic over HTTPS once it is active.

validation_errorsstring[]Required

The errors raised by the last certificate validation attempt. Empty when the last attempt raised none.

validation_recordsWebstoreCustomDomainSslValidationRecordDto[]Required

The records that have to be published to validate the certificate. Empty once validation no longer needs them.

emailsstring[]Required

The addresses a validation link can be sent to. Empty when validation is not by email.

http_bodystringOptional

The body that URL has to return, or null when validation is not over HTTP.

http_urlstringOptional

The URL on the domain the token file has to be served from, or null when validation is not over HTTP.

txt_namestringOptional

The name to publish the DNS TXT record under, or null when validation is not by TXT record.

txt_valuestringOptional

The value that TXT record has to hold, or null when validation is not by TXT record.

certificate_authoritystringOptional

The authority issuing the certificate, or null while one has not been chosen.

Example

{
  "id": "string",
  "hostname": "string",
  "status": "string",
  "verification_errors": [
    "string"
  ],
  "created_at": "2024-01-01T00:00:00Z",
  "ownership_verification": {
    "name": "string",
    "type": "string",
    "value": "string"
  },
  "ownership_verification_http": {
    "http_body": "string",
    "http_url": "string"
  },
  "ssl": {
    "id": "string",
    "method": "string",
    "status": "string",
    "validation_errors": [
      "string"
    ],
    "validation_records": [
      {
        "emails": [
          "string"
        ],
        "http_body": "string",
        "http_url": "string",
        "txt_name": "string",
        "txt_value": "string"
      }
    ],
    "certificate_authority": "string"
  }
}