For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Request featuresContact support
DocsAPI ReferenceGraphQLIntegrationsDeveloper ToolsMNO and Resellers
DocsAPI ReferenceGraphQLIntegrationsDeveloper ToolsMNO and Resellers
  • Docs
    • Event types
    • Tariff
  • API Reference
        • GETGet default DNS config for an organization
        • POSTCreate default DNS config for an organization
        • DELDelete default DNS config for an organization
        • PATCHUpdate default DNS config for an organization
LogoLogo
Request featuresContact support
API ReferenceService Lookups and Configuration

Get default DNS config for an organization

GET
https://cdn.emnify.net/api/v1/organisation/:organisation_id/default_dns
GET
/api/v1/organisation/:organisation_id/default_dns
$curl https://cdn.emnify.net/api/v1/organisation/123/default_dns \
>     -H "Authorization: Bearer <token>"
1{
2  "organisation_id": 123,
3  "dns_id": 111,
4  "allow_overwrite": true,
5  "dns": {
6    "primary_dns": "8.8.8.8",
7    "secondary_dns": "8.8.4.4",
8    "ip_address_version": 4
9  }
10}
Retrieves the default DNS configuration for the specified organization. If the organization has its own default DNS config, it is returned directly. If not, the config is resolved by walking up the organization hierarchy (inheritance). When the config is inherited from a parent organization, the response includes the `inherited_from_organisation_id` field. The `dns_id` references a DNS configuration object that can be retrieved or created via the [`/api/v1/dns`](/developers/api/service-lookups-and-configuration/dns-get) endpoints.
Was this page helpful?
Previous

Delete an organization's inclusive volume

Next

Create default DNS config for an organization

Built with

Retrieves the default DNS configuration for the specified organization.

If the organization has its own default DNS config, it is returned directly. If not, the config is resolved by walking up the organization hierarchy (inheritance). When the config is inherited from a parent organization, the response includes the inherited_from_organisation_id field.

The dns_id references a DNS configuration object that can be retrieved or created via the /api/v1/dns endpoints.

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the POST request to /api/v1/authenticate.

Path parameters

organisation_idlongRequired
Organization ID

Response

Default DNS configuration retrieved successfully.
organisation_idlong
The organization ID for which the default DNS was requested.
dns_idinteger

ID of the DNS configuration object. Refers to a DNS config from /api/v1/dns.

allow_overwriteboolean
Whether child organizations are allowed to set their own default DNS config.
dnsobject
The resolved DNS configuration details.
inherited_from_organisation_idlong
Present only when the config is inherited from a parent organization. Indicates the source organization ID.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error