Netlify tools
The 11 Netlify operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List sitesGETLists the sites (projects, in the Netlify UI) the account can reach, with id, name, url, custom_domain, the published deploy and build settings. The id or the domain of a site is the site_id that the other tools take. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Update sitePATCHChanges the name or the domains of a site and returns it. Only the fields sent change. The DNS of a new custom domain still has to point to Netlify.
- List site deploysGETLists the deploys of a site, newest first, with id, state, branch, context, error_message and the deploy URL. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Get deployGETReturns a deploy, with state (ready when it is live or ready to publish, error when the build failed), error_message, branch, commit_ref, published_at and the deploy URL.
- Create site buildPOSTStarts a build of a site from its connected repository and returns the build, with deploy_id to follow in Get deploy. Without branch it builds production; another branch makes a branch deploy. It waits in line when the team has no free build capacity.
- Cancel deployPOSTStops a deploy that is still queued or building, and returns it.
- Restore site deployPOSTPublishes an earlier deploy again and makes it the live version of the site, which is how a rollback works. Returns the deploy.
- List site formsGETLists the forms Netlify detected in a site, with id, name, fields and submission_count. The submissions themselves come from List form submissions.
- List site submissionsGETLists the submissions of every form of a site, newest first, with name, email, the data of each field and created_at. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- List form submissionsGETLists the submissions of one form, newest first, with name, email, the data of each field and created_at. Paginate with page and per_page: a page with fewer items than per_page is the last one.
- Delete submissionDELETEDeletes a form submission for good, such as spam or a test. It cannot be undone.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
