Netlify
Purpose
Collects one Netlify team's sites, deploys, serverless functions, dev servers, agent runners, databases, DNS zones and records, TLS certificates, environment variables, forms, snippets, build and notification hooks, deploy keys, and members.
tip
Secret fields below accept either an AWS Secrets Manager ARN or a value pasted directly into SubImage's managed vault. See Secrets for details.
Required Fields
| Field | Secret? | Description |
|---|---|---|
netlify_token |
Yes | Netlify personal access token for a member of the team to sync |
netlify_account_slug |
No | Slug of the Netlify team to sync. One team per sync. |
Optional Fields
| Field | Description |
|---|---|
netlify_base_url |
API endpoint. Defaults to https://api.netlify.com/api/v1. |
Setup Steps
- Open User settings > Applications > Personal access tokens in Netlify.
- Create a new token from an account whose role in the team is as low as the sync allows.
- Copy your team slug from the team URL
https://app.netlify.com/teams/<slug>/. - In SubImage, enter the token in
netlify_tokenand the slug innetlify_account_slug. - Save the module and run a sync.
Notes
- The sync is read-only; it only issues
GETrequests. - A Netlify personal access token carries the full permissions of the user who created it, so treat it as a privileged credential.
- Netlify invalidates every token created before a password reset. After a reset, create a new token and update the module configuration.
- Some resources depend on the team's plan. Shared environment variables, dev servers, and agent runners are only returned on plans that include them. Database branches and snapshots are only fetched for sites that have a Netlify DB, and TLS certificates only once a site has a custom domain.
Troubleshooting
- Netlify team not found: the configured slug is not visible to the token. Confirm the token's user is a member of that team, and take the slug from the team URL rather than the team display name.
- 401 Unauthorized: the token is invalid, was revoked, or was invalidated by a password reset. Create a new token and update the module configuration.
- 403 Forbidden: the token's user lacks a team role that can read the requested resource, or the team's plan does not include it.