sites

Creates, updates, deletes, gets or lists a sites resource.

Overview

Name	sites
Type	Resource
Id	netlify.site.sites

Fields

The following fields are returned by SELECT queries:

getSite

Name	Datatype	Description
id	string
name	string
session_id	string
user_id	string
account_name	string
account_slug	string
admin_url	string
build_image	string
build_settings	object
capabilities	object
created_at	string (dateTime)
custom_domain	string
default_hooks_data	object
deploy_hook	string
deploy_url	string
domain_aliases	array
force_ssl	boolean
git_provider	string
id_domain	string
managed_dns	boolean
notification_email	string
password	string
plan	string
prerender	string
processing_settings	object
published_deploy	object
screenshot_url	string
ssl	boolean
ssl_url	string
state	string
updated_at	string (dateTime)
url	string

listSitesForAccount

Name	Datatype	Description
id	string
name	string
session_id	string
user_id	string
account_name	string
account_slug	string
admin_url	string
build_image	string
build_settings	object
capabilities	object
created_at	string (dateTime)
custom_domain	string
default_hooks_data	object
deploy_hook	string
deploy_url	string
domain_aliases	array
force_ssl	boolean
git_provider	string
id_domain	string
managed_dns	boolean
notification_email	string
password	string
plan	string
prerender	string
processing_settings	object
published_deploy	object
screenshot_url	string
ssl	boolean
ssl_url	string
state	string
updated_at	string (dateTime)
url	string

listSites

Name	Datatype	Description
id	string
name	string
session_id	string
user_id	string
account_name	string
account_slug	string
admin_url	string
build_image	string
build_settings	object
capabilities	object
created_at	string (dateTime)
custom_domain	string
default_hooks_data	object
deploy_hook	string
deploy_url	string
domain_aliases	array
force_ssl	boolean
git_provider	string
id_domain	string
managed_dns	boolean
notification_email	string
password	string
plan	string
prerender	string
processing_settings	object
published_deploy	object
screenshot_url	string
ssl	boolean
ssl_url	string
state	string
updated_at	string (dateTime)
url	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getSite	select	site_id
listSitesForAccount	select	account_slug	name, page, per_page
listSites	select		name, filter, page, per_page
createSiteInTeam	insert	account_slug	configure_dns
createSite	insert		configure_dns
deleteSite	delete	site_id
updateSite	exec	site_id

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_slug	string
site_id	string
configure_dns	boolean
filter	string
name	string
page	integer (int32)
per_page	integer (int32)

SELECT examples

getSite

OK

SELECT
id,
name,
session_id,
user_id,
account_name,
account_slug,
admin_url,
build_image,
build_settings,
capabilities,
created_at,
custom_domain,
default_hooks_data,
deploy_hook,
deploy_url,
domain_aliases,
force_ssl,
git_provider,
id_domain,
managed_dns,
notification_email,
password,
plan,
prerender,
processing_settings,
published_deploy,
screenshot_url,
ssl,
ssl_url,
state,
updated_at,
url
FROM netlify.site.sites
WHERE site_id = '{{ site_id }}' -- required
;

listSitesForAccount

OK

SELECT
id,
name,
session_id,
user_id,
account_name,
account_slug,
admin_url,
build_image,
build_settings,
capabilities,
created_at,
custom_domain,
default_hooks_data,
deploy_hook,
deploy_url,
domain_aliases,
force_ssl,
git_provider,
id_domain,
managed_dns,
notification_email,
password,
plan,
prerender,
processing_settings,
published_deploy,
screenshot_url,
ssl,
ssl_url,
state,
updated_at,
url
FROM netlify.site.sites
WHERE account_slug = '{{ account_slug }}' -- required
AND name = '{{ name }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

listSites

OK

SELECT
id,
name,
session_id,
user_id,
account_name,
account_slug,
admin_url,
build_image,
build_settings,
capabilities,
created_at,
custom_domain,
default_hooks_data,
deploy_hook,
deploy_url,
domain_aliases,
force_ssl,
git_provider,
id_domain,
managed_dns,
notification_email,
password,
plan,
prerender,
processing_settings,
published_deploy,
screenshot_url,
ssl,
ssl_url,
state,
updated_at,
url
FROM netlify.site.sites
WHERE name = '{{ name }}'
AND filter = '{{ filter }}'
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

createSiteInTeam

No description available.

INSERT INTO netlify.site.sites (
data__account_name,
data__account_slug,
data__admin_url,
data__build_image,
data__build_settings,
data__capabilities,
data__created_at,
data__custom_domain,
data__default_hooks_data,
data__deploy_hook,
data__deploy_url,
data__domain_aliases,
data__force_ssl,
data__git_provider,
data__id,
data__id_domain,
data__managed_dns,
data__name,
data__notification_email,
data__password,
data__plan,
data__prerender,
data__processing_settings,
data__published_deploy,
data__screenshot_url,
data__session_id,
data__ssl,
data__ssl_url,
data__state,
data__updated_at,
data__url,
data__user_id,
data__repo,
account_slug,
configure_dns
)
SELECT 
'{{ account_name }}',
'{{ account_slug }}',
'{{ admin_url }}',
'{{ build_image }}',
'{{ build_settings }}',
'{{ capabilities }}',
'{{ created_at }}',
'{{ custom_domain }}',
'{{ default_hooks_data }}',
'{{ deploy_hook }}',
'{{ deploy_url }}',
'{{ domain_aliases }}',
{{ force_ssl }},
'{{ git_provider }}',
'{{ id }}',
'{{ id_domain }}',
{{ managed_dns }},
'{{ name }}',
'{{ notification_email }}',
'{{ password }}',
'{{ plan }}',
'{{ prerender }}',
'{{ processing_settings }}',
'{{ published_deploy }}',
'{{ screenshot_url }}',
'{{ session_id }}',
{{ ssl }},
'{{ ssl_url }}',
'{{ state }}',
'{{ updated_at }}',
'{{ url }}',
'{{ user_id }}',
'{{ repo }}',
'{{ account_slug }}',
'{{ configure_dns }}'
RETURNING
id,
name,
session_id,
user_id,
account_name,
account_slug,
admin_url,
build_image,
build_settings,
capabilities,
created_at,
custom_domain,
default_hooks_data,
deploy_hook,
deploy_url,
domain_aliases,
force_ssl,
git_provider,
id_domain,
managed_dns,
notification_email,
password,
plan,
prerender,
processing_settings,
published_deploy,
screenshot_url,
ssl,
ssl_url,
state,
updated_at,
url
;

createSite

No description available.

INSERT INTO netlify.site.sites (
data__account_name,
data__account_slug,
data__admin_url,
data__build_image,
data__build_settings,
data__capabilities,
data__created_at,
data__custom_domain,
data__default_hooks_data,
data__deploy_hook,
data__deploy_url,
data__domain_aliases,
data__force_ssl,
data__git_provider,
data__id,
data__id_domain,
data__managed_dns,
data__name,
data__notification_email,
data__password,
data__plan,
data__prerender,
data__processing_settings,
data__published_deploy,
data__screenshot_url,
data__session_id,
data__ssl,
data__ssl_url,
data__state,
data__updated_at,
data__url,
data__user_id,
data__repo,
configure_dns
)
SELECT 
'{{ account_name }}',
'{{ account_slug }}',
'{{ admin_url }}',
'{{ build_image }}',
'{{ build_settings }}',
'{{ capabilities }}',
'{{ created_at }}',
'{{ custom_domain }}',
'{{ default_hooks_data }}',
'{{ deploy_hook }}',
'{{ deploy_url }}',
'{{ domain_aliases }}',
{{ force_ssl }},
'{{ git_provider }}',
'{{ id }}',
'{{ id_domain }}',
{{ managed_dns }},
'{{ name }}',
'{{ notification_email }}',
'{{ password }}',
'{{ plan }}',
'{{ prerender }}',
'{{ processing_settings }}',
'{{ published_deploy }}',
'{{ screenshot_url }}',
'{{ session_id }}',
{{ ssl }},
'{{ ssl_url }}',
'{{ state }}',
'{{ updated_at }}',
'{{ url }}',
'{{ user_id }}',
'{{ repo }}',
'{{ configure_dns }}'
RETURNING
id,
name,
session_id,
user_id,
account_name,
account_slug,
admin_url,
build_image,
build_settings,
capabilities,
created_at,
custom_domain,
default_hooks_data,
deploy_hook,
deploy_url,
domain_aliases,
force_ssl,
git_provider,
id_domain,
managed_dns,
notification_email,
password,
plan,
prerender,
processing_settings,
published_deploy,
screenshot_url,
ssl,
ssl_url,
state,
updated_at,
url
;

Manifest

# Description fields are for documentation purposes
- name: sites
  props:
    - name: account_slug
      value: string
      description: Required parameter for the sites resource.
    - name: account_name
      value: string
    - name: account_slug
      value: string
    - name: admin_url
      value: string
    - name: build_image
      value: string
    - name: build_settings
      value: object
    - name: capabilities
      value: object
    - name: created_at
      value: string
    - name: custom_domain
      value: string
    - name: default_hooks_data
      value: object
    - name: deploy_hook
      value: string
    - name: deploy_url
      value: string
    - name: domain_aliases
      value: array
    - name: force_ssl
      value: boolean
    - name: git_provider
      value: string
    - name: id
      value: string
    - name: id_domain
      value: string
    - name: managed_dns
      value: boolean
    - name: name
      value: string
    - name: notification_email
      value: string
    - name: password
      value: string
    - name: plan
      value: string
    - name: prerender
      value: string
    - name: processing_settings
      value: object
    - name: published_deploy
      value: object
    - name: screenshot_url
      value: string
    - name: session_id
      value: string
    - name: ssl
      value: boolean
    - name: ssl_url
      value: string
    - name: state
      value: string
    - name: updated_at
      value: string
    - name: url
      value: string
    - name: user_id
      value: string
    - name: repo
      value: object
    - name: configure_dns
      value: boolean

DELETE examples

deleteSite

No description available.

DELETE FROM netlify.site.sites
WHERE site_id = '{{ site_id }}' --required
;

Lifecycle Methods

updateSite

OK

EXEC netlify.site.sites.updateSite 
@site_id='{{ site_id }}' --required 
@@json=
'{
"account_name": "{{ account_name }}", 
"account_slug": "{{ account_slug }}", 
"admin_url": "{{ admin_url }}", 
"build_image": "{{ build_image }}", 
"build_settings": "{{ build_settings }}", 
"capabilities": "{{ capabilities }}", 
"created_at": "{{ created_at }}", 
"custom_domain": "{{ custom_domain }}", 
"default_hooks_data": "{{ default_hooks_data }}", 
"deploy_hook": "{{ deploy_hook }}", 
"deploy_url": "{{ deploy_url }}", 
"domain_aliases": "{{ domain_aliases }}", 
"force_ssl": {{ force_ssl }}, 
"git_provider": "{{ git_provider }}", 
"id": "{{ id }}", 
"id_domain": "{{ id_domain }}", 
"managed_dns": {{ managed_dns }}, 
"name": "{{ name }}", 
"notification_email": "{{ notification_email }}", 
"password": "{{ password }}", 
"plan": "{{ plan }}", 
"prerender": "{{ prerender }}", 
"processing_settings": "{{ processing_settings }}", 
"published_deploy": "{{ published_deploy }}", 
"screenshot_url": "{{ screenshot_url }}", 
"session_id": "{{ session_id }}", 
"ssl": {{ ssl }}, 
"ssl_url": "{{ ssl_url }}", 
"state": "{{ state }}", 
"updated_at": "{{ updated_at }}", 
"url": "{{ url }}", 
"user_id": "{{ user_id }}", 
"repo": "{{ repo }}"
}'
;