site

List sites

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.

get/sites

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/sites
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Query parameters

namestring
filter'all' | 'owner' | 'guest'
pageinteger
per_pageinteger

Response

OK

idstring
statestring
planstring
namestring
custom_domainstring
domain_aliasesstring[]
branch_deploy_custom_domainstring
deploy_preview_custom_domainstring
passwordstring
notification_emailstring
urlstring
ssl_urlstring
admin_urlstring
screenshot_urlstring
created_atstring dateTime
updated_atstring dateTime
user_idstring
session_idstring
sslboolean
force_sslboolean
managed_dnsboolean
deploy_urlstring
account_idstring
account_namestring
account_slugstring
git_providerstring
deploy_hookstring
capabilitiesobject
id_domainstring
build_imagestring
prerenderstring
functions_regionstring
prevent_non_git_prod_deploysboolean

Changes

No recorded changes to this operation across all 65 revisions of this API.