Create Dns Security Profile Parcel - Cisco Catalyst SD-WAN Manager API, Release 20.18

{"type":"api","title":"Create Dns Security Profile Parcel","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/fc31da3e-c28f-36f4-997e-066dbe728245","info":{"title":"Feature Profiles - Others","description":"Feature profiles associated with UX 2.0 configuration\n\nIncludes API operations for the following:\n- Additional feature profiles\n- APIs not covered in other categories\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Configuration - Feature Profile (SDWAN)"],"description":"Create Parcel for Sig Security Policy","operationId":"CreateDnsSecurityProfileParcel","parameters":[{"name":"dnsSecurityId","in":"path","description":"Feature Profile ID","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"Sig Security Profile Parcel","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[^&\u003c\u003e! \"]+$","minLength":1,"maxLength":128,"$$ref":"#/components/schemas/CommonCommonDefs_cgFpPpNameDef"},"description":{"type":"string"},"data":{"type":"object","properties":{"localDomainBypassList":{"description":"If matchAllVpn is true and localDomainBypassEnabled is also true, this field is required","details-1":"If matchAllVpn is false, this field is required when at least one targetVpn Entry has localDomainBypassEnabled as true","details-2":"Contains refId object with a string in uuid format","type":"object","properties":{"refId":{"type":"object","properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}","$$ref":"#/components/schemas/CommonCommonDefs_uuidDef"}},"required":["optionType","value"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_refIdDef"}},"required":["refId"],"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_referenceDef"},"matchAllVpn":{"description":"If this is true, there shouldn't be a targetVpns field, if false then targetVpns field should be there","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_booleanDef"},"umbrellaDefault":{"description":"Field will only be under data field if matchAllVpn is true, otherwise field will be under targetVpns and set per entry","details-1":"always this must be false if using dnsServerIP","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_booleanDef"},"dnsServerIP":{"description":"Field will only be under data field if matchAllVpn is true, otherwise field will be under targetVpns and set per entry","details-1":"Umbrella Default must be false to have this field","details-2":"value is string that is a ipv4 address","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$","$$ref":"#/components/schemas/CommonCommonDefs_ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_oneOfDnsServerIPOptionsDef"},"localDomainBypassEnabled":{"description":"Field will only be under data field if matchAllVpn is true, otherwise field will be under targetVpns and set per entry","details-1":"If matchAllVpn is true, if there is a localDomainBypassList this field should be true, if there isn't a localDomainBypassList this should be false","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_booleanDef"},"dnsCrypt":{"description":"If matchAllVpn is false, this field is only true if at least one of the targetVpns entires contains an umbrellaDefault true","details-1":"If matchAllVpn is true, dnsCrypt can only be true if umbrellaDefault is also true","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_booleanDef"},"childOrgId":{"description":"String that is a number that corresponds to Umbrella Multi Org, can be empty if not using Umbrella Multi Org","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"description":"can be empty string","type":"string","pattern":"^[0-9]*$","$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_childOrgIdDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_oneOfChildOrgIdOptionsDef"},"targetVpns":{"description":"Will be under data field only if matchAllVpn is false, if matchAllVpn is true field should not be in payload","details-1":"Contains vpns field that specifies target vpns","details-2":"UmbrellaDefault, localDomainBypassEnabled, and uid are required fields","details-3":"dnsServerIP is optional, only required is Umbrella default is false","type":"array","minItems":1,"uniqueItems":true,"items":{"if":{"properties":{"umbrellaDefault":{"properties":{"value":{"const":false}}}}},"then":{"required":["dnsServerIP"]},"else":{"not":{"required":["dnsServerIP"]}},"type":"object","properties":{"vpns":{"oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"array","minItems":1,"uniqueItems":true,"items":{"minLength":0,"maxLength":244,"type":"string","$$ref":"#/components/schemas/CommonCommonDefs_vpnNameDef"}}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_vpnsObjDef"},"umbrellaDefault":{"description":"Field will only be under data field if matchAllVpn is true, otherwise field will be under targetVpns and set per entry","details-1":"always this must be false if using dnsServerIP","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_booleanDef"},"dnsServerIP":{"description":"Field will only be under data field if matchAllVpn is true, otherwise field will be under targetVpns and set per entry","details-1":"Umbrella Default must be false to have this field","details-2":"value is string that is an ipv4 address","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"string","pattern":"^((25[0-5]|(2[0-4]|1\\d|[1-9]|)\\d)(\\.(?!$)|$)){4}$","$$ref":"#/components/schemas/CommonCommonDefs_ipv4AddressDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_oneOfDnsServerIPOptionsDef"},"localDomainBypassEnabled":{"description":"Field will only be under data field if matchAllVpn is true, otherwise field will be under targetVpns and set per entry","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"type":"boolean","$$ref":"#/components/schemas/CommonCommonDefs_booleanDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_booleanDef"},"uid":{"description":"non empty interger string","oneOf":[{"properties":{"optionType":{"type":"string","enum":["global"],"$$ref":"#/components/schemas/CommonCommonDefs_globalOptionTypeDef"},"value":{"description":"An Integer and cannot be empty string","type":"string","pattern":"^[0-9]+$","$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_uidDef"}},"required":["optionType","value"],"additionalProperties":false}],"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_oneOfUidOptionsDef"}},"required":["vpns","umbrellaDefault","localDomainBypassEnabled","uid"],"additionalProperties":false}}},"required":["matchAllVpn","dnsCrypt"],"additionalProperties":false}},"required":["data","name","description"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelSdwanDnsSecurityDnsPostRequest_SchemaPayload"},"examples":{"targetVpnsDnsSecurity":{"value":{"name":"targetVpnsDnsSecurity","description":"Testing","data":{"localDomainBypassList":{"refId":{"optionType":"global","value":"0c4e096d-b06d-4052-93ed-70fe34fda6dc"}},"matchAllVpn":{"optionType":"global","value":false},"targetVpns":[{"vpns":{"optionType":"global","value":["1","2"]},"umbrellaDefault":{"optionType":"global","value":false},"dnsServerIP":{"optionType":"global","value":"8.8.8.8"},"uid":{"optionType":"global","value":"1667346674059"},"localDomainBypassEnabled":{"optionType":"global","value":false}}],"dnsCrypt":{"optionType":"global","value":false},"childOrgId":{"optionType":"global","value":"12334"}}},"$$ref":"#/components/examples/ProfileparcelSdwanDnsSecurityDnsPostRequest_targetVpnsDnsSecurity"},"matchAllVpnsDnsSecurity":{"value":{"name":"matchAllVpnsDnsSecurity","description":"Testing","data":{"localDomainBypassList":{"refId":{"optionType":"global","value":"0c4e096d-b06d-4052-93ed-70fe34fda6dc"}},"matchAllVpn":{"optionType":"global","value":true},"umbrellaDefault":{"optionType":"global","value":false},"dnsServerIP":{"optionType":"global","value":"8.8.8.8"},"localDomainBypassEnabled":{"optionType":"global","value":true},"dnsCrypt":{"optionType":"global","value":false},"childOrgId":{"optionType":"global","value":"12334"}}},"$$ref":"#/components/examples/ProfileparcelSdwanDnsSecurityDnsPostRequest_matchAllVpnsDnsSecurity"}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}"}},"required":["id"],"x-metadata":{"minVManageVersion":"20.15.1"},"additionalProperties":false,"$$ref":"#/components/schemas/ProfileparcelCommonPostResponse_SchemaPayload"},"examples":{"example_1":{"value":{"id":"24C3EF06-c09a-DeFa-Ab26-a1cc4Ef0D51A"},"$$ref":"#/components/examples/ProfileparcelCommonPostResponse_example_1"}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"Feature Profile \u003e Dns Security \u003e Dns Policy-write","method":"post","path":"/v1/feature-profile/sdwan/dns-security/{dnsSecurityId}/dns"}}