{"type":"api","title":"Update Destination List","meta":{"id":"/apps/pubhub/media/Meraki-Dashboard-API-v1-Documentation/426c8f7edc2cc0036fbe8fd4ce0d3ec2eda7fa14/de857a95-32cb-3f3c-8d64-0bf8514993f9","info":{"title":"Meraki Integrated API for Secure Connect","description":"The Cisco Meraki Integrated API for Secure Connect is a modern REST API based on the OpenAPI specification.\n ---\n\n [API Documentation](https://meraki.io/api)\n\n [Meraki Homepage](https://www.meraki.com)\n","version":"1.8.0","contact":{"name":"Meraki Developer Community","url":"https://meraki.io/community"}},"security":[{"meraki_api_key":[]},{"bearerAuth":[]}],"tags":[{"name":"Reports"},{"name":"Activity"},{"name":"Top Categories"},{"name":"Organization Requests by Timerange and Category"},{"name":"Total Requests"},{"name":"Summary"},{"name":"Applications"},{"name":"Deployments"},{"name":"Data Center"},{"name":"Network Devices"},{"name":"Organization Tunnel"},{"name":"Policy"},{"name":"Firewall Applications"},{"name":"Policies"},{"name":"Destination Lists"},{"name":"Destinations"}],"x-parser-conf":{"theme":"meraki","expand":2,"exampleAsDefault":true,"groupBy":{"$remoteModule":"config/group_api_tag.js"}},"openapi":"3.0.0","servers":[{"url":"https://api.meraki.com/{basePath}","variables":{"basePath":{"default":"api/secureConnect/v1"}}}],"securitySchemes":{"meraki_api_key":{"type":"apiKey","name":"X-Cisco-Meraki-API-Key","in":"header"},"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header"}}},"spec":{"tags":["Policies","Destination Lists"],"description":"Update a destination list in your organization.","summary":"Update Destination List","operationId":"updateDestinationLists","security":[{"meraki_api_key":[]}],"parameters":[{"name":"organizationId","in":"path","description":"Organization ID associated with this resource.","required":true,"schema":{"type":"integer"}},{"name":"destinationListId","in":"path","schema":{"type":"integer"},"description":"The unique ID of the destination list.","required":true,"example":245}],"requestBody":{"description":"Update a destination list.","required":true,"content":{"application/json":{"schema":{"type":"object","description":"Update the name of the destination list.","required":["name"],"properties":{"name":{"type":"string","example":"Global Allow list","description":"The name of the destination list."}}},"example":{"name":"Updated name of destination list"}}}},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json"},"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"}},"content":{"application/json":{"schema":{"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"}},"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."},"organizationId":{"type":"integer","example":2345678,"description":"The organization ID."},"access":{"type":"string","enum":["allow","block"],"example":"allow","description":"The type of access for the destination list."},"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."},"name":{"type":"string","example":"Global Allow list","description":"The name of the destination list."},"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`."},"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}}}}},"example":{"status":{"code":200,"text":"OK"},"data":{"id":2477857,"organizationId":22429759,"access":"allow","isGlobal":false,"name":"New name of destination list","thirdpartyCategoryId":0,"createdAt":1532628019,"modifiedAt":1532628019,"isMspDefault":false,"markedForDeletion":false,"bundleTypeId":2,"meta":{"destinationCount":1}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","description":"Bad Request","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Bad Request","description":"A brief description of the error"},"message":{"type":"string","example":"Validation Error"},"txId":{"type":"string","example":"d479k9i2b723"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","description":"Unauthorized","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"The authorization header is missing or the token is unauthorized."},"txId":{"type":"string","example":"a478k9i2b723"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","description":"Forbidden","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"The token is invalid."},"txId":{"type":"string","example":"a478k9i2b723"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","description":"Not Found","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A resource specified in the URL was not found."},"txId":{"type":"string","example":"a478k9i2b723"}}}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","description":"Internal Server Error","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"The server can not process the request."},"message":{"type":"string","example":"An internal server error occurred"},"txId":{"type":"string","example":"l477k9i2b893"}}}}}}},"__originalOperationId":"updateDestinationLists","method":"patch","path":"/organizations/{organizationId}/policy/destinationLists/{destinationListId}"}}