Appearance
netlify.dns.list_records ​
List DNS records in a Netlify DNS zone
List all DNS records in a Netlify DNS zone.
Inputs:
- zone_id: Netlify DNS zone ID (required).
Outputs (terminal state_data):
- records: list of
- total: int
Plugin required: context.get_plugin("netlify") must expose .api_token.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Atomic |
| Library | App-netlify |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
zone_id | string | Yes | — | Netlify DNS zone ID |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
zone_id | string | No | — | — |
records | list | No | — | — |
total | integer | No | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_at_state | string | No | — | — |
failed_step | string | No | — | — |
failed_layer | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
States ​
| State | Initial | Terminal | Success | Auto-advance | Description |
|---|---|---|---|---|---|
pending | Yes | No | — | execute | — |
completed | No | Yes | Yes | — | — |
failed | No | Yes | No | — | — |
State Diagram ​
Transitions ​
| From | Action | To | Description |
|---|---|---|---|
pending | execute | completed | — |
* (any state) | fail | failed | — |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "netlify.dns.list_records",
"initial_data": {
"zone_id": "value"
}
}