Add domain

client.Pages.Projects.Domains.New(ctx, projectName, params) (*ProjectDomainNewResponse, error)

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

Add a new domain for the 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 Write

ParametersExpand Collapse

projectName string

Name of the project.

params ProjectDomainNewParams

AccountID param.Field[string]

Path param: Identifier.

maxLength32

Name param.Field[string]

Body param: The domain name.

ReturnsExpand Collapse

type ProjectDomainNewResponse struct{…}

ID string

CertificateAuthority ProjectDomainNewResponseCertificateAuthority

One of the following:

const ProjectDomainNewResponseCertificateAuthorityGoogle ProjectDomainNewResponseCertificateAuthority = "google"

const ProjectDomainNewResponseCertificateAuthorityLetsEncrypt ProjectDomainNewResponseCertificateAuthority = "lets_encrypt"

CreatedOn string

DomainID string

Name string

The domain name.

Status ProjectDomainNewResponseStatus

One of the following:

const ProjectDomainNewResponseStatusInitializing ProjectDomainNewResponseStatus = "initializing"

const ProjectDomainNewResponseStatusPending ProjectDomainNewResponseStatus = "pending"

const ProjectDomainNewResponseStatusActive ProjectDomainNewResponseStatus = "active"

const ProjectDomainNewResponseStatusDeactivated ProjectDomainNewResponseStatus = "deactivated"

const ProjectDomainNewResponseStatusBlocked ProjectDomainNewResponseStatus = "blocked"

const ProjectDomainNewResponseStatusError ProjectDomainNewResponseStatus = "error"

ValidationData ProjectDomainNewResponseValidationData

Method ProjectDomainNewResponseValidationDataMethod

One of the following:

const ProjectDomainNewResponseValidationDataMethodHTTP ProjectDomainNewResponseValidationDataMethod = "http"

const ProjectDomainNewResponseValidationDataMethodTXT ProjectDomainNewResponseValidationDataMethod = "txt"

Status ProjectDomainNewResponseValidationDataStatus

One of the following:

const ProjectDomainNewResponseValidationDataStatusInitializing ProjectDomainNewResponseValidationDataStatus = "initializing"

const ProjectDomainNewResponseValidationDataStatusPending ProjectDomainNewResponseValidationDataStatus = "pending"

const ProjectDomainNewResponseValidationDataStatusActive ProjectDomainNewResponseValidationDataStatus = "active"

const ProjectDomainNewResponseValidationDataStatusDeactivated ProjectDomainNewResponseValidationDataStatus = "deactivated"

const ProjectDomainNewResponseValidationDataStatusError ProjectDomainNewResponseValidationDataStatus = "error"

ErrorMessage stringOptional

TXTName stringOptional

TXTValue stringOptional

VerificationData ProjectDomainNewResponseVerificationData

Status ProjectDomainNewResponseVerificationDataStatus

One of the following:

const ProjectDomainNewResponseVerificationDataStatusPending ProjectDomainNewResponseVerificationDataStatus = "pending"

const ProjectDomainNewResponseVerificationDataStatusActive ProjectDomainNewResponseVerificationDataStatus = "active"

const ProjectDomainNewResponseVerificationDataStatusDeactivated ProjectDomainNewResponseVerificationDataStatus = "deactivated"

const ProjectDomainNewResponseVerificationDataStatusBlocked ProjectDomainNewResponseVerificationDataStatus = "blocked"

const ProjectDomainNewResponseVerificationDataStatusError ProjectDomainNewResponseVerificationDataStatus = "error"

ErrorMessage stringOptional

ZoneTag string

Add domain

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"),
  )
  domain, err := client.Pages.Projects.Domains.New(
    context.TODO(),
    "this-is-my-project-01",
    pages.ProjectDomainNewParams{
      AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
      Name: cloudflare.F("this-is-my-domain-01.com"),
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", domain.ID)
}

{
  "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
}

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
}