List Casebook by external id - Cisco XDR APIs

{"type":"api","title":"List Casebook by external id","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/f4e065ff5977829c89df289df08411f83205f526/f4d118ae-a2d7-3c4b-98c4-c1e55e1f5e68","info":{"title":"Conure v2","description":"Cisco XDR Incidents and Investigation API","contact":{"name":"Cisco Security Business Group -- Advanced Threat","email":"cisco-intel-api-support@cisco.com"},"license":{"name":"All Rights Reserved","url":"https://www.cisco.com"},"version":"51-1-6bee0d16"},"security":[{"oAuth2":["integration:read","private-intel:read","profile:read","inspect:read","users:read","invite:read","enrich:read","oauth:read","response:read","global-intel:read","ao:read"]}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/conure/overview.md","uri":"incidents-and-investigations-api-guide"},"disableAuthEditing":true,"exampleAsDefault":true,"oAuth2":{"clientId":"client-546e34fc-c6bf-4951-ac69-f6d7987a7814","clientSecret":"MYw4_E_tBdFwUwrX6WFYKVD5LQrG2k7XrJ5J046wWE0s1gAKCxJ8VA","proxyEnabled":false},"meta":{"useProxy":true}},"openapi":"3.0.1","servers":[{"url":"https://conure.us.security.cisco.com/{basePath}","variables":{"basePath":{"default":""}}}],"securitySchemes":{"oAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://visibility.amp.cisco.com/iroh/oauth2/token","scopes":{"telemetry":"Collect application data for analytics","integration:read":"Manage your modules","private-intel:read":"Access Private Intelligence","admin":"Provide admin privileges","cognitive":"Cognitive Integration","profile:read":"Get your profile information","inspect:read":"Extract Observables and data from text","asset":"Access and modify your assets","event":"Read IROH Events","feedback":"Submit Customer Feedback","sse":"SSE Integration. Manage your Devices.","registry":"Manage registry entries","users:read":"Manage users of your organization","investigation":"Perform threat analysis investigation","invite:read":"Invite users into your organization","casebook":"Access and modify your casebooks","orbital":"Orbital Integration.","enrich:read":"Query your configured modules for threat intelligence","oauth:read":"Manage OAuth2 Clients","vault":"Grants access to Module Vaults","response:read":"List and execute response actions using configured modules","notification":"Receive notifications from integrations","vglobal-intel:read":"Access AMP Global Intelligence","webhook":"Manage your Webhooks","ao:read":"AO Integration."}}}}}},"spec":{"tags":["Casebook"],"summary":"List Casebook by external id","parameters":[{"name":"external-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"sort_by","in":"query","description":"Sort result on fields.\n\nThe following fields are supported:\nid, language, revision, schema_version, source, source_uri, timestamp, title, tlp\n\nFields can be combined with ',' and sort order can be\nspecified by ':asc' and ':desc'. For example:\n- id # sort by id ascending\n- id:desc # sort by id descending\n- id,language:desc # sort by id ascending, then language descending","schema":{"type":"string"}},{"name":"sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]}},{"name":"offset","in":"query","schema":{"minimum":0,"type":"integer","format":"int64"}},{"name":"limit","in":"query","schema":{"minimum":0,"type":"integer","format":"int64"}},{"name":"search_after","in":"query","allowEmptyValue":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"},"x-anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},"x-anyOf":[{"type":"array","items":{"type":"string"}},{"type":"string"}]},{"name":"fields","in":"query","allowEmptyValue":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string","enum":["schema_version","revision","source","title","source_uri","language","id","tlp","timestamp"]},"x-anyOf":[{"type":"array","items":{"type":"string","enum":["schema_version","revision","source","title","source_uri","language","id","tlp","timestamp"]}},{"type":"string"}]},"x-anyOf":[{"type":"array","items":{"type":"string","enum":["schema_version","revision","source","title","source_uri","language","id","tlp","timestamp"]}},{"type":"string"}]}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"array","items":{"required":["groups","id","schema_version","type"],"type":"object","properties":{"bundle":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"attack_patterns":{"type":"array","items":{"type":"object","properties":{}}},"assets":{"type":"array","items":{"type":"object","properties":{}}},"asset_properties":{"type":"array","items":{"type":"object","properties":{}}},"asset_mappings":{"type":"array","items":{"type":"object","properties":{}}},"casebooks":{"type":"array","items":{"type":"object","properties":{}}},"indicators":{"type":"array","items":{"type":"object","properties":{}}},"judgements":{"type":"array","items":{"type":"object","properties":{}}},"malwares":{"type":"array","items":{"type":"object","properties":{}}},"modules":{"type":"array","items":{"type":"object","properties":{}}},"relationships":{"type":"array","items":{"type":"object","properties":{}}},"sightings":{"type":"array","items":{"type":"object","properties":{}}},"verdicts":{"type":"array","items":{"type":"object","properties":{}}},"tools":{"type":"array","items":{"type":"object","properties":{}}}}},"texts":{"type":"array","items":{"required":["text","type"],"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"}}}},"observables":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"description":{"type":"string"},"short_description":{"type":"string"},"source":{"type":"string"},"source_uri":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"external_references":{"type":"array","items":{"required":["source_name"],"type":"object","properties":{"source_name":{"type":"string"},"hashes":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"description":{"type":"string"},"external_id":{"type":"string"}}}},"external_ids":{"type":"array","items":{"type":"string"}},"tlp":{"type":"string","enum":["amber","green","red","white"]},"id":{"type":"string"},"client_id":{"type":"string"},"modified":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"created":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"owner":{"type":"string","nullable":true,"x-anyOf":[{"type":"string"},{"type":"boolean"}]},"groups":{"type":"array","items":{"type":"string"}},"schema_version":{"type":"string"},"revision":{"minimum":0,"type":"integer","format":"int64"},"type":{"type":"string","enum":["casebook"]},"timestamp":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]}}}}},"application/transit+msgpack":{"schema":{"type":"array","items":{"required":["groups","id","schema_version","type"],"type":"object","properties":{"bundle":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"attack_patterns":{"type":"array","items":{"type":"object","properties":{}}},"assets":{"type":"array","items":{"type":"object","properties":{}}},"asset_properties":{"type":"array","items":{"type":"object","properties":{}}},"asset_mappings":{"type":"array","items":{"type":"object","properties":{}}},"casebooks":{"type":"array","items":{"type":"object","properties":{}}},"indicators":{"type":"array","items":{"type":"object","properties":{}}},"judgements":{"type":"array","items":{"type":"object","properties":{}}},"malwares":{"type":"array","items":{"type":"object","properties":{}}},"modules":{"type":"array","items":{"type":"object","properties":{}}},"relationships":{"type":"array","items":{"type":"object","properties":{}}},"sightings":{"type":"array","items":{"type":"object","properties":{}}},"verdicts":{"type":"array","items":{"type":"object","properties":{}}},"tools":{"type":"array","items":{"type":"object","properties":{}}}}},"texts":{"type":"array","items":{"required":["text","type"],"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"}}}},"observables":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"description":{"type":"string"},"short_description":{"type":"string"},"source":{"type":"string"},"source_uri":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"external_references":{"type":"array","items":{"required":["source_name"],"type":"object","properties":{"source_name":{"type":"string"},"hashes":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"description":{"type":"string"},"external_id":{"type":"string"}}}},"external_ids":{"type":"array","items":{"type":"string"}},"tlp":{"type":"string","enum":["amber","green","red","white"]},"id":{"type":"string"},"client_id":{"type":"string"},"modified":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"created":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"owner":{"type":"string","nullable":true,"x-anyOf":[{"type":"string"},{"type":"boolean"}]},"groups":{"type":"array","items":{"type":"string"}},"schema_version":{"type":"string"},"revision":{"minimum":0,"type":"integer","format":"int64"},"type":{"type":"string","enum":["casebook"]},"timestamp":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]}}}}},"application/transit+json":{"schema":{"type":"array","items":{"required":["groups","id","schema_version","type"],"type":"object","properties":{"bundle":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"attack_patterns":{"type":"array","items":{"type":"object","properties":{}}},"assets":{"type":"array","items":{"type":"object","properties":{}}},"asset_properties":{"type":"array","items":{"type":"object","properties":{}}},"asset_mappings":{"type":"array","items":{"type":"object","properties":{}}},"casebooks":{"type":"array","items":{"type":"object","properties":{}}},"indicators":{"type":"array","items":{"type":"object","properties":{}}},"judgements":{"type":"array","items":{"type":"object","properties":{}}},"malwares":{"type":"array","items":{"type":"object","properties":{}}},"modules":{"type":"array","items":{"type":"object","properties":{}}},"relationships":{"type":"array","items":{"type":"object","properties":{}}},"sightings":{"type":"array","items":{"type":"object","properties":{}}},"verdicts":{"type":"array","items":{"type":"object","properties":{}}},"tools":{"type":"array","items":{"type":"object","properties":{}}}}},"texts":{"type":"array","items":{"required":["text","type"],"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"}}}},"observables":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"description":{"type":"string"},"short_description":{"type":"string"},"source":{"type":"string"},"source_uri":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"external_references":{"type":"array","items":{"required":["source_name"],"type":"object","properties":{"source_name":{"type":"string"},"hashes":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"description":{"type":"string"},"external_id":{"type":"string"}}}},"external_ids":{"type":"array","items":{"type":"string"}},"tlp":{"type":"string","enum":["amber","green","red","white"]},"id":{"type":"string"},"client_id":{"type":"string"},"modified":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"created":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"owner":{"type":"string","nullable":true,"x-anyOf":[{"type":"string"},{"type":"boolean"}]},"groups":{"type":"array","items":{"type":"string"}},"schema_version":{"type":"string"},"revision":{"minimum":0,"type":"integer","format":"int64"},"type":{"type":"string","enum":["casebook"]},"timestamp":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]}}}}},"application/edn":{"schema":{"type":"array","items":{"required":["groups","id","schema_version","type"],"type":"object","properties":{"bundle":{"type":"object","properties":{"id":{"type":"string"},"description":{"type":"string"},"attack_patterns":{"type":"array","items":{"type":"object","properties":{}}},"assets":{"type":"array","items":{"type":"object","properties":{}}},"asset_properties":{"type":"array","items":{"type":"object","properties":{}}},"asset_mappings":{"type":"array","items":{"type":"object","properties":{}}},"casebooks":{"type":"array","items":{"type":"object","properties":{}}},"indicators":{"type":"array","items":{"type":"object","properties":{}}},"judgements":{"type":"array","items":{"type":"object","properties":{}}},"malwares":{"type":"array","items":{"type":"object","properties":{}}},"modules":{"type":"array","items":{"type":"object","properties":{}}},"relationships":{"type":"array","items":{"type":"object","properties":{}}},"sightings":{"type":"array","items":{"type":"object","properties":{}}},"verdicts":{"type":"array","items":{"type":"object","properties":{}}},"tools":{"type":"array","items":{"type":"object","properties":{}}}}},"texts":{"type":"array","items":{"required":["text","type"],"type":"object","properties":{"text":{"type":"string"},"type":{"type":"string"}}}},"observables":{"type":"array","items":{"required":["type","value"],"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"}}}},"description":{"type":"string"},"short_description":{"type":"string"},"source":{"type":"string"},"source_uri":{"type":"string"},"title":{"type":"string"},"language":{"type":"string"},"external_references":{"type":"array","items":{"required":["source_name"],"type":"object","properties":{"source_name":{"type":"string"},"hashes":{"type":"array","items":{"type":"string"}},"url":{"type":"string"},"description":{"type":"string"},"external_id":{"type":"string"}}}},"external_ids":{"type":"array","items":{"type":"string"}},"tlp":{"type":"string","enum":["amber","green","red","white"]},"id":{"type":"string"},"client_id":{"type":"string"},"modified":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"created":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]},"owner":{"type":"string","nullable":true,"x-anyOf":[{"type":"string"},{"type":"boolean"}]},"groups":{"type":"array","items":{"type":"string"}},"schema_version":{"type":"string"},"revision":{"minimum":0,"type":"integer","format":"int64"},"type":{"type":"string","enum":["casebook"]},"timestamp":{"type":"string","format":"date-time","x-anyOf":[{"type":"string","format":"date-time"},{"type":"string"}]}}}}}}},"400":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"object"}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"object"}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"object"}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"object"}}}}}},"401":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Unauthorized"]}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Unauthorized"]}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Unauthorized"]}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Unauthorized"]}}}}}},"403":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Forbidden"]}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Forbidden"]}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Forbidden"]}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Forbidden"]}}}}}},"404":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Found"]}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Found"]}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Found"]}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Found"]}}}}}},"405":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Method Not Allowed"]}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Method Not Allowed"]}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Method Not Allowed"]}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Method Not Allowed"]}}}}}},"406":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Acceptable"]}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Acceptable"]}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Acceptable"]}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Not Acceptable"]}}}}}},"429":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Too many requests"]}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Too many requests"]}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Too many requests"]}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["Too many requests"]}}}}}},"500":{"description":"","content":{"application/json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["exception","default exception","sql exception","JSON too large","schema","external_request"]},"exception":{"type":"string","example":"SqlException"},"data":{"type":"object","description":"Any specific error information passed by custom errors.","example":""},"uri":{"type":"string","description":"The URI the error was seen at","example":"/global/v1/incident/?/incident-summary"}}}},"application/transit+msgpack":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["exception","default exception","sql exception","JSON too large","schema","external_request"]},"exception":{"type":"string","example":"SqlException"},"data":{"type":"object","description":"Any specific error information passed by custom errors.","example":""},"uri":{"type":"string","description":"The URI the error was seen at","example":"/global/v1/incident/?/incident-summary"}}}},"application/transit+json":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["exception","default exception","sql exception","JSON too large","schema","external_request"]},"exception":{"type":"string","example":"SqlException"},"data":{"type":"object","description":"Any specific error information passed by custom errors.","example":""},"uri":{"type":"string","description":"The URI the error was seen at","example":"/global/v1/incident/?/incident-summary"}}}},"application/edn":{"schema":{"required":["message"],"type":"object","properties":{"message":{"type":"string","enum":["exception","default exception","sql exception","JSON too large","schema","external_request"]},"exception":{"type":"string","example":"SqlException"},"data":{"type":"object","description":"Any specific error information passed by custom errors.","example":""},"uri":{"type":"string","description":"The URI the error was seen at","example":"/global/v1/incident/?/incident-summary"}}}}}}},"security":[{"JWT-Bearer":[]},{"oauth2":[]},{"JWT-Bearer":[]}],"method":"get","path":"/v2/casebook/external_id/{external-id}"}}