Get Destinations in Destination List - Cloud Security API

{"type":"api","title":"Get Destinations in Destination List","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/a7bd8f51-2771-3681-9b16-1dc760bb94cc","info":{"title":"Cisco Secure Access Destination Lists API","version":"2.0.1","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":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/destination-lists-overview.md","uri":"secure-access-api-reference-destination-lists-overview"}},"openapi":"3.0.1","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"client credential flow","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.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":{"tags":["Destinations","Secure Access"],"description":"Get destinations in a destination list.","summary":"Get Destinations in Destination List","operationId":"getDestinations","security":[{"oauthFlow":["policies.destinations:read"]}],"parameters":[{"name":"destinationListId","in":"path","schema":{"type":"integer"},"description":"The unique ID of the destination list.","required":true,"example":245,"$$ref":"#/components/parameters/destinationListId"},{"name":"page","in":"query","description":"The number of a page in the collection.","required":false,"schema":{"default":1,"type":"integer","format":"int32","minimum":1},"example":4,"$$ref":"#/components/parameters/paginationPageParam"},{"name":"limit","in":"query","description":"The number of records in the collection to return on the page.","required":false,"schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":100},"example":50,"$$ref":"#/components/parameters/paginationLimitParam"}],"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 status, metadata, and list of destinations for the destination list.","required":["status","meta","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"},"meta":{"type":"object","description":"The pagination information for the response.","properties":{"page":{"type":"integer","description":"The number of the page in the collection.","example":50},"limit":{"type":"integer","description":"The maximum number of items the server returns on the page.","example":10},"total":{"type":"integer","description":"The total number of items in the collection.","example":20}},"$$ref":"#/components/schemas/meta"},"data":{"type":"array","description":"The list of destinations in the destination list.","items":{"type":"object","required":["id","type","destination","createdAt"],"properties":{"id":{"type":"string","example":"1234567","description":"The unique ID of the destination.","$$ref":"#/components/schemas/idDestinationString"},"destination":{"type":"string","example":"cisco.com","description":"A domain, URL, or IP.","$$ref":"#/components/schemas/destination"},"type":{"type":"string","enum":["domain","url","ipv4"],"example":"domain","description":"The type of the destination.","$$ref":"#/components/schemas/type"},"comment":{"type":"string","description":"The comment about the destination.","example":"Add new destination list","$$ref":"#/components/schemas/comment"},"createdAt":{"type":"string","description":"The date and time when the destination list was created.","example":"2018-07-23 19:36:45"}},"example":{"id":"1234590","destination":"destination-two.com","type":"domain","comment":"A comment about test destination","createdAt":"2021-07-23 19:36:45"},"$$ref":"#/components/schemas/DestinationObjectWithStringId"}}},"$$ref":"#/components/schemas/PaginatedDestinationObjectResponse"},"example":{"status":{"code":200,"text":"OK"},"meta":{"page":1,"limit":100,"total":24},"data":[{"id":"1234590","destination":"cisco.com","type":"domain","comment":"A comment about test destination","createdAt":"2021-07-23 19:36:45"}]}}}},"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"}},"$$ref":"#/components/schemas/BadRequestError"}}},"$$ref":"#/components/responses/InvalidRequest"},"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"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/Unauthorized"},"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"}},"$$ref":"#/components/schemas/ForbiddenError"}}},"$$ref":"#/components/responses/Forbidden"},"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"}},"$$ref":"#/components/schemas/NotFoundError"}}},"$$ref":"#/components/responses/NotFound"},"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"}},"$$ref":"#/components/schemas/ServerError"}}},"$$ref":"#/components/responses/ServerErr"}},"__originalOperationId":"getDestinations","method":"get","path":"/destinationlists/{destinationListId}/destinations"}}