Netlify

Netlify module for RobinPath.

Package: @robinpath/netlify | Category: Devops | Type: Integration

Authentication

netlify.setCredentials "your-credentials"

Call this once at the start of your script before using any other function. Credentials persist for the duration of the script execution.

Use Cases

Use the netlify module when you need to:

• listSites -- Use netlify.listSites to perform this operation
• getSite -- Use netlify.getSite to perform this operation
• createSite -- Use netlify.createSite to perform this operation
• updateSite -- Use netlify.updateSite to perform this operation
• deleteSite -- Use netlify.deleteSite to perform this operation

Quick Reference

Function	Description	Returns
setCredentials	Configure netlify credentials.	object
listSites	listSites	object
getSite	getSite	object
createSite	createSite	object
updateSite	updateSite	object
deleteSite	deleteSite	object
listDeploys	listDeploys	object
getDeploy	getDeploy	object
lockDeploy	lockDeploy	object
unlockDeploy	unlockDeploy	object
restoreDeploy	restoreDeploy	object
cancelDeploy	cancelDeploy	object
listForms	listForms	object
listFormSubmissions	listFormSubmissions	object
deleteFormSubmission	deleteFormSubmission	object
listDnsZones	listDnsZones	object
getDnsZone	getDnsZone	object
createDnsRecord	createDnsRecord	object
listBuildHooks	listBuildHooks	object
triggerBuild	triggerBuild	object
listSiteDomains	listSiteDomains	object

Functions

setCredentials

Configure netlify credentials.

Module: netlify | Returns: object -- API response.

netlify.setCredentials

Parameter	Type	Required	Description
accessToken	string	Yes	accessToken

---

listSites

listSites

Module: netlify | Returns: object -- API response.

netlify.listSites

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getSite

getSite

Module: netlify | Returns: object -- API response.

netlify.getSite

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createSite

createSite

Module: netlify | Returns: object -- API response.

netlify.createSite

Parameter	Type	Required	Description
input	string	No	Input parameter

---

updateSite

updateSite

Module: netlify | Returns: object -- API response.

netlify.updateSite

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteSite

deleteSite

Module: netlify | Returns: object -- API response.

netlify.deleteSite

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDeploys

listDeploys

Module: netlify | Returns: object -- API response.

netlify.listDeploys

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getDeploy

getDeploy

Module: netlify | Returns: object -- API response.

netlify.getDeploy

Parameter	Type	Required	Description
input	string	No	Input parameter

---

lockDeploy

lockDeploy

Module: netlify | Returns: object -- API response.

netlify.lockDeploy

Parameter	Type	Required	Description
input	string	No	Input parameter

---

unlockDeploy

unlockDeploy

Module: netlify | Returns: object -- API response.

netlify.unlockDeploy

Parameter	Type	Required	Description
input	string	No	Input parameter

---

restoreDeploy

restoreDeploy

Module: netlify | Returns: object -- API response.

netlify.restoreDeploy

Parameter	Type	Required	Description
input	string	No	Input parameter

---

cancelDeploy

cancelDeploy

Module: netlify | Returns: object -- API response.

netlify.cancelDeploy

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listForms

listForms

Module: netlify | Returns: object -- API response.

netlify.listForms

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listFormSubmissions

listFormSubmissions

Module: netlify | Returns: object -- API response.

netlify.listFormSubmissions

Parameter	Type	Required	Description
input	string	No	Input parameter

---

deleteFormSubmission

deleteFormSubmission

Module: netlify | Returns: object -- API response.

netlify.deleteFormSubmission

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listDnsZones

listDnsZones

Module: netlify | Returns: object -- API response.

netlify.listDnsZones

Parameter	Type	Required	Description
input	string	No	Input parameter

---

getDnsZone

getDnsZone

Module: netlify | Returns: object -- API response.

netlify.getDnsZone

Parameter	Type	Required	Description
input	string	No	Input parameter

---

createDnsRecord

createDnsRecord

Module: netlify | Returns: object -- API response.

netlify.createDnsRecord

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listBuildHooks

listBuildHooks

Module: netlify | Returns: object -- API response.

netlify.listBuildHooks

Parameter	Type	Required	Description
input	string	No	Input parameter

---

triggerBuild

triggerBuild

Module: netlify | Returns: object -- API response.

netlify.triggerBuild

Parameter	Type	Required	Description
input	string	No	Input parameter

---

listSiteDomains

listSiteDomains

Module: netlify | Returns: object -- API response.

netlify.listSiteDomains

Parameter	Type	Required	Description
input	string	No	Input parameter

---

Error Handling

All functions throw on failure. Common errors:

Error	Cause
Netlify API error (${res.status}): ${t}	Check the error message for details
netlify.setCredentials requires accessToken.	Check the error message for details
netlify.updateSite requires an ID.	Check the error message for details
netlify.deleteSite requires an ID.	Check the error message for details
netlify.lockDeploy requires an ID.	Check the error message for details
netlify.unlockDeploy requires an ID.	Check the error message for details
netlify.restoreDeploy requires an ID.	Check the error message for details
netlify.cancelDeploy requires an ID.	Check the error message for details

@desc "List sites and validate result"
do
  set $result as netlify.listSites
  if $result != null
    print "Success"
  else
    print "No result"
  end
enddo

Recipes

1. List and iterate Sites

Retrieve all items and loop through them.

@desc "Setup authentication"
do
  netlify.setCredentials $token
enddo

@desc "List sites and iterate results"
do
  set $result as netlify.listSites
  each $item in $result
    print $item
  end
enddo

2. Create a new item with createSite

Create a new resource and capture the result.

@desc "Setup authentication"
do
  netlify.setCredentials $token
enddo

@desc "Create site"
do
  set $result as netlify.createSite
  print "Created: " + $result
enddo

3. Create and update workflow

Create an item and then update it.

@desc "Setup authentication"
do
  netlify.setCredentials $token
enddo

@desc "Create site and update site"
do
  set $created as netlify.createSite
  # Update the created item
  netlify.updateSite
enddo

4. Check before creating

List existing items and only create if needed.

@desc "Setup authentication"
do
  netlify.setCredentials $token
enddo

@desc "List sites and create site"
do
  set $existing as netlify.listSites
  if $existing == null
    netlify.createSite
    print "Item created"
  else
    print "Item already exists"
  end
enddo

5. Multi-step Netlify workflow

Chain multiple netlify operations together.

@desc "Setup authentication"
do
  netlify.setCredentials $token
enddo

@desc "List sites, get site, and more"
do
  set $r_listSites as netlify.listSites
  set $r_getSite as netlify.getSite
  set $r_createSite as netlify.createSite
  print "All operations complete"
enddo

6. Safe listSites with validation

Check results before proceeding.

@desc "Setup authentication"
do
  netlify.setCredentials $token
enddo

@desc "List sites and validate result"
do
  set $result as netlify.listSites
  if $result != null
    print "Success: " + $result
  else
    print "Operation returned no data"
  end
enddo

Related Modules

• docker -- Docker module for complementary functionality
• git -- Git module for complementary functionality
• github -- GitHub module for complementary functionality
• gitlab -- GitLab module for complementary functionality
• vercel -- Vercel module for complementary functionality