Create DNS Forwarder - Cloud Security API

{"type":"api","title":"Create DNS Forwarder","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/5515d56b-46da-3bb9-8a27-2d7266a91ce5","info":{"title":"Cisco Secure Access DNS Forwarders API","version":"1.0.0","description":"Manage the Secure Access virtual appliances and network entities, which are deployed in the organization as conditional DNS forwarders.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"DNS Forwarders"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/deployments/dns-forwarders-overview.md","uri":"secure-access-api-reference-dns-forwarders-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"deployments/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"Client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"deployments.dnsforwarders:write":"Write deployments DNS forwarders","deployments.dnsforwarders:read":"Read deployments DNS forwarders"}}}}}},"spec":{"description":"Add a DNS Forwarder in the organization.","summary":"Create DNS Forwarder","operationId":"createDnsForwarder","tags":["DNS Forwarders","Secure Access"],"security":[{"oauthFlow":["deployments.dnsforwarders:write"]}],"requestBody":{"description":"Create the DNS Forwarder.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"The properties of the DNS Forwarder.","required":["name","type","internalIPs"],"properties":{"name":{"type":"string","description":"The descriptive name of the DNS Forwarder.","example":"label-1","$$ref":"#/components/schemas/name"},"type":{"type":"string","description":"The type of the DNS Forwarder.","enum":["network_dns_forwarder"],"example":"network_dns_forwarder","$$ref":"#/components/schemas/typeNetworkDNSForwarder"},"internalIPs":{"type":"array","description":"The list of private IP addresses for the DNS forwarder.","items":{"type":"string","description":"The private IP address of the DNS forwarder.","example":"1.1.1.1"},"example":["1.1.1.1"],"$$ref":"#/components/schemas/internalIPs"}},"example":{"name":"dns forwarder one","type":"network_dns_forwarder","internalIPs":["1.1.1.1"]},"$$ref":"#/components/schemas/DNSForwarderObjectCreate"},"example":{"name":"dns forwarder one","type":"network_dns_forwarder","internalIPs":["1.1.1.1"]}}},"$$ref":"#/components/requestBodies/DNSForwarderCreateRequest"},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The properties of the DNS forwarder.","properties":{"type":{"type":"string","description":"The type of the DNS Forwarder.","enum":["network_dns_forwarder"],"example":"network_dns_forwarder","$$ref":"#/components/schemas/typeNetworkDNSForwarder"},"originId":{"type":"integer","description":"The unique identifier of the DNS Forwarder.","example":2456,"$$ref":"#/components/schemas/originId"}},"example":{"type":"network_dns_forwarder","originId":647132588},"$$ref":"#/components/schemas/DNSForwarderCreateResponse"},"example":{"asset_id":646404381,"type":"network_dns_forwarder"}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Validation Error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Validation error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal error","description":"A brief description of the error"},"message":{"type":"string","description":"Detailed error message"}}}}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"createDnsForwarder","method":"post","path":"/dnsForwarders"}}