--- id: retrieve-dns-settings title: "Retrieve DNS Settings" description: "Returns a DNS settings object" sidebar_label: "Retrieve DNS Settings" hide_title: true hide_table_of_contents: true api: {"description":"Returns a DNS settings object","tags":["DNS"],"security":[{"BearerAuth":[]},{"TokenAuth":[]}],"responses":{"200":{"description":"A JSON Object of DNS Setting","content":{"application/json":{"schema":{"items":{"type":"object","properties":{"disabled_management_groups":{"description":"Groups whose DNS management is disabled","type":"array","items":{"type":"string"}}},"required":["disabled_management_groups"],"title":"DNSSettings"}}}}},"400":{"description":"Bad Request","content":{}},"401":{"description":"Requires authentication","content":{}},"403":{"description":"Forbidden","content":{}},"500":{"description":"Internal Server Error","content":{}}},"method":"get","path":"/api/dns/settings","servers":[{"url":"https://netbird.io","description":"Default server"}],"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"},"TokenAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Prefix the value with \\\"Token\\\" to indicate the custom authorization type"}},"info":{"title":"NetBird REST API","description":"API to manipulate groups, rules, policies and retrieve information about peers and users","version":"0.0.1"},"postman":{"name":"Retrieve DNS Settings","description":{"content":"Returns a DNS settings object","type":"text/plain"},"url":{"path":["api","dns","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET","auth":{"type":"bearer","bearer":[{"type":"any","value":"","key":"token"}]}}} sidebar_class_name: "get api-method" info_path: api/netbird-rest-api custom_edit_url: null --- import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem"; ## Retrieve DNS Settings Returns a DNS settings object
A JSON Object of DNS Setting
Schema
  • Array [
  • ]
Bad Request
Requires authentication
Forbidden
Internal Server Error