deploys

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

Overview

Name	deploys
Type	Resource
Id	netlify.deploy.deploys

Fields

The following fields are returned by SELECT queries:

getDeploy

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
getDeploy	select	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

SELECT examples

getDeploy

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.deploys
WHERE deploy_id = '{{ deploy_id }}' -- required
;