mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-18 16:36:35 +00:00
54 lines
4.7 KiB
Plaintext
54 lines
4.7 KiB
Plaintext
---
|
|
id: update-dns-settings
|
|
title: "Update DNS Settings"
|
|
description: "Updates a DNS settings object"
|
|
sidebar_label: "Update DNS Settings"
|
|
hide_title: true
|
|
hide_table_of_contents: true
|
|
api: {"description":"Updates a DNS settings object","tags":["DNS"],"security":[{"BearerAuth":[]},{"TokenAuth":[]}],"requestBody":{"description":"A DNS settings object","content":{"application/json":{"schema":{"type":"object","properties":{"disabled_management_groups":{"description":"Groups whose DNS management is disabled","type":"array","items":{"type":"string"}}},"required":["disabled_management_groups"],"title":"DNSSettings"}}}},"responses":{"200":{"description":"A JSON Object of DNS Setting","content":{"application/json":{"schema":{"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":"put","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"}},"jsonRequestBodyExample":{"disabled_management_groups":["string"]},"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":"Update DNS Settings","description":{"content":"Updates a DNS settings object","type":"text/plain"},"url":{"path":["api","dns","settings"],"host":["{{baseUrl}}"],"query":[],"variable":[]},"header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"method":"PUT","body":{"mode":"raw","raw":"\"\"","options":{"raw":{"language":"json"}}},"auth":{"type":"bearer","bearer":[{"type":"any","value":"<Bearer Token>","key":"token"}]}}}
|
|
sidebar_class_name: "put 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";
|
|
|
|
## Update DNS Settings
|
|
|
|
|
|
|
|
Updates a DNS settings object
|
|
|
|
<MimeTabs><TabItem label={"application/json"} value={"application/json-schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Request Body</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}><div style={{"marginTop":"1rem","marginBottom":"1rem"}}>
|
|
|
|
A DNS settings object
|
|
|
|
</div></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"disabled_management_groups"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Groups whose DNS management is disabled","type":"array","items":{"type":"string"}}}></SchemaItem></ul></details></TabItem></MimeTabs><div><ApiTabs><TabItem label={"200"} value={"200"}><div>
|
|
|
|
A JSON Object of DNS Setting
|
|
|
|
</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"disabled_management_groups"} required={true} schemaName={"string[]"} qualifierMessage={undefined} schema={{"description":"Groups whose DNS management is disabled","type":"array","items":{"type":"string"}}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n \"disabled_management_groups\": [\n \"string\"\n ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
|
|
|
|
Bad Request
|
|
|
|
</div><div></div></TabItem><TabItem label={"401"} value={"401"}><div>
|
|
|
|
Requires authentication
|
|
|
|
</div><div></div></TabItem><TabItem label={"403"} value={"403"}><div>
|
|
|
|
Forbidden
|
|
|
|
</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>
|
|
|
|
Internal Server Error
|
|
|
|
</div><div></div></TabItem></ApiTabs></div>
|
|
|