{"type":"api","title":"Handler returning all Targets","meta":{"id":"/apps/pubhub/media/cisco-xdr-api-docs/fa9197522b1e6452b6dbfc472555dcc7ceeb71bd/08b61137-18a5-31e0-99cb-97776678702a","info":{"title":"REST API.","version":"1.0.0"},"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"]}],"x-parser-conf":{"serverConfig":"select","overview":{"markdownPath":"reference/automation/overview.md","uri":"automation-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://automate.us.security.cisco.com/{basePath}","variables":{"basePath":{"default":"api"}}}],"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":["Targets"],"summary":"Handler returning all Targets.","description":"Allowed Role(s): admin, user, sat","operationId":"getAllTargetQueryParams","parameters":[{"name":"is_internal","in":"query","description":"internal Schemas.","schema":{"type":"boolean","x-go-name":"IsInternal"},"x-go-name":"IsInternal"},{"name":"types","in":"query","description":"Types of Targets, comma separated list if getting more than one type.","schema":{"type":"string","x-go-name":"Types"},"x-go-name":"Types"}],"responses":{"200":{"description":"The TargetDefinitonAllResponse response model\n\n# This is used for returning a response of Targets as body","content":{"application/json":{"schema":{"type":"array","items":{"title":"TargetDefinitionGetAllResponse ...","type":"object","properties":{"adapter_id":{"type":"string","x-go-name":"AdapterID"},"base_type":{"type":"string","x-go-name":"BaseType"},"created_by":{"type":"string","x-go-name":"CreatedBy"},"created_on":{"type":"string","format":"date-time","x-go-name":"CreatedOn"},"def_access_meta":{"title":"DefAccessMeta ...","type":"object","properties":{"is_integration":{"type":"boolean","x-go-name":"IsIntegration"},"is_internal":{"type":"boolean","x-go-name":"IsInternal"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/DefAccessMeta"},"id":{"type":"string","x-go-name":"DefinitionID"},"metadata":{"type":"object","properties":{"sx_module_info":{"type":"object","properties":{"api_name":{"type":"string","x-go-name":"APIName"},"bypass_iroh_proxy":{"type":"boolean","x-go-name":"ByPassIROHProxy"},"external_id":{"type":"string","x-go-name":"ExternalID"},"flags":{"type":"array","items":{"type":"string"},"x-go-name":"Flags"},"id":{"type":"string","x-go-name":"ModuleUniqueID"},"integrated_module":{"type":"boolean","x-go-name":"IntegratedModule"},"module_instance_id":{"type":"string","x-go-name":"ModuleInstanceID"},"module_type":{"type":"string","x-go-name":"ModuleType"},"module_type_id":{"type":"string","x-go-name":"ModuleTypeID"},"openapi_spec":{"type":"string","x-go-name":"APISpec"},"revision":{"type":"string","x-go-name":"Revision"},"target_url":{"type":"string","x-go-name":"TargetURL"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/ModuleInfo"}},"description":"TargetMetadata maintains SecureX module data info","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/TargetMetadata"},"name":{"type":"string","x-go-name":"Name"},"owner":{"type":"string","x-go-name":"Owner"},"properties":{"type":"object","additionalProperties":{"type":"object","properties":{}},"x-go-name":"Properties"},"schema_id":{"type":"string","x-go-name":"ViewSchemaID"},"status":{"title":"Status ...","type":"object","properties":{"details":{"type":"object","properties":{"code":{"type":"string","x-go-name":"Code"},"description":{"type":"string","x-go-name":"Description"},"message":{"type":"string","x-go-name":"Message"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/StatusDetails"},"prev_state":{"type":"string","description":"DefinitionState","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/State"},"state":{"type":"string","description":"DefinitionState","x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/State"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/lib-data/models","$$ref":"#/components/schemas/Status"},"type":{"type":"string","x-go-name":"Type"},"unique_name":{"type":"string","x-go-name":"UniqueName"},"updated_by":{"type":"string","x-go-name":"UpdatedBy"},"updated_on":{"type":"string","format":"date-time","x-go-name":"UpdatedOn"},"valid":{"type":"boolean","x-go-name":"Valid"}},"x-go-package":"bitbucket-eng-sjc1.cisco.com/bitbucket/nextg/be-console/models","$$ref":"#/components/schemas/TargetDefinitionGetAllResponse"}}}}},"400":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}},"403":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}},"404":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}},"500":{"description":"A Error is a swagger response to represent error","headers":{"code":{"schema":{"type":"integer","format":"int64"}},"description":{"schema":{"type":"string"}},"message":{"schema":{"type":"string"}}},"content":{}}},"__originalOperationId":"getAllTargetQueryParams","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":"/v1/targets"}}