Skip to content
Proud to collaborate with Microsoft for Startups

netlify.dns.delete_record ​

Delete a DNS record from a Netlify DNS zone

Delete a DNS record from a Netlify DNS zone.

Inputs:

  • zone_id: Netlify DNS zone ID (required).
  • record_id: Netlify DNS record ID (required).

Outputs (terminal state_data):

  • record_id: str
  • deleted: bool — always true on success

Plugin required: context.get_plugin("netlify") must expose .api_token.

Overview ​

PropertyValue
Workflow typeAtomic
LibraryApp-netlify
Version1.0

Input Schema ​

FieldTypeRequiredDefaultDescription
zone_idstringYes—Netlify DNS zone ID
record_idstringYes—Netlify DNS record ID

Output Schema ​

FieldTypeRequiredDefaultDescription
zone_idstringNo——
record_idstringNo——
deletedbooleanNo——
failure_reasonstringNo——
failure_typestringNo——
failed_actionstringNo——
failed_at_statestringNo——
failed_stepstringNo——
failed_layerstringNo——
errorstringNo——
error_typestringNo——

States ​

StateInitialTerminalSuccessAuto-advanceDescription
pendingYesNo—execute—
completedNoYesYes——
failedNoYesNo——

State Diagram ​

Transitions ​

FromActionToDescription
pendingexecutecompleted—
* (any state)failfailed—

API Usage ​

bash
POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "netlify.dns.delete_record",
  "initial_data": {
    "zone_id": "value",
    "record_id": "value"
  }
}