Type Alias: Site ​
Site =
object
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3193
Site
Properties ​
$createdAt ​
$createdAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3201
Site creation date in ISO 8601 format.
$id ​
$id:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3197
Site ID.
$updatedAt ​
$updatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3205
Site update date in ISO 8601 format.
adapter ​
adapter:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3317
Site framework adapter.
buildCommand ​
buildCommand:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3273
The build command used to build the site.
buildRuntime ​
buildRuntime:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3313
Site build runtime.
buildSpecification ​
buildSpecification:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3305
Machine specification for deployment builds.
deploymentCreatedAt ​
deploymentCreatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3237
Active deployment creation date in ISO 8601 format.
deploymentId ​
deploymentId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3233
Site's active deployment ID.
deploymentRetention ​
deploymentRetention:
number
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3229
How many days to keep the non-active deployments before they will be automatically deleted.
deploymentScreenshotDark ​
deploymentScreenshotDark:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3245
Screenshot of active deployment with dark theme preference file ID.
deploymentScreenshotLight ​
deploymentScreenshotLight:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3241
Screenshot of active deployment with light theme preference file ID.
enabled ​
enabled:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3213
Site enabled.
fallbackFile ​
fallbackFile:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3321
Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.
framework ​
framework:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3225
Site framework.
installationId ​
installationId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3285
Site VCS (Version Control System) installation id.
installCommand ​
installCommand:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3269
The install command used to install the site dependencies.
latestDeploymentCreatedAt ​
latestDeploymentCreatedAt:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3253
Latest deployment creation date in ISO 8601 format.
latestDeploymentId ​
latestDeploymentId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3249
Site's latest deployment ID.
latestDeploymentStatus ​
latestDeploymentStatus:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3257
Status of latest deployment. Possible values are "waiting", "processing", "building", "ready", and "failed".
live ​
live:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3217
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.
logging ​
logging:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3221
When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
name ​
name:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3209
Site name.
outputDirectory ​
outputDirectory:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3281
The directory where the site build output is located.
providerBranch ​
providerBranch:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3293
VCS (Version Control System) branch name
providerRepositoryId ​
providerRepositoryId:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3289
VCS (Version Control System) Repository ID
providerRootDirectory ​
providerRootDirectory:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3297
Path to site in VCS (Version Control System) repository
providerSilentMode ​
providerSilentMode:
boolean
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3301
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
runtimeSpecification ​
runtimeSpecification:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3309
Machine specification for SSR executions.
startCommand ​
startCommand:
string
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3277
Custom command to use when starting site runtime.
timeout ​
timeout:
number
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3265
Site request timeout in seconds.
vars ​
vars:
Variable[]
Defined in: node_modules/.pnpm/node-appwrite@23.1.0/node_modules/node-appwrite/dist/models.d.mts:3261
Site variables.