Get IPS Profile - Cloud Security API

{"type":"api","title":"Get IPS Profile","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/5a7c6e45-6e48-3ded-9e12-6072294c5775","info":{"title":"Cisco Secure Access IPS Profiles API","version":"1.0.0","description":"Get the Intrusion Prevention System (IPS) profiles and IPS signatures in the Secure Access organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"IPS Profiles","description":"The IPS profiles with signatures."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/ips-profiles-overview.md","uri":"secure-access-api-reference-ips-profiles-overview"}},"openapi":"3.0.1","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.ipsconfig:read":"Read Intrusion Prevention System profiles","policies.ipsconfig:write":"Write Intrusion Prevention System profiles"}}}}}},"spec":{"summary":"Get IPS Profile","operationId":"getIpsProfile","description":"Get the IPS profile in the organization.","parameters":[{"in":"path","name":"id","description":"The ID of the IPS profile.","required":true,"schema":{"type":"integer"},"$$ref":"#/components/parameters/ipsSignatureProfileId"}],"tags":["IPS Profiles","Secure Access"],"security":[{"oauthFlow":["policies.ipsconfig: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 properties of the IPS profile and signature lists.","properties":{"id":{"type":"integer","readOnly":true,"description":"The ID of the IPS profile.","example":56,"$$ref":"#/components/schemas/ipsSignatureProfileId"},"organizationId":{"type":"integer","description":"The ID of the organization.","example":2345678,"$$ref":"#/components/schemas/organizationId"},"applyTo":{"type":"string","description":"The type of the system-defined IPS profile used as a template to create a custom IPS profile.","enum":["max-detect-ips","security-ips","balanced-ips","connectivity-ips"],"example":"max-detect-ips","$$ref":"#/components/schemas/applyTo"},"name":{"type":"string","description":"The name of the IPS Signature profile.\n`name` is a sequence of 1—50 characters where the string does not contain the percent (%) or asterisk (*) characters.","example":"IPS profile one","$$ref":"#/components/schemas/ipsSignatureProfileName"},"systemMode":{"type":"string","enum":["prevention","detection"],"description":"The mode of the IPS set to either `prevention` or `detection`.","example":"prevention","$$ref":"#/components/schemas/systemMode"},"blockList":{"type":"array","description":"The list of signatures represented in the GID-SID format that the system will update to BLOCK.\nFor example, move or override signature 1-28423 from WARN to BLOCK.","items":{"type":"string","example":"1-28423"},"example":["1-28423"],"$$ref":"#/components/schemas/blockList"},"warnList":{"type":"array","description":"The list of signatures represented in the GID-SID format that the system will update to WARN.\nFor example, move or override signature 1-28423 from BLOCK to WARN.","items":{"type":"string","example":"1-28423"},"example":["1-28423"],"$$ref":"#/components/schemas/warnList"},"ignoreList":{"type":"array","description":"The list of signatures represented in the GID-SID format that the system will update to IGNORE.\nFor example, move or override signature 1-28423 from BLOCK to IGNORE.","items":{"type":"string","example":"1-28423"},"example":["1-28423"],"$$ref":"#/components/schemas/ignoreList"},"isDefault":{"type":"boolean","readOnly":true,"description":"Specifies whether the IPS profile is a default profile. Default profiles are read only.","example":true},"actionCounts":{"type":"object","description":"The properties of the counts for each type of action.","properties":{"block":{"type":"integer","description":"The number of BLOCK actions.","example":345,"readOnly":true},"warn":{"type":"integer","description":"The number of WARN actions.","example":3455,"readOnly":true},"ignore":{"type":"integer","description":"The number of IGNORE actions.","example":38455,"readOnly":true}},"example":{"block":25,"warn":25,"ignore":4},"$$ref":"#/components/schemas/actionCounts"},"hitCountIntervalId":{"type":"integer","description":"The ID of the interval where the system records the IPS signature hit count.","example":3},"hitCountResetAt":{"type":"string","format":"date-time","nullable":true,"example":"2018-06-13T16:07:07.222Z","description":"The date and time when the system reset the signature hit count for the IPS profile."},"createdAt":{"type":"string","format":"date-time","readOnly":true,"example":"2018-06-13T16:07:07.222Z","description":"The date and time when the system created the IPS profile."},"modifiedAt":{"type":"string","readOnly":true,"format":"date-time","description":"The date and time when the system updated the IPS profile.","example":"2018-06-13T16:07:07.222Z"}},"example":{"id":378249,"organizationId":8053787,"applyTo":"connectivity-ips","name":"custom ips profile one","systemMode":"prevention","blockList":["1-28423"],"warnList":["1-28424"],"ignoreList":["1-28425"],"isDefault":false,"actionCounts":{"block":481,"warn":111,"ignore":50910},"hitCountIntervalId":3,"hitCountResetAt":"2018-06-13T16:07:07.222Z","createdAt":"2025-06-11T20:39:30Z","modifiedAt":"2025-06-11T20:39:30Z"},"$$ref":"#/components/schemas/ipsSignatureProfile"}}}},"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":{"description":"Bad Request","type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Bad Request"}},"$$ref":"#/components/schemas/badRequest"}}},"$$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":{"description":"Unauthorized","type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Unauthorized"}},"$$ref":"#/components/schemas/unauthorized"}}},"$$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":{"description":"Forbidden","type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Forbidden"}},"$$ref":"#/components/schemas/forbidden"}}},"$$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":{"description":"Not Found","type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Not Found"}},"$$ref":"#/components/schemas/notFound"}}},"$$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":{"description":"Internal Server Error","type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"}},"$$ref":"#/components/schemas/serverError"}}},"$$ref":"#/components/responses/serverError"}},"__originalOperationId":"getIpsProfile","method":"get","path":"/ipsSignatureProfiles/{id}"}}