{"type":"model","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":{"type":"array","description":"The list of DNS Forwarders in the organization.","items":{"type":"object","description":"The properties of the DNS Forwarder.","required":["originId"],"properties":{"originId":{"type":"integer","description":"The unique identifier of the DNS Forwarder.","example":2456,"$$ref":"#/components/schemas/originId"},"state":{"type":"object","description":"The properties of the state for the DNS Forwarder.","example":{}},"settings":{"type":"object","description":"The internal and external IP addresses for the DNS Forwarder.","additionalProperties":false,"properties":{"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"},"externalIP":{"type":"string","description":"The external IP address of the DNS Forwarder.","example":"10.211.204.133"}},"example":{"internalIPs":["1.1.1.1"],"externalIP":"10.211.204.133"},"$$ref":"#/components/schemas/settings"},"siteId":{"type":"integer","description":"The ID of the Site in Secure Access.","example":6689200,"$$ref":"#/components/schemas/siteId"},"health":{"type":"string","description":"The label that describes the health of the DNS Forwarder.","example":"unknown"},"type":{"type":"string","description":"The type of the DNS Forwarder.","enum":["network_dns_forwarder","virtual_appliance","connector","domain_controller"],"example":"network_dns_forwarder","$$ref":"#/components/schemas/type"},"createdAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the system created the DNS Forwarder.","example":"2025-02-13T16:07:07.222Z","$$ref":"#/components/schemas/createdAt"},"modifiedAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the system modified the DNS Forwarder.","example":"2025-02-13T16:07:07.222Z","$$ref":"#/components/schemas/modifiedAt"},"stateUpdatedAt":{"type":"string","format":"date-time","description":"The date and time (ISO8601 timestamp) when the system updated the state of the DNS Forwarder.","example":"2025-02-13T16:07:07.222Z","$$ref":"#/components/schemas/stateUpdatedAt"},"name":{"type":"string","description":"The descriptive name of the DNS Forwarder.","example":"label-1","$$ref":"#/components/schemas/name"},"isUpgradable":{"type":"boolean","description":"Specifies whether the DNS Forwarder can receive software upgrades.","example":false}},"example":{"originId":124566,"state":{},"settings":{"internalIPs":["1.1.1.1"],"externalIP":"10.211.204.133"},"siteId":6689200,"health":"unknown","type":"network_dns_forwarder","createdAt":"2025-02-09T22:18:26.625Z","modifiedAt":"2025-02-09T22:18:26.625Z","stateUpdatedAt":"2025-02-13T16:07:07.222Z","name":"dns-forwarder-one","isUpgradable":false},"$$ref":"#/components/schemas/DNSForwarderObject"},"example":[{"originId":124566,"type":"network_dns_forwarder","name":"dns-forwarder-one","internalIPs":["1.1.1.1"],"siteId":6689200,"health":"unknown","createdAt":"2025-02-09T22:18:26.625Z","modifiedAt":"2025-02-09T22:18:26.625Z"}],"$$ref":"#/components/schemas/DNSForwarderListResponse","title":"DNSForwarderListResponse"}}