Docs
Skip to content
post

Create site

Endpoint

posthttps://<REGION>.cloud.appwrite.io/v1/sites

Description

Create a new site.

Required scopes

sites.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Parameters

string
Required

Site ID. Choose a custom ID or generate a random ID with ID.unique(). Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.

string
Required

Site name. Max length: 128 chars.

enum
Required

Sites framework.

boolean

Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.

boolean

When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.

integer

Maximum request time in seconds.

string

Install Command.

string

Build Command.

string

Custom start command. Leave empty to use default.

string

Output Directory for site.

enum
Required

Runtime to use during build step.

enum

Framework adapter defining rendering strategy. Allowed values are: static, ssr

string

Appwrite Installation ID for VCS (Version Control System) deployment.

string

Fallback file for single page application sites.

string

Repository ID of the repo linked to the site.

string

Production branch for the repo linked to the site.

boolean

Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.

string

Path to site code in the linked repo.

array

List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.

array

List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.

string

Build specification for the site deployments.

string

Runtime specification for the SSR executions.

integer

Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.

Status
Content type
201
application/json

Site

Name
Type
Description
string

Site ID.

string

Site creation date in ISO 8601 format.

string

Site update date in ISO 8601 format.

string

Site name.

boolean

Site enabled.

boolean

Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.

boolean

When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.

string

Site framework.

integer

How many days to keep the non-active deployments before they will be automatically deleted.

string

Site's active deployment ID.

string

Active deployment creation date in ISO 8601 format.

string

Screenshot of active deployment with light theme preference file ID.

string

Screenshot of active deployment with dark theme preference file ID.

string

Site's latest deployment ID.

string

Latest deployment creation date in ISO 8601 format.

string

Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".

arrayof Variable

Site variables.

Object type

integer

Site request timeout in seconds.

string

The install command used to install the site dependencies.

string

The build command used to build the site.

string

Custom command to use when starting site runtime.

string

The directory where the site build output is located.

string

Site VCS (Version Control System) installation id.

string

VCS (Version Control System) Repository ID

string

VCS (Version Control System) branch name

string

Path to site in VCS (Version Control System) repository

boolean

Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests

arrayof string

List of branch name patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all branches.

arrayof string

List of file path patterns that trigger automatic deployments. Supports glob wildcards. Empty list deploys on all file changes.

string

Machine specification for deployment builds.

string

Machine specification for SSR executions.

string

Site build runtime.

string

Site framework adapter.

string

Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.

JavaScript
const sdk = require('node-appwrite');


const client = new sdk.Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setKey('<YOUR_API_KEY>'); // Your secret API key


const sites = new sdk.Sites(client);


const result = await sites.create({
    siteId: '<SITE_ID>',
    name: '<NAME>',
    framework: sdk.Framework.Analog,
    buildRuntime: sdk.BuildRuntime.Node145,
    enabled: false, // optional
    logging: false, // optional
    timeout: 1, // optional
    installCommand: '<INSTALL_COMMAND>', // optional
    buildCommand: '<BUILD_COMMAND>', // optional
    startCommand: '<START_COMMAND>', // optional
    outputDirectory: '<OUTPUT_DIRECTORY>', // optional
    adapter: sdk.Adapter.Static, // optional
    installationId: '<INSTALLATION_ID>', // optional
    fallbackFile: '<FALLBACK_FILE>', // optional
    providerRepositoryId: '<PROVIDER_REPOSITORY_ID>', // optional
    providerBranch: '<PROVIDER_BRANCH>', // optional
    providerSilentMode: false, // optional
    providerRootDirectory: '<PROVIDER_ROOT_DIRECTORY>', // optional
    providerBranches: [], // optional
    providerPaths: [], // optional
    buildSpecification: '', // optional
    runtimeSpecification: '', // optional
    deploymentRetention: 0 // optional
});