listSites

GET /sites

Copy endpoint

https://api.netlify.com/api/v1

Note: Environment variable keys and values have moved from build_settings.env and repo.env to a new endpoint. Please use getEnvVars to retrieve site environment variables.

Parameters

query Query Parameters

Name	Type
`name`	string
`filter`	"all" \| "owner" \| "guest"
`page`	number
`per_page`	number

Responses

200 application/json

interface Site {
id?: string;
state?: string;
plan?: string;
name?: string;
custom_domain?: string;
domain_aliases?: string[];
branch_deploy_custom_domain?: string;
deploy_preview_custom_domain?: string;
password?: string;
notification_email?: string;
url?: string;
ssl_url?: string;
admin_url?: string;
screenshot_url?: string;
created_at?: string;
updated_at?: string;
user_id?: string;
session_id?: string;
ssl?: boolean;
force_ssl?: boolean;
managed_dns?: boolean;
deploy_url?: string;
published_deploy?:

Deploy

interface Deploy {
id?: string;
site_id?: string;
user_id?: string;
build_id?: string;
state?: string;
name?: string;
url?: string;
ssl_url?: string;
admin_url?: string;
deploy_url?: string;
deploy_ssl_url?: string;
screenshot_url?: string;
review_id?: number;
draft?: boolean;
required?: string[];
required_functions?: string[];
error_message?: string;
branch?: string;
commit_ref?: string;
commit_url?: string;
skipped?: boolean;
created_at?: string;
updated_at?: string;
published_at?: string;
title?: string;
context?: string;
locked?: boolean;
review_url?: string;
framework?: string;
skew_protection_token?: string;
function_schedules?: FunctionSchedule[];
}

;
account_id?: string;
account_name?: string;
account_slug?: string;
git_provider?: string;
deploy_hook?: string;
capabilities?: { };
processing_settings?: { html?: { pretty_urls?: boolean; }; };
build_settings?:

RepoInfo

interface RepoInfo {
id?: number;
provider?: string;
deploy_key_id?: string;
repo_path?: string;
repo_branch?: string;
dir?: string;
functions_dir?: string;
cmd?: string;
allowed_branches?: string[];
public_repo?: boolean;
private_logs?: boolean;
repo_url?: string;
env?: { };
installation_id?: number;
stop_builds?: boolean;
}

;
id_domain?: string;
default_hooks_data?: { access_token?: string; };
build_image?: string;
prerender?: string;
functions_region?: string;
prevent_non_git_prod_deploys?: boolean;
}[]

default application/json

error

interface Error {
code?: number;
message: string;
}