sites_deploys

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

Overview

Name	sites_deploys
Type	Resource
Id	netlify.deploy.sites_deploys

Fields

The following fields are returned by SELECT queries:

getSiteDeploy

Name	Datatype	Description
id	string
name	string
build_id	string
review_id	number
site_id	string
user_id	string
admin_url	string
branch	string
commit_ref	string
commit_url	string
context	string
created_at	string (dateTime)
deploy_ssl_url	string
deploy_url	string
draft	boolean
error_message	string
framework	string
function_schedules	array
locked	boolean
published_at	string (dateTime)
required	array
required_functions	array
review_url	string
screenshot_url	string
site_capabilities	object
skipped	boolean
ssl_url	string
state	string
title	string
updated_at	string (dateTime)
url	string

listSiteDeploys

Name	Datatype	Description
id	string
name	string
build_id	string
review_id	number
site_id	string
user_id	string
admin_url	string
branch	string
commit_ref	string
commit_url	string
context	string
created_at	string (dateTime)
deploy_ssl_url	string
deploy_url	string
draft	boolean
error_message	string
framework	string
function_schedules	array
locked	boolean
published_at	string (dateTime)
required	array
required_functions	array
review_url	string
screenshot_url	string
site_capabilities	object
skipped	boolean
ssl_url	string
state	string
title	string
updated_at	string (dateTime)
url	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
getSiteDeploy	select	site_id, deploy_id
listSiteDeploys	select	site_id
createSiteDeploy	insert	site_id
updateSiteDeploy	exec	site_id, deploy_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
deploy_id	string
site_id	string

SELECT examples

getSiteDeploy

OK

SELECT
id,
name,
build_id,
review_id,
site_id,
user_id,
admin_url,
branch,
commit_ref,
commit_url,
context,
created_at,
deploy_ssl_url,
deploy_url,
draft,
error_message,
framework,
function_schedules,
locked,
published_at,
required,
required_functions,
review_url,
screenshot_url,
site_capabilities,
skipped,
ssl_url,
state,
title,
updated_at,
url
FROM netlify.deploy.sites_deploys
WHERE site_id = '{{ site_id }}' -- required
AND deploy_id = '{{ deploy_id }}' -- required
;

listSiteDeploys

OK

SELECT
id,
name,
build_id,
review_id,
site_id,
user_id,
admin_url,
branch,
commit_ref,
commit_url,
context,
created_at,
deploy_ssl_url,
deploy_url,
draft,
error_message,
framework,
function_schedules,
locked,
published_at,
required,
required_functions,
review_url,
screenshot_url,
site_capabilities,
skipped,
ssl_url,
state,
title,
updated_at,
url
FROM netlify.deploy.sites_deploys
WHERE site_id = '{{ site_id }}' -- required
;

INSERT examples

createSiteDeploy

No description available.

INSERT INTO netlify.deploy.sites_deploys (
data__async,
data__branch,
data__draft,
data__files,
data__framework,
data__function_schedules,
data__functions,
site_id
)
SELECT 
{{ async }},
'{{ branch }}',
{{ draft }},
'{{ files }}',
'{{ framework }}',
'{{ function_schedules }}',
'{{ functions }}',
'{{ site_id }}'
RETURNING
id,
name,
build_id,
review_id,
site_id,
user_id,
admin_url,
branch,
commit_ref,
commit_url,
context,
created_at,
deploy_ssl_url,
deploy_url,
draft,
error_message,
framework,
function_schedules,
locked,
published_at,
required,
required_functions,
review_url,
screenshot_url,
site_capabilities,
skipped,
ssl_url,
state,
title,
updated_at,
url
;

Manifest

# Description fields are for documentation purposes
- name: sites_deploys
  props:
    - name: site_id
      value: string
      description: Required parameter for the sites_deploys resource.
    - name: async
      value: boolean
    - name: branch
      value: string
    - name: draft
      value: boolean
    - name: files
      value: object
    - name: framework
      value: string
    - name: function_schedules
      value: array
    - name: functions
      value: object

Lifecycle Methods

updateSiteDeploy

OK

EXEC netlify.deploy.sites_deploys.updateSiteDeploy 
@site_id='{{ site_id }}' --required, 
@deploy_id='{{ deploy_id }}' --required 
@@json=
'{
"async": {{ async }}, 
"branch": "{{ branch }}", 
"draft": {{ draft }}, 
"files": "{{ files }}", 
"framework": "{{ framework }}", 
"function_schedules": "{{ function_schedules }}", 
"functions": "{{ functions }}"
}'
;