Get domains

client.Pages.Projects.Domains.List(ctx, projectName, query) (*SinglePage[ProjectDomainListResponse], error)

GET/accounts/{account_id}/pages/projects/{project_name}/domains

Fetch a list of all domains associated with a Pages project.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Pages ReadPages Write

ParametersExpand Collapse

projectName string

Name of the project.

query ProjectDomainListParams

AccountID param.Field[string]

Identifier.

maxLength32

ReturnsExpand Collapse

type ProjectDomainListResponse struct{…}

ID string

CertificateAuthority ProjectDomainListResponseCertificateAuthority

One of the following:

const ProjectDomainListResponseCertificateAuthorityGoogle ProjectDomainListResponseCertificateAuthority = "google"

const ProjectDomainListResponseCertificateAuthorityLetsEncrypt ProjectDomainListResponseCertificateAuthority = "lets_encrypt"

CreatedOn string

DomainID string

Name string

The domain name.

Status ProjectDomainListResponseStatus

One of the following:

const ProjectDomainListResponseStatusInitializing ProjectDomainListResponseStatus = "initializing"

const ProjectDomainListResponseStatusPending ProjectDomainListResponseStatus = "pending"

const ProjectDomainListResponseStatusActive ProjectDomainListResponseStatus = "active"

const ProjectDomainListResponseStatusDeactivated ProjectDomainListResponseStatus = "deactivated"

const ProjectDomainListResponseStatusBlocked ProjectDomainListResponseStatus = "blocked"

const ProjectDomainListResponseStatusError ProjectDomainListResponseStatus = "error"

ValidationData ProjectDomainListResponseValidationData

Method ProjectDomainListResponseValidationDataMethod

One of the following:

const ProjectDomainListResponseValidationDataMethodHTTP ProjectDomainListResponseValidationDataMethod = "http"

const ProjectDomainListResponseValidationDataMethodTXT ProjectDomainListResponseValidationDataMethod = "txt"

Status ProjectDomainListResponseValidationDataStatus

One of the following:

const ProjectDomainListResponseValidationDataStatusInitializing ProjectDomainListResponseValidationDataStatus = "initializing"

const ProjectDomainListResponseValidationDataStatusPending ProjectDomainListResponseValidationDataStatus = "pending"

const ProjectDomainListResponseValidationDataStatusActive ProjectDomainListResponseValidationDataStatus = "active"

const ProjectDomainListResponseValidationDataStatusDeactivated ProjectDomainListResponseValidationDataStatus = "deactivated"

const ProjectDomainListResponseValidationDataStatusError ProjectDomainListResponseValidationDataStatus = "error"

ErrorMessage stringOptional

TXTName stringOptional

TXTValue stringOptional

VerificationData ProjectDomainListResponseVerificationData

Status ProjectDomainListResponseVerificationDataStatus

One of the following:

const ProjectDomainListResponseVerificationDataStatusPending ProjectDomainListResponseVerificationDataStatus = "pending"

const ProjectDomainListResponseVerificationDataStatusActive ProjectDomainListResponseVerificationDataStatus = "active"

const ProjectDomainListResponseVerificationDataStatusDeactivated ProjectDomainListResponseVerificationDataStatus = "deactivated"

const ProjectDomainListResponseVerificationDataStatusBlocked ProjectDomainListResponseVerificationDataStatus = "blocked"

const ProjectDomainListResponseVerificationDataStatusError ProjectDomainListResponseVerificationDataStatus = "error"

ErrorMessage stringOptional

ZoneTag string

Get domains

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/cloudflare-go"
  "github.com/stainless-sdks/cloudflare-go/option"
  "github.com/stainless-sdks/cloudflare-go/pages"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  page, err := client.Pages.Projects.Domains.List(
    context.TODO(),
    "this-is-my-project-01",
    pages.ProjectDomainListParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "certificate_authority": "lets_encrypt",
      "created_on": "created_on",
      "domain_id": "domain_id",
      "name": "this-is-my-domain-01.com",
      "status": "initializing",
      "validation_data": {
        "method": "http",
        "status": "initializing",
        "error_message": "error_message",
        "txt_name": "txt_name",
        "txt_value": "txt_value"
      },
      "verification_data": {
        "status": "pending",
        "error_message": "error_message"
      },
      "zone_tag": "zone_tag"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": [
    {
      "id": "id",
      "certificate_authority": "lets_encrypt",
      "created_on": "created_on",
      "domain_id": "domain_id",
      "name": "this-is-my-domain-01.com",
      "status": "initializing",
      "validation_data": {
        "method": "http",
        "status": "initializing",
        "error_message": "error_message",
        "txt_name": "txt_name",
        "txt_value": "txt_value"
      },
      "verification_data": {
        "status": "pending",
        "error_message": "error_message"
      },
      "zone_tag": "zone_tag"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000,
    "total_pages": 100
  }
}