Get Data for a `Tile`, includes caching headers - Cisco XDR APIs

{"type":"api","title":"Get Data for a `Tile`, includes caching headers","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/fa9197522b1e6452b6dbfc472555dcc7ceeb71bd/45579a16-1db6-3e87-a58c-ce34f614ba52","info":{"title":"IROH-INT Dashboard Web Service","description":"All Dashboard APIs","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":"1.0.107"},"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","playbook:read"]}],"tags":[{"name":"AppLinks","description":"IROH Dashboard AppLinks"},{"name":"Tiles","description":"IROH Dashboard Tiles"}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/dashboard/overview.md","uri":"dashboard-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://visibility.amp.cisco.com"}],"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","playbook":"Access and modify your playbooks","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","global-intel:read":"Access AMP Global Intelligence","webhook":"Manage your Webhooks","ao:read":"AO Integration."}}}}}},"spec":{"tags":["Tiles"],"summary":"Get Data for a `Tile`, includes caching headers","description":"[required scopes](/iroh/doc/iroh-auth/#scopes): `integration/tile:read`\n\n","parameters":[{"name":"module-instance-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"tile-id","in":"path","required":true,"schema":{"type":"string"}},{"name":"period","in":"query","description":"Select the Data Period","allowEmptyValue":true,"schema":{"type":"string","enum":["last_7_days","last_24_hours","last_hour","last_30_days","last_90_days","last_60_days"]}},{"name":"groups","in":"query","description":"Specify the Requested Groups","allowEmptyValue":true,"style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"xdr","in":"query","description":"XDR Platform","allowEmptyValue":true,"schema":{"type":"string","enum":["1","0"]}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"required":["cache_scope","data","module","module_instance_id","module_type_id","observed_time","valid_time"],"type":"object","properties":{"valid_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_state":{"type":"string"},"module_type_id":{"type":"string"},"module":{"type":"string"},"tile_id":{"type":"string"},"cache_scope":{"type":"string","description":"","enum":["org","user","none"]},"period":{"type":"string","enum":["last_7_days","last_24_hours","last_hour","last_30_days","last_90_days","last_60_days"]},"observed_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_id":{"type":"string"},"data":{"type":"object"}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/TileData"},"errors":{"type":"array","items":{"required":["code","message","module_instance_id","module_type_id","type"],"type":"object","properties":{"module_instance_id":{"type":"string"},"module_type_id":{"type":"string"},"module_instance_state":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"type":{"type":"string","enum":["fatal","warning","error"]},"module":{"type":"string"}},"additionalProperties":false,"$$ref":"#/components/schemas/ErrorMessage"}}},"additionalProperties":false,"$$ref":"#/components/schemas/EnvelopedTileData"}},"application/x-yaml":{"schema":{"type":"object","properties":{"data":{"required":["cache_scope","data","module","module_instance_id","module_type_id","observed_time","valid_time"],"type":"object","properties":{"valid_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_state":{"type":"string"},"module_type_id":{"type":"string"},"module":{"type":"string"},"tile_id":{"type":"string"},"cache_scope":{"type":"string","description":"","enum":["org","user","none"]},"period":{"type":"string","enum":["last_7_days","last_24_hours","last_hour","last_30_days","last_90_days","last_60_days"]},"observed_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_id":{"type":"string"},"data":{"type":"object"}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/TileData"},"errors":{"type":"array","items":{"required":["code","message","module_instance_id","module_type_id","type"],"type":"object","properties":{"module_instance_id":{"type":"string"},"module_type_id":{"type":"string"},"module_instance_state":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"type":{"type":"string","enum":["fatal","warning","error"]},"module":{"type":"string"}},"additionalProperties":false,"$$ref":"#/components/schemas/ErrorMessage"}}},"additionalProperties":false,"$$ref":"#/components/schemas/EnvelopedTileData"}},"application/edn":{"schema":{"type":"object","properties":{"data":{"required":["cache_scope","data","module","module_instance_id","module_type_id","observed_time","valid_time"],"type":"object","properties":{"valid_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_state":{"type":"string"},"module_type_id":{"type":"string"},"module":{"type":"string"},"tile_id":{"type":"string"},"cache_scope":{"type":"string","description":"","enum":["org","user","none"]},"period":{"type":"string","enum":["last_7_days","last_24_hours","last_hour","last_30_days","last_90_days","last_60_days"]},"observed_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_id":{"type":"string"},"data":{"type":"object"}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/TileData"},"errors":{"type":"array","items":{"required":["code","message","module_instance_id","module_type_id","type"],"type":"object","properties":{"module_instance_id":{"type":"string"},"module_type_id":{"type":"string"},"module_instance_state":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"type":{"type":"string","enum":["fatal","warning","error"]},"module":{"type":"string"}},"additionalProperties":false,"$$ref":"#/components/schemas/ErrorMessage"}}},"additionalProperties":false,"$$ref":"#/components/schemas/EnvelopedTileData"}},"application/transit+json":{"schema":{"type":"object","properties":{"data":{"required":["cache_scope","data","module","module_instance_id","module_type_id","observed_time","valid_time"],"type":"object","properties":{"valid_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_state":{"type":"string"},"module_type_id":{"type":"string"},"module":{"type":"string"},"tile_id":{"type":"string"},"cache_scope":{"type":"string","description":"","enum":["org","user","none"]},"period":{"type":"string","enum":["last_7_days","last_24_hours","last_hour","last_30_days","last_90_days","last_60_days"]},"observed_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_id":{"type":"string"},"data":{"type":"object"}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/TileData"},"errors":{"type":"array","items":{"required":["code","message","module_instance_id","module_type_id","type"],"type":"object","properties":{"module_instance_id":{"type":"string"},"module_type_id":{"type":"string"},"module_instance_state":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"type":{"type":"string","enum":["fatal","warning","error"]},"module":{"type":"string"}},"additionalProperties":false,"$$ref":"#/components/schemas/ErrorMessage"}}},"additionalProperties":false,"$$ref":"#/components/schemas/EnvelopedTileData"}},"application/transit+msgpack":{"schema":{"type":"object","properties":{"data":{"required":["cache_scope","data","module","module_instance_id","module_type_id","observed_time","valid_time"],"type":"object","properties":{"valid_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_state":{"type":"string"},"module_type_id":{"type":"string"},"module":{"type":"string"},"tile_id":{"type":"string"},"cache_scope":{"type":"string","description":"","enum":["org","user","none"]},"period":{"type":"string","enum":["last_7_days","last_24_hours","last_hour","last_30_days","last_90_days","last_60_days"]},"observed_time":{"type":"object","properties":{"start_time":{"type":"string","description":"If not present, the valid time position of the indicator does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"},"end_time":{"type":"string","description":"If end_time is not present, then the valid time position of the object does not have an upper bound.","format":"date-time","example":"2016-01-01T01:01:01Z"}},"additionalProperties":{"type":"object"},"description":"Period of time when a cyber observation is valid.","example":{"start_time":"2016-01-01T01:01:01.000Z","end_time":"2016-01-01T01:01:01.000Z"},"$$ref":"#/components/schemas/ValidTime"},"module_instance_id":{"type":"string"},"data":{"type":"object"}},"additionalProperties":{"type":"object"},"$$ref":"#/components/schemas/TileData"},"errors":{"type":"array","items":{"required":["code","message","module_instance_id","module_type_id","type"],"type":"object","properties":{"module_instance_id":{"type":"string"},"module_type_id":{"type":"string"},"module_instance_state":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"type":{"type":"string","enum":["fatal","warning","error"]},"module":{"type":"string"}},"additionalProperties":false,"$$ref":"#/components/schemas/ErrorMessage"}}},"additionalProperties":false,"$$ref":"#/components/schemas/EnvelopedTileData"}}}}},"x-no-doc":false,"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","playbook:read"]}],"method":"get","path":"/iroh/iroh-dashboard/tiles/{module-instance-id}/{tile-id}/data"}}