Skip to content
Proud to collaborate with Microsoft for Startups

netlify.dns.create_record ​

Create a DNS record in a Netlify DNS zone

Create a DNS record in a Netlify-managed DNS zone.

Inputs:

  • zone_id: Netlify DNS zone ID (required).
  • record_type: A | AAAA | CNAME | MX | TXT | NS | SPF (required).
  • hostname: Record hostname, e.g. api.example.com (required).
  • value: Record value (required).
  • ttl: TTL in seconds (optional, default: 3600).

Outputs (terminal state_data):

  • record_id: str — Netlify DNS record ID

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_typestringYes—DNS record type: A, CNAME, TXT, etc.
hostnamestringYes—Record hostname, e.g. api.example.com
valuestringYes—Record value
ttlintegerNo—TTL in seconds (default: 3600)

Output Schema ​

FieldTypeRequiredDefaultDescription
zone_idstringNo——
record_typestringNo——
hostnamestringNo——
valuestringNo——
ttlintegerNo——
record_idstringNo——
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.create_record",
  "initial_data": {
    "zone_id": "value",
    "record_type": "value",
    "hostname": "value",
    "value": "value"
  }
}