{"type":"model","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/297a6839-be3e-3bfc-9d4b-144fce0d7214","info":{"title":"Cisco Umbrella Destination Lists API","version":"2.0.0","description":"Create and manage destination lists and destinations.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Destination Lists","description":"Destination Lists"},{"name":"Destinations","description":"Destinations"},{"name":"Umbrella"}],"x-parser-conf":{"overview":{"markdownPath":"reference/policies/destination-lists-overview.md","uri":"umbrella-api-reference-destination-lists-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.umbrella.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.umbrella.com/auth/v2/token","scopes":{"policies.destinationLists:write":"Write policies destination lists","policies.destinationLists:read":"Read policies destination lists","policies.destinations:write":"Write policies destinations","policies.destinations:read":"Read policies destinations"}}}}}},"spec":{"type":"object","description":"The status and properties of the destination lists.","required":["status","data"],"properties":{"status":{"type":"object","required":["code","text"],"description":"The status information for the response.","properties":{"code":{"type":"integer","description":"The HTTP status code of the response.","example":200},"text":{"type":"string","description":"The HTTP message that describes the response.","example":"OK"}},"example":{"code":200,"text":"OK"},"$$ref":"#/components/schemas/status"},"data":{"type":"object","required":["id","organizationId","access","isGlobal","name","thirdpartyCategoryId","createdAt","modifiedAt","isMspDefault","markedForDeletion"],"properties":{"id":{"type":"integer","example":1234567,"description":"The unique ID of the destination list.","$$ref":"#/components/schemas/id"},"organizationId":{"type":"integer","example":2345678,"description":"The organization ID.","$$ref":"#/components/schemas/organizationId"},"access":{"type":"string","enum":["allow","block"],"example":"allow","description":"The type of access for the destination list.","$$ref":"#/components/schemas/access"},"isGlobal":{"type":"boolean","example":false,"description":"Specifies whether the destination list is a global destination list.\nThere is only one default `allow` destination list and one default `block` destination list for an organization.","$$ref":"#/components/schemas/isGlobal"},"name":{"type":"string","example":"Global Allow list","description":"The name of the destination list.","$$ref":"#/components/schemas/name"},"thirdpartyCategoryId":{"type":"integer","example":1,"description":"The third-party category ID of the destination list."},"createdAt":{"type":"integer","example":1490206249,"description":"The date and time when the destination list was created."},"modifiedAt":{"type":"integer","example":1520476127,"description":"The date and time when the destination list was modified."},"isMspDefault":{"type":"boolean","description":"Specifies whether MSP is the default.","example":false},"markedForDeletion":{"type":"boolean","example":false,"description":"Specifies whether the destination list is marked for deletion."},"bundleTypeId":{"type":"integer","default":1,"enum":[1,2,4],"example":4,"description":"The type of the destination list in the policy.\nSet `1` for DNS, `2` for web, and `4` for SAML Bypass.\nIf the field is not specified, the default value is `1`.","$$ref":"#/components/schemas/bundleTypeId"},"meta":{"type":"object","description":"The total number of each type of destination in the destination list. The fields in the `meta` object are optional.","properties":{"destinationCount":{"type":"integer","example":5,"description":"The total number of destinations in a destination list."},"domainCount":{"type":"integer","example":5,"description":"The total number of domains in a destination list.\nDomains are part of the total number of destinations in a destination list."},"urlCount":{"type":"integer","example":0,"description":"The total number of URLs in a destination list.\nUrls are part of the total number of destinations in a destination list."},"ipv4Count":{"type":"integer","example":0,"description":"The total number of IP addresses in a destination list.\nIP addresses are part of the total number of destinations in a destination list."},"applicationCount":{"type":"integer","example":0,"description":"The total number of applications in a destination list.\nApplications are part of the total number of destinations in a destination list."}},"example":{"domainCount":1,"urlCount":0,"ipv4Count":1,"destinationCount":2,"applicationCount":0}}},"example":{"id":1234567,"organizationId":2345678,"access":"allow","isGlobal":true,"name":"Global Allow List","thirdpartyCategoryId":0,"createdAt":1490206249,"modifiedAt":1520476127,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":2,"meta":{"destinationCount":5,"domainCount":5,"urlCount":0,"ipv4Count":0,"applicationCount":0}},"$$ref":"#/components/schemas/DestinationListObject"}},"$$ref":"#/components/schemas/DestinationListResponse","title":"DestinationListResponse"}}