Get Application Lists - Cloud Security API

{"type":"api","title":"Get Application Lists","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/1416204d-a3eb-3b4d-a1fc-4d01aedf1895","info":{"title":"Cisco Secure Access Rules, Rule Settings, and Application Lists APIs","version":"1.0.1","description":"Create and manage the access rules, rule settings, and application lists.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Access Rules","description":"The API endpoints that manage the access rules for the organization."},{"name":"Rule Settings and Defaults","description":"The API endpoints that manage the rule settings and defaults on the access rules."},{"name":"Application Lists","description":"The API endpoints that manage the internet application lists for the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/policy-rules-overview.md","uri":"secure-access-api-reference-policy-rules-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.applicationlists:write":"Write policies application lists","policies.applicationlists:read":"Read policies application lists","policies.settings:write":"Write policies global rule settings","policies.settings:read":"Read policies global rule settings","policies.rules:read":"Read policies access rules","policies.rules:write":"Write policies access rules"}}}}}},"spec":{"tags":["Application Lists","Secure Access"],"summary":"Get Application Lists","description":"Get the application lists and the number of application lists for the organization.","operationId":"getApplicationLists","security":[{"oauthFlow":["policies.applicationlists:read"]}],"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 application lists and number of application lists in the organization.","properties":{"count":{"type":"integer","description":"The number of application lists in the organization.","example":250},"result":{"type":"array","description":"The application lists in the organization.","items":{"type":"object","description":"The properties of the application list.","properties":{"applicationListId":{"type":"integer","description":"The ID of the application list.","example":1235,"$$ref":"#/components/schemas/applicationListId"},"applicationListName":{"type":"string","description":"The descriptive label for the application list.","example":"Application lists on branch_1.","$$ref":"#/components/schemas/applicationListName"},"isDefault":{"type":"boolean","description":"Specifies whether the application list is the default application list.","example":false,"$$ref":"#/components/schemas/isDefault"},"createdAt":{"type":"string","description":"The date and time that the application list was created.","format":"date-time","readOnly":true,"example":"2021-12-13T16:07:07.222Z","$$ref":"#/components/schemas/createdAtApplicationList"},"modifiedAt":{"type":"string","description":"The date and time that the application list was modified.","format":"date-time","readOnly":true,"example":"2023-11-13T21:28:54+00:00","$$ref":"#/components/schemas/modifiedAtApplicationList"}},"example":{"modifiedAt":"2024-04-04T19:22:53+00:00","applicationListName":"New Application List- empty","organizationId":8094936,"createdAt":"2024-04-04T19:22:53+00:00","applicationListId":19457,"isDefault":false}},"example":[{"modifiedAt":"2024-04-04T19:22:53+00:00","applicationListName":"New Application List- empty","organizationId":8094936,"createdAt":"2024-04-04T19:22:53+00:00","applicationListId":19457,"isDefault":false}]}},"example":{"count":250,"results":[{"modifiedAt":"2024-04-04T19:22:53+00:00","applicationListName":"New Application List- empty","organizationId":8094936,"createdAt":"2024-04-04T19:22:53+00:00","applicationListId":19457,"isDefault":false},{"modifiedAt":"2024-04-04T19:23:17+00:00","applicationListName":"New Application List empty","organizationId":8094936,"createdAt":"2024-04-04T19:23:17+00:00","applicationListId":19458,"isDefault":false},{"modifiedAt":"2023-04-10T12:17:03+00:00","applicationListName":"this is a custom list","organizationId":8094936,"createdAt":"2023-03-28T20:32:05+00:00","applicationListId":14148,"isDefault":false}]},"$$ref":"#/components/schemas/ApplicationLists"},"example":{"count":3,"results":[{"modifiedAt":"2024-04-04T19:22:53+00:00","applicationListName":"New Application List- empty","organizationId":8094936,"createdAt":"2024-04-04T19:22:53+00:00","applicationListId":19457,"isDefault":false},{"applicationCategoryIds":[],"modifiedAt":"2024-04-04T19:23:17+00:00","applicationListName":"New Application List empty","organizationId":8094936,"createdAt":"2024-04-04T19:23:17+00:00","applicationListId":19458,"isDefault":false},{"modifiedAt":"2023-04-10T12:17:03+00:00","applicationListName":"this is a custom list","organizationId":8094936,"createdAt\"":"2023-03-28T20:32:05+00:00","applicationListId":14148,"isDefault":false}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"The organization ID is a numeric value."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/400Error"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Authorization token is invalid."},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/401Error"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Authorized"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/403Error"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/404Error"},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"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"}},"$$ref":"#/components/responses/500Error"}},"__originalOperationId":"getApplicationLists","method":"get","path":"/applicationLists"}}