deploy

Update a deploy

Changed on
put/sites/{site_id}/deploys/{deploy_id}

Request

  • Base URL
    https://api.netlify.com/api/v1
  • URL
    https://api.netlify.com/api/v1/sites/{site_id}/deploys/{deploy_id}
  • Auth
    OAuth 2
    Implicit: https://app.netlify.com/authorize

Path parameters

site_idstring required
deploy_idstring required

Query parameters

commit_refstring

Request body

filesobject

A hash mapping file paths to SHA1 digests of the file contents.

zipstring binary

A zip file containing the site files to deploy. Alternative to 'files'. To use this field, set Content-Type to 'application/json' and include the zip content here. Alternatively, you can set Content-Type to 'application/zip' and send the zip as the raw request body (not as JSON).

draftboolean
asyncboolean
functionsobject
edge_functionsobject

A hash mapping edge-function bundle formats to the code_sha of each bundle. The response's required_edge_functions lists which of these still need to be uploaded.

functions_configobject
branchstring
frameworkstring
framework_versionstring

Response

OK

idstring
site_idstring
user_idstring
build_idstring
statestring
namestring
urlstring
ssl_urlstring
admin_urlstring
deploy_urlstring
deploy_ssl_urlstring
screenshot_urlstring
review_idnumber
draftboolean
requiredstring[]
required_functionsstring[]
required_edge_functionsstring[]

An array of code_shas for the edge-function bundles that need to be uploaded to complete the deploy.

required_serverstring[]

The SHA256 digest of the deploy's Netlify Server bundle, when it still needs to be uploaded to complete the deploy. A deploy has at most one server, so this holds either nothing or a single digest.

error_messagestring
branchstring
commit_refstring
commit_urlstring
skippedboolean
created_atstring dateTime
updated_atstring dateTime
published_atstring dateTime
titlestring
contextstring
lockedboolean
review_urlstring
frameworkstring
skew_protection_tokenstring
functions_regionstring

The functions region for this deploy as an airport code.

Changes