Create Do Not Decrypt List - Cloud Security API

{"type":"api","title":"Create Do Not Decrypt List","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/172a5f08-b5d1-3a1c-aecc-8106f0e3fd9e","info":{"title":"Cisco Secure Access Do Not Decrypt Lists API","version":"1.0.0","description":"View, create, modify, and remove the Do Not Decrypt Lists in the Secure Access organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Do Not Decrypt Lists","description":"The Do Not Decrypt List API paths and operations"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/do-not-decrypt-lists-overview.md","uri":"secure-access-api-reference-do-not-decrypt-lists-overview"}},"openapi":"3.1.0","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.donotdecryptlists:read":"Read Do Not Decrypt Lists","policies.donotdecryptlists:write":"Write Do Not Decrypt Lists"}}}}}},"spec":{"operationId":"createDoNotDecryptList","summary":"Create Do Not Decrypt List","description":"Add a Do Not Decrypt List in the organization.","requestBody":{"description":"Create the Do Not Decrypt list.","required":true,"content":{"application/json":{"schema":{"description":"The properties used to create the Do Not Decrypt list.","type":"object","required":["name","destinations"],"properties":{"name":{"description":"The name of the Do Not Decrypt list.","type":"string","maxLength":1024,"example":"No Decrypt Group","$$ref":"#/components/schemas/nameDoNotDecryptList"},"decryptExceptionCategories":{"description":"The list of IDs for the addition of the decrypt exception categories.","type":"array","items":{"type":"integer","description":"The numeric identifier of the decrypt exception category.","minimum":0,"example":12,"$$ref":"#/components/schemas/idDecryptionExceptionCategory"},"example":[12,25],"$$ref":"#/components/schemas/addDecryptExceptionCategories"},"destinations":{"description":"The destinations to include in the destination list when creating the destination list.","type":"array","maxItems":500,"items":{"type":"object","description":"The properties of the destination entry.","required":["destination"],"properties":{"destination":{"description":"The value of the destination.","type":"string","example":"example.bac.com","$$ref":"#/components/schemas/destination"},"comment":{"description":"The comment for the destination.","type":"string","minLength":1,"maxLength":255,"example":"The description for the destination.","$$ref":"#/components/schemas/comment"}}}},"applications":{"description":"The list of IDs for the applications to include when creating the application list.","type":"array","items":{"type":"integer","description":"The numeric identifier of the application.","minimum":0,"$$ref":"#/components/schemas/idApplication"},"example":[101,202],"$$ref":"#/components/schemas/addApplications"}},"$$ref":"#/components/schemas/doNotDecryptListCreate"},"example":{"name":"Finance Do Not Decrypt","decryptExceptionCategories":[12,25],"destinations":[{"destination":"example.com","comment":"Business exception"},{"destination":"10.10.10.10","comment":"Internal app IP"}],"applications":[101,202]}}},"$$ref":"#/components/requestBodies/doNotDecryptListCreateRequestBody"},"security":[{"oauthFlow":["policies.donotdecryptlists:write"]}],"tags":["Do Not Decrypt Lists","Secure Access"],"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":{"description":"The properties of the Do Not Decrypt list.","type":"object","properties":{"id":{"description":"The unique identifier of the Do Not Decrypt list.","type":"integer","example":123,"$$ref":"#/components/schemas/idDoNotDecryptList"},"organizationId":{"description":"The unique identifier of the organization.","type":"integer","example":456,"$$ref":"#/components/schemas/organizationId"},"name":{"description":"The name of the Do Not Decrypt list.","type":"string","maxLength":1024,"example":"No Decrypt Group","$$ref":"#/components/schemas/nameDoNotDecryptList"},"isDefault":{"description":"Indicates whether the list is the default Do Not Decryption list for the organization.","type":"boolean","nullable":true,"example":false,"$$ref":"#/components/schemas/isDefault"},"decryptExceptionCategories":{"description":"The list of decrypt exception categories included in the Do Not Decrypt list.","type":"array","items":{"type":"object","description":"The properties of the decrypt exception category included in the Do Not Decrypt list.","properties":{"categoryId":{"type":"integer","description":"The numeric identifier of the decrypt exception category.","minimum":0,"example":12,"$$ref":"#/components/schemas/idDecryptionExceptionCategory"},"name":{"description":"The name of the decrypt exception category.","type":"string","example":"Finance"}}}},"exceptiondomainlistId":{"description":"The unique identifier of the destination list associated with the Access policy.","type":"integer","nullable":true,"example":1001,"$$ref":"#/components/schemas/exceptiondomainlistId"},"exceptionapplicationlistId":{"description":"The unique idenitifer of the application list associated with the Access policy.","type":"integer","nullable":true,"example":2001,"$$ref":"#/components/schemas/exceptionapplicationlistId"},"bundleTypeId":{"description":"The bundle type associated with the destination list.","type":"integer","example":2},"totalDomains":{"description":"The total number of domains in the destination list associated with the Do Not Decrypt list.","type":"integer","example":5},"totalIps":{"description":"The total number of IP addresses in the destination list associated with the Do Not Decrypt list.","type":"integer","example":2},"totalApplications":{"description":"The total number of applications in the application list associated with the Do Not Decrypt list.","type":"integer","example":3},"createdAt":{"type":"string","description":"The date and time (ISO 8601-formatted timestamp) when the system created the Do Not Decrypt list.","format":"date-time","readOnly":true,"example":"2025-12-13T16:07:07.222Z","$$ref":"#/components/schemas/createdAtDoNotDecryptList"},"modifiedAt":{"type":"string","description":"The date and time (ISO 8601-formatted timestamp) when the system updated the Do Not Decrypt list.","format":"date-time","readOnly":true,"example":"2025-11-13T21:28:54+00:00","$$ref":"#/components/schemas/modifiedAtDoNotDecryptList"}},"$$ref":"#/components/schemas/doNotDecryptListData"},"example":{"id":6611405,"organizationId":8099167,"isDefault":false,"name":"DnDList - Create","decryptExceptionCategories":[{"categoryId":2,"name":"Alcohol"},{"categoryId":414,"name":"Advertisements"},{"categoryId":415,"name":"Adult"}],"exceptiondomainlistId":17989883,"exceptionapplicationlistId":15649300,"bundleTypeId":2,"createdAt":"2026-04-21 22:09:57","modifiedAt":"2026-04-21 22:09:57","totalDomains":2,"totalIps":1,"totalApplications":2}}}},"400":{"description":"Bad Request","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":"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"},"examples":{"example_bad_request":{"summary":"Bad Request Example Response","value":{"statusCode":400,"error":"Bad Request","message":"Validation Error","txId":"d479k9i2b723-abdj1-672635-45362"},"$$ref":"#/components/examples/400BadRequestExample"}}}},"$$ref":"#/components/responses/BadRequest"},"401":{"description":"Unauthorized","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":"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."},"message":{"type":"string","example":"Error"},"txId":{"type":"string","example":"a478k9i2b723"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/Unauthorized"},"403":{"description":"Forbidden","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":"Forbidden","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"The token is invalid."},"message":{"type":"string","example":"Error"},"txId":{"type":"string","example":"a478k9i2b723"}},"$$ref":"#/components/schemas/ForbiddenError"}}},"$$ref":"#/components/responses/Forbidden"},"404":{"description":"Not Found","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":"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."},"message":{"type":"string","example":"Error"},"txId":{"type":"string","example":"a478k9i2b723"}},"$$ref":"#/components/schemas/NotFoundError"}}},"$$ref":"#/components/responses/NotFound"},"500":{"description":"Internal Server Error","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":"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"}},"method":"post","path":"/doNotDecryptLists"}}