Method: organizations.sites.dns.check

Checks DNS to verify that a domain has the expected canonical name (CNAME) record.

HTTP request

POST https://apigee.googleapis.com/v1/{parent=organizations/*}/sites/dns/check

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}

Request body

The request body contains an instance of DnsCnameCheck.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "data": {
    object (DomainVerified)
  },
  "errorCode": string,
  "message": string,
  "requestId": string,
  "status": string
}
Fields
data

object (DomainVerified)

Details about the domain.

errorCode

string

ID that can be used to find errors in the log files.

message

string

Description of the operation.

requestId

string

ID that can be used to find request details in the log files.

status

string

Status of the operation.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

DnsCnameCheck

JSON representation
{
  "domain": string,
  "cname": string
}
Fields
domain

string

Domain name.

cname

string

Canonical name (CNAME) record.

DomainVerified

JSON representation
{
  "verified": boolean
}
Fields
verified

boolean

Boolean flag that specifies whether the domain was verified.