pages_project-object

APIs.ioEngineeringPlatform

Properties

Name	Type	Description
build_config	object
canonical_deployment	object
created_on	string	When the project was created.
deployment_configs	object
domains	array	A list of associated custom domains for the project.
id	string	Id of the project.
latest_deployment	object
name	string	Name of the project.
production_branch	string	Production branch of the project. Used to identify production deployments.
source	object
subdomain	string	The Cloudflare subdomain associated with the project.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/pages_project-object",
  "title": "pages_project-object",
  "properties": {
    "build_config": {
      "$ref": "#/components/schemas/pages_build_config"
    },
    "canonical_deployment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/pages_deployments"
        },
        {
          "description": "Most recent deployment to the repo.",
          "nullable": true,
          "readOnly": true,
          "type": "object"
        }
      ]
    },
    "created_on": {
      "description": "When the project was created.",
      "example": "2017-01-01T00:00:00Z",
      "format": "date-time",
      "readOnly": true,
      "type": "string"
    },
    "deployment_configs": {
      "$ref": "#/components/schemas/pages_deployment_configs"
    },
    "domains": {
      "description": "A list of associated custom domains for the project.",
      "example": [
        "customdomain.com",
        "customdomain.org"
      ],
      "items": {
        "type": "string"
      },
      "readOnly": true,
      "type": "array"
    },
    "id": {
      "description": "Id of the project.",
      "example": "7b162ea7-7367-4d67-bcde-1160995d5",
      "readOnly": true,
      "type": "string"
    },
    "latest_deployment": {
      "allOf": [
        {
          "$ref": "#/components/schemas/pages_deployments"
        },
        {
          "description": "Most recent deployment to the repo.",
          "nullable": true,
          "readOnly": true,
          "type": "object"
        }
      ]
    },
    "name": {
      "description": "Name of the project.",
      "example": "NextJS Blog",
      "type": "string"
    },
    "production_branch": {
      "description": "Production branch of the project. Used to identify production deployments.",
      "example": "main",
      "type": "string"
    },
    "source": {
      "$ref": "#/components/schemas/pages_source"
    },
    "subdomain": {
      "description": "The Cloudflare subdomain associated with the project.",
      "example": "helloworld.pages.dev",
      "readOnly": true,
      "type": "string"
    }
  },
  "type": "object"
}