Coda

List custom doc domains

开发环境

GET

/docs/${docId}/domains

CustomDocDomains

List all custom domains for a published doc.

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://dev-cn.your-api-server.com/docs/$AbCDeFGH/domains'

响应示例

200 - 示例 1

{
  "nextPageToken": "eyJsaW1pd",
  "customDocDomains": [
    {
      "setupStatus": "pending",
      "domainStatus": "connected",
      "customDocDomain": "example.com",
      "hasCertificate": true,
      "hasDnsDocId": true,
      "lastVerifiedTimestamp": "2018-04-11T00:18:57.946Z"
    }
  ],
  "nextPageLink": "https://coda.io/apis/v1/docs/AbCDeFGH/domains?pageToken=eyJsaW1pd"
}

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

返回响应

🟢200List of custom domains for a published doc.

application/json

Body

List of all custom domains added to a published doc.

nextPageToken

string

可选

If specified, an opaque token used to fetch the next page of results.

示例值:

eyJsaW1pd

customDocDomains

array[object (CustomDocDomain) {6}]

必需

Custom domains for the published doc.

setupStatus

enum<string>

必需

枚举值:

pendingsucceededfailed

domainStatus

enum<string>

必需

枚举值:

connectednotConnected

customDocDomain

string

必需

The custom domain.

示例值:

example.com

hasCertificate

boolean

必需

Whether the domain has a certificate

示例值:

true

hasDnsDocId

boolean

必需

Whether the domain DNS points back to this doc.

示例值:

true

lastVerifiedTimestamp

string <date-time>

可选

When the domain DNS settings were last checked.

示例值:

2018-04-11T00:18:57.946Z

nextPageLink

string <url>

可选

If specified, a link that can be used to fetch the next page of results.

示例值:

https://coda.io/apis/v1/docs/AbCDeFGH/domains?pageToken=eyJsaW1pd

🟠401401

🟠403403

🟠404404

🟠429429

修改于 2024-03-20 08:13:15

Get a control

Add custom domain