deploy

Lock a deploy

Locks a deploy so that subsequent deploys are built but not published. If the deploy is not the site's published deploy, locking publishes it first. When publishing is gated, the publish and lock are queued and the API responds with 202 Accepted and the deploy; poll getDeploy to follow it.

post/deploys/{deploy_id}/lock

Request

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

Path parameters

deploy_idstring required

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

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