View as Markdown
IONOS Hosting Services icon

IONOS Hosting Services ACTION

Get DNS Zone

Get a single DNS zone including its records array. This is also the only way to list a zone's DNS records (there is no dedicated list-records endpoint) - use the optional nameFilter and recordType filters to narrow the returned records, and read each record's id for use in the record-level actions. Returns an object like {"id":"4ab3a7e2-1234-5678-abcd-ef0123456789","name":"example.com","type":"NATIVE","records":[{"id":"90d81ac0-3a30-44d4-95a5-12959effa6ee","name":"www.example.com","type":"A","content":"5.6.7.8","ttl":3600}]}. Run List DNS Zones first to obtain a zone ID. See the documentation.
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's IONOS Hosting Services account once, then configure and run Get DNS Zone from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "ionos_hosting_services-get-dns-zone",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    ionos_hosting_services: { authProvisionId: "apn_xxxxxxx" },
    zoneId: "Zone ID",
    nameFilter: "Name Filter",
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get DNS Zone inputs
Property Type Description
zoneId Zone ID string
The DNS zone ID (UUID format, e.g. 4ab3a7e2-1234-5678-abcd-ef0123456789). Run List DNS Zones to retrieve available zones; use the id field from each returned object — not the name field (e.g. example.com) or the type field.
Required
nameFilter Name Filter string
Optional filter to return only records whose name contains this string (case-insensitive). Example: kramer will match records named kramer.example.com.
Optional
recordType Record Type string[]
Optional array of record types to filter by (e.g. ["A", "TXT"]). Serialized as a comma-separated string when sent to the API.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
ionos_hosting_services-get-dns-zone
Version
0.0.2
App
IONOS Hosting Services
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes