Create a new project.
/accounts/{account_identifier}/pages/projects
post
Pages Project
pages-project-create-project
nullnull[
{
"in": "path",
"name": "account_identifier",
"required": true,
"schema": {
"description": "Identifier",
"example": "023e105f4ecef8ad9ca31a8372d0c353",
"maxLength": 32,
"readOnly": true,
"type": "string"
}
}
]{
"content": {
"application/json": {
"schema": {
"properties": {
"build_config": {
"description": "Configs for the project build process.",
"properties": {
"build_caching": {
"description": "Enable build caching for the project.",
"example": true,
"nullable": true,
"type": "boolean"
},
"build_command": {
"description": "Command used to build project.",
"example": "npm run build",
"nullable": true,
"type": "string"
},
"destination_dir": {
"description": "Output directory of the build.",
"example": "build",
"nullable": true,
"type": "string"
},
"root_dir": {
"description": "Directory to run the command.",
"example": "/",
"nullable": true,
"type": "string"
},
"web_analytics_tag": {
"description": "The classifying tag for analytics.",
"example": "cee1c73f6e4743d0b5e6bb1a0bcaabcc",
"nullable": true,
"type": "string"
},
"web_analytics_token": {
"description": "The auth token for analytics.",
"example": "021e1057c18547eca7b79f2516f06o7x",
"nullable": true,
"type": "string"
}
},
"type": "object"
},
"canonical_deployment": {
"properties": {
"aliases": {
"description": "A list of alias URLs pointing to this deployment.",
"example": [
"https://branchname.projectname.pages.dev"
],
"items": {},
"nullable": true,
"readOnly": true,
"type": "array"
},
"build_config": {
"readOnly": true
},
"created_on": {
"description": "When the deployment was created.",
"example": "2021-03-09T00:55:03.923456Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deployment_trigger": {
"description": "Info about what caused the deployment.",
"properties": {
"metadata": {
"description": "Additional info about the trigger.",
"properties": {
"branch": {
"description": "Where the trigger happened.",
"example": "main",
"readOnly": true,
"type": "string"
},
"commit_hash": {
"description": "Hash of the deployment trigger commit.",
"example": "ad9ccd918a81025731e10e40267e11273a263421",
"readOnly": true,
"type": "string"
},
"commit_message": {
"description": "Message of the deployment trigger commit.",
"example": "Update index.html",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "What caused the deployment.",
"example": "ad_hoc",
"pattern": "push|ad_hoc",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"env_vars": {
"description": "A dict of env variables to build this deploy.",
"example": {
"BUILD_VERSION": {
"value": "3.3"
},
"ENV": {
"value": "STAGING"
}
},
"readOnly": true,
"type": "object"
},
"environment": {
"description": "Type of deploy.",
"example": "preview",
"pattern": "preview|production",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Id of the deployment.",
"example": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
"readOnly": true,
"type": "string"
},
"is_skipped": {
"description": "If the deployment has been skipped.",
"example": true,
"readOnly": true,
"type": "boolean"
},
"latest_stage": {
"readOnly": true
},
"modified_on": {
"description": "When the deployment was last modified.",
"example": "2021-03-09T00:58:59.045655",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"project_id": {
"description": "Id of the project.",
"example": "7b162ea7-7367-4d67-bcde-1160995d5",
"readOnly": true,
"type": "string"
},
"project_name": {
"description": "Name of the project.",
"example": "ninjakittens",
"readOnly": true,
"type": "string"
},
"short_id": {
"description": "Short Id (8 character) of the deployment.",
"example": "f64788e9",
"readOnly": true,
"type": "string"
},
"source": {
"readOnly": true
},
"stages": {
"description": "List of past stages.",
"example": [
{
"ended_on": "2021-06-03T15:39:03.134378Z",
"name": "queued",
"started_on": "2021-06-03T15:38:15.608194Z",
"status": "active"
},
{
"ended_on": null,
"name": "initialize",
"started_on": null,
"status": "idle"
},
{
"ended_on": null,
"name": "clone_repo",
"started_on": null,
"status": "idle"
},
{
"ended_on": null,
"name": "build",
"started_on": null,
"status": "idle"
},
{
"ended_on": null,
"name": "deploy",
"started_on": null,
"status": "idle"
}
],
"items": {
"description": "The status of the deployment.",
"properties": {
"ended_on": {
"description": "When the stage ended.",
"example": "2021-03-09T00:58:59.045655",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The current build stage.",
"example": "deploy",
"pattern": "queued|initialize|clone_repo|build|deploy",
"type": "string"
},
"started_on": {
"description": "When the stage started.",
"example": "2021-03-09T00:55:03.923456Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status": {
"description": "State of the current stage.",
"example": "success",
"pattern": "success|idle|active|failure|canceled",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"readOnly": true,
"type": "array"
},
"url": {
"description": "The live URL to view this deployment.",
"example": "https://f64788e9.ninjakittens.pages.dev",
"readOnly": true,
"type": "string"
}
},
"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": {
"description": "Configs for deployments in a project.",
"properties": {
"preview": {
"anyOf": [
{
"properties": {
"ai_bindings": {
"description": "Constellation bindings used for Pages Functions.",
"nullable": true,
"properties": {
"AI_BINDING": {
"description": "AI binding.",
"example": {},
"properties": {
"project_id": {}
},
"type": "object"
}
},
"type": "object"
},
"analytics_engine_datasets": {
"description": "Analytics Engine bindings used for Pages Functions.",
"nullable": true,
"properties": {
"ANALYTICS_ENGINE_BINDING": {
"description": "Analytics Engine binding.",
"example": {
"dataset": "api_analytics"
},
"properties": {
"dataset": {
"description": "Name of the dataset.",
"example": "api_analytics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"compatibility_date": {
"description": "Compatibility date used for Pages Functions.",
"example": "2022-01-01",
"type": "string"
},
"compatibility_flags": {
"description": "Compatibility flags used for Pages Functions.",
"example": [
"url_standard"
],
"items": {},
"type": "array"
},
"d1_databases": {
"description": "D1 databases used for Pages Functions.",
"nullable": true,
"properties": {
"D1_BINDING": {
"description": "D1 binding.",
"example": {
"id": "445e2955-951a-43f8-a35b-a4d0c8138f63"
},
"properties": {
"id": {
"description": "UUID of the D1 database.",
"example": "445e2955-951a-43f8-a35b-a4d0c8138f63",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"durable_object_namespaces": {
"description": "Durabble Object namespaces used for Pages Functions.",
"nullable": true,
"properties": {
"DO_BINDING": {
"description": "Durabble Object binding.",
"example": {
"namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3"
},
"properties": {
"namespace_id": {
"description": "ID of the Durabble Object namespace.",
"example": "5eb63bbbe01eeed093cb22bb8f5acdc3",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"env_vars": {
"description": "Environment variables for build configs.",
"nullable": true,
"properties": {
"ENVIRONMENT_VARIABLE": {
"description": "Environment variable.",
"example": {
"type": "plain_text",
"value": "hello world"
},
"properties": {
"type": {
"description": "The type of environment variable (plain text or secret)",
"enum": [
"plain_text",
"secret_text"
],
"type": "string"
},
"value": {
"description": "Environment variable value.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"kv_namespaces": {
"description": "KV namespaces used for Pages Functions.",
"properties": {
"KV_BINDING": {
"description": "KV binding.",
"example": {
"namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3"
},
"properties": {
"namespace_id": {
"description": "ID of the KV namespace.",
"example": "5eb63bbbe01eeed093cb22bb8f5acdc3",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"placement": {
"description": "Placement setting used for Pages Functions.",
"example": {
"mode": "smart"
},
"nullable": true,
"properties": {
"mode": {
"description": "Placement mode.",
"example": "smart",
"type": "string"
}
},
"type": "object"
},
"queue_producers": {
"description": "Queue Producer bindings used for Pages Functions.",
"nullable": true,
"properties": {
"QUEUE_PRODUCER_BINDING": {
"description": "Queue Producer binding.",
"example": {
"name": "some-queue"
},
"properties": {
"name": {
"description": "Name of the Queue.",
"example": "some-queue",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"r2_buckets": {
"description": "R2 buckets used for Pages Functions.",
"nullable": true,
"properties": {
"R2_BINDING": {
"description": "R2 binding.",
"example": {
"name": "some-bucket"
},
"properties": {
"name": {
"description": "Name of the R2 bucket.",
"example": "some-bucket",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_bindings": {
"description": "Services used for Pages Functions.",
"nullable": true,
"properties": {
"SERVICE_BINDING": {
"description": "Service binding.",
"example": {
"environment": "production",
"service": "example-worker"
},
"properties": {
"environment": {
"description": "The Service environment.",
"type": "string"
},
"service": {
"description": "The Service name.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
],
"description": "Configs for preview deploys.",
"type": "object"
},
"production": {
"anyOf": [
{
"properties": {
"ai_bindings": {
"description": "Constellation bindings used for Pages Functions.",
"nullable": true,
"properties": {
"AI_BINDING": {
"description": "AI binding.",
"example": {},
"properties": {
"project_id": {}
},
"type": "object"
}
},
"type": "object"
},
"analytics_engine_datasets": {
"description": "Analytics Engine bindings used for Pages Functions.",
"nullable": true,
"properties": {
"ANALYTICS_ENGINE_BINDING": {
"description": "Analytics Engine binding.",
"example": {
"dataset": "api_analytics"
},
"properties": {
"dataset": {
"description": "Name of the dataset.",
"example": "api_analytics",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"compatibility_date": {
"description": "Compatibility date used for Pages Functions.",
"example": "2022-01-01",
"type": "string"
},
"compatibility_flags": {
"description": "Compatibility flags used for Pages Functions.",
"example": [
"url_standard"
],
"items": {},
"type": "array"
},
"d1_databases": {
"description": "D1 databases used for Pages Functions.",
"nullable": true,
"properties": {
"D1_BINDING": {
"description": "D1 binding.",
"example": {
"id": "445e2955-951a-43f8-a35b-a4d0c8138f63"
},
"properties": {
"id": {
"description": "UUID of the D1 database.",
"example": "445e2955-951a-43f8-a35b-a4d0c8138f63",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"durable_object_namespaces": {
"description": "Durabble Object namespaces used for Pages Functions.",
"nullable": true,
"properties": {
"DO_BINDING": {
"description": "Durabble Object binding.",
"example": {
"namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3"
},
"properties": {
"namespace_id": {
"description": "ID of the Durabble Object namespace.",
"example": "5eb63bbbe01eeed093cb22bb8f5acdc3",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"env_vars": {
"description": "Environment variables for build configs.",
"nullable": true,
"properties": {
"ENVIRONMENT_VARIABLE": {
"description": "Environment variable.",
"example": {
"type": "plain_text",
"value": "hello world"
},
"properties": {
"type": {
"description": "The type of environment variable (plain text or secret)",
"enum": [
"plain_text",
"secret_text"
],
"type": "string"
},
"value": {
"description": "Environment variable value.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"kv_namespaces": {
"description": "KV namespaces used for Pages Functions.",
"properties": {
"KV_BINDING": {
"description": "KV binding.",
"example": {
"namespace_id": "5eb63bbbe01eeed093cb22bb8f5acdc3"
},
"properties": {
"namespace_id": {
"description": "ID of the KV namespace.",
"example": "5eb63bbbe01eeed093cb22bb8f5acdc3",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"placement": {
"description": "Placement setting used for Pages Functions.",
"example": {
"mode": "smart"
},
"nullable": true,
"properties": {
"mode": {
"description": "Placement mode.",
"example": "smart",
"type": "string"
}
},
"type": "object"
},
"queue_producers": {
"description": "Queue Producer bindings used for Pages Functions.",
"nullable": true,
"properties": {
"QUEUE_PRODUCER_BINDING": {
"description": "Queue Producer binding.",
"example": {
"name": "some-queue"
},
"properties": {
"name": {
"description": "Name of the Queue.",
"example": "some-queue",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"r2_buckets": {
"description": "R2 buckets used for Pages Functions.",
"nullable": true,
"properties": {
"R2_BINDING": {
"description": "R2 binding.",
"example": {
"name": "some-bucket"
},
"properties": {
"name": {
"description": "Name of the R2 bucket.",
"example": "some-bucket",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"service_bindings": {
"description": "Services used for Pages Functions.",
"nullable": true,
"properties": {
"SERVICE_BINDING": {
"description": "Service binding.",
"example": {
"environment": "production",
"service": "example-worker"
},
"properties": {
"environment": {
"description": "The Service environment.",
"type": "string"
},
"service": {
"description": "The Service name.",
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
],
"description": "Configs for production deploys.",
"type": "object"
}
},
"type": "object"
},
"domains": {
"description": "A list of associated custom domains for the project.",
"example": [
"customdomain.com",
"customdomain.org"
],
"items": {},
"readOnly": true,
"type": "array"
},
"id": {
"description": "Id of the project.",
"example": "7b162ea7-7367-4d67-bcde-1160995d5",
"readOnly": true,
"type": "string"
},
"latest_deployment": {
"properties": {
"aliases": {
"description": "A list of alias URLs pointing to this deployment.",
"example": [
"https://branchname.projectname.pages.dev"
],
"items": {},
"nullable": true,
"readOnly": true,
"type": "array"
},
"build_config": {
"readOnly": true
},
"created_on": {
"description": "When the deployment was created.",
"example": "2021-03-09T00:55:03.923456Z",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"deployment_trigger": {
"description": "Info about what caused the deployment.",
"properties": {
"metadata": {
"description": "Additional info about the trigger.",
"properties": {
"branch": {
"description": "Where the trigger happened.",
"example": "main",
"readOnly": true,
"type": "string"
},
"commit_hash": {
"description": "Hash of the deployment trigger commit.",
"example": "ad9ccd918a81025731e10e40267e11273a263421",
"readOnly": true,
"type": "string"
},
"commit_message": {
"description": "Message of the deployment trigger commit.",
"example": "Update index.html",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"type": {
"description": "What caused the deployment.",
"example": "ad_hoc",
"pattern": "push|ad_hoc",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"env_vars": {
"description": "A dict of env variables to build this deploy.",
"example": {
"BUILD_VERSION": {
"value": "3.3"
},
"ENV": {
"value": "STAGING"
}
},
"readOnly": true,
"type": "object"
},
"environment": {
"description": "Type of deploy.",
"example": "preview",
"pattern": "preview|production",
"readOnly": true,
"type": "string"
},
"id": {
"description": "Id of the deployment.",
"example": "f64788e9-fccd-4d4a-a28a-cb84f88f6",
"readOnly": true,
"type": "string"
},
"is_skipped": {
"description": "If the deployment has been skipped.",
"example": true,
"readOnly": true,
"type": "boolean"
},
"latest_stage": {
"readOnly": true
},
"modified_on": {
"description": "When the deployment was last modified.",
"example": "2021-03-09T00:58:59.045655",
"format": "date-time",
"readOnly": true,
"type": "string"
},
"project_id": {
"description": "Id of the project.",
"example": "7b162ea7-7367-4d67-bcde-1160995d5",
"readOnly": true,
"type": "string"
},
"project_name": {
"description": "Name of the project.",
"example": "ninjakittens",
"readOnly": true,
"type": "string"
},
"short_id": {
"description": "Short Id (8 character) of the deployment.",
"example": "f64788e9",
"readOnly": true,
"type": "string"
},
"source": {
"readOnly": true
},
"stages": {
"description": "List of past stages.",
"example": [
{
"ended_on": "2021-06-03T15:39:03.134378Z",
"name": "queued",
"started_on": "2021-06-03T15:38:15.608194Z",
"status": "active"
},
{
"ended_on": null,
"name": "initialize",
"started_on": null,
"status": "idle"
},
{
"ended_on": null,
"name": "clone_repo",
"started_on": null,
"status": "idle"
},
{
"ended_on": null,
"name": "build",
"started_on": null,
"status": "idle"
},
{
"ended_on": null,
"name": "deploy",
"started_on": null,
"status": "idle"
}
],
"items": {
"description": "The status of the deployment.",
"properties": {
"ended_on": {
"description": "When the stage ended.",
"example": "2021-03-09T00:58:59.045655",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"name": {
"description": "The current build stage.",
"example": "deploy",
"pattern": "queued|initialize|clone_repo|build|deploy",
"type": "string"
},
"started_on": {
"description": "When the stage started.",
"example": "2021-03-09T00:55:03.923456Z",
"format": "date-time",
"nullable": true,
"readOnly": true,
"type": "string"
},
"status": {
"description": "State of the current stage.",
"example": "success",
"pattern": "success|idle|active|failure|canceled",
"readOnly": true,
"type": "string"
}
},
"readOnly": true,
"type": "object"
},
"readOnly": true,
"type": "array"
},
"url": {
"description": "The live URL to view this deployment.",
"example": "https://f64788e9.ninjakittens.pages.dev",
"readOnly": true,
"type": "string"
}
},
"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": {
"readOnly": true
},
"subdomain": {
"description": "The Cloudflare subdomain associated with the project.",
"example": "helloworld.pages.dev",
"readOnly": true,
"type": "string"
}
},
"type": "object"
}
}
},
"required": true
}{
"200": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
}
}
]
}
}
},
"description": "Create project response."
},
"4XX": {
"content": {
"application/json": {
"schema": {
"allOf": [
{
"allOf": [
{
"properties": {
"errors": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"messages": {
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
},
"result": {
"anyOf": [
{
"type": "object"
},
{
"items": {},
"type": "array"
},
{
"type": "string"
}
]
},
"success": {
"description": "Whether the API call was successful",
"enum": [
true
],
"example": true,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
},
{
"properties": {
"result": {
"type": "object"
}
}
}
]
},
{
"properties": {
"errors": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": [
{
"code": 7003,
"message": "No route for the URI."
}
],
"minLength": 1
},
"messages": {
"allOf": [
{
"example": [],
"items": {
"properties": {
"code": {
"minimum": 1000,
"type": "integer"
},
"message": {
"type": "string"
}
},
"required": [
"code",
"message"
],
"type": "object",
"uniqueItems": true
},
"type": "array"
}
],
"example": []
},
"result": {
"nullable": true,
"type": "object"
},
"success": {
"description": "Whether the API call was successful.",
"enum": [
false
],
"example": false,
"type": "boolean"
}
},
"required": [
"success",
"errors",
"messages",
"result"
],
"type": "object"
}
]
}
}
},
"description": "Create project response failure."
}
}[
{
"api_email": [],
"api_key": []
}
]