Search - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Search","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Search for devices, services, managers, objects and policies across the Security Cloud Control tenant.","operationId":"search","parameters":[{"description":"This can be any non-empty string, and represents the search criteria. Spaces are allowed, but must be URL encoded.","in":"query","name":"q","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"cdFmcResult":{"description":"Results from the Cloud-delivered FMC devices, objects or policies that match the search term.","properties":{"devices":{"description":"Devices that match the search term.","items":{"properties":{"link":{"description":"A URL to access the entity in Cloud-delivered FMC.","example":"https://edge.us.cdo.cisco.com/api/platform/public-api/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"},"name":{"description":"The name of the entity in Cloud-delivered FMC.","example":"my-example-entity","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the entity in Cloud-delivered FMC.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/CdFmcObject"},"type":"array"},"objects":{"description":"Objects that match the search term.","items":{"properties":{"link":{"description":"A URL to access the entity in Cloud-delivered FMC.","example":"https://edge.us.cdo.cisco.com/api/platform/public-api/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"},"name":{"description":"The name of the entity in Cloud-delivered FMC.","example":"my-example-entity","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the entity in Cloud-delivered FMC.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/CdFmcObject"},"type":"array"},"policies":{"description":"Policies that match the search term.","items":{"properties":{"link":{"description":"A URL to access the entity in Cloud-delivered FMC.","example":"https://edge.us.cdo.cisco.com/api/platform/public-api/v1/cdfmc/api/fmc_config/v1/domain/e276abec-e0f2-11e3-8169-6d9ed49b625f/devices/devicerecords/7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"},"name":{"description":"The name of the entity in Cloud-delivered FMC.","example":"my-example-entity","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the entity in Cloud-delivered FMC.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/CdFmcObject"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/CdFmcResult"},"inventory":{"description":"Results from the Security Cloud Control inventory that match the search term.","properties":{"devices":{"description":"Devices that match the search term.","items":{"properties":{"address":{"description":"The address of the entity.","example":"my-example-device.example.com:443","type":"string"},"matchingConfigurations":{"description":"(ASAs only) Parts of the ASA device configuration that match the search term.","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the entity. Device names are unique in Security Cloud Control.","example":"my-example-entity","type":"string"},"type":{"enum":["ASA","CDFMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FIREPOWER","ONPREM_FMC_NGIPS","FDM_MANAGED_FTD","IOS","ISR","SSH_DEVICE","GENERIC_DEVICE","MERAKI_MX","CLOUD_DNG","SFCN","SFCN_DNG","SFCN_STS","ONPREM_FMC","CDFMC","AWS_VPC","AZURE_VNET","DUO_ADMIN_PANEL","UMBRELLA_ORGANIZATION"],"type":"string","$$ref":"#/components/schemas/EntityType","description":"The type of the entity.","example":"ASA"},"uid":{"description":"The unique identifier, represented as a UUID, of the entity in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/Entity"},"type":"array"},"managers":{"description":"Device Managers that match the search term.","items":{"properties":{"address":{"description":"The address of the entity.","example":"my-example-device.example.com:443","type":"string"},"matchingConfigurations":{"description":"(ASAs only) Parts of the ASA device configuration that match the search term.","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the entity. Device names are unique in Security Cloud Control.","example":"my-example-entity","type":"string"},"type":{"enum":["ASA","CDFMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FIREPOWER","ONPREM_FMC_NGIPS","FDM_MANAGED_FTD","IOS","ISR","SSH_DEVICE","GENERIC_DEVICE","MERAKI_MX","CLOUD_DNG","SFCN","SFCN_DNG","SFCN_STS","ONPREM_FMC","CDFMC","AWS_VPC","AZURE_VNET","DUO_ADMIN_PANEL","UMBRELLA_ORGANIZATION"],"type":"string","$$ref":"#/components/schemas/EntityType","description":"The type of the entity.","example":"ASA"},"uid":{"description":"The unique identifier, represented as a UUID, of the entity in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/Entity"},"type":"array"},"services":{"description":"Cloud Services that match the search term.","items":{"properties":{"address":{"description":"The address of the entity.","example":"my-example-device.example.com:443","type":"string"},"matchingConfigurations":{"description":"(ASAs only) Parts of the ASA device configuration that match the search term.","items":{"type":"string"},"type":"array"},"name":{"description":"The name of the entity. Device names are unique in Security Cloud Control.","example":"my-example-entity","type":"string"},"type":{"enum":["ASA","CDFMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FTD","ONPREM_FMC_MANAGED_FIREPOWER","ONPREM_FMC_NGIPS","FDM_MANAGED_FTD","IOS","ISR","SSH_DEVICE","GENERIC_DEVICE","MERAKI_MX","CLOUD_DNG","SFCN","SFCN_DNG","SFCN_STS","ONPREM_FMC","CDFMC","AWS_VPC","AZURE_VNET","DUO_ADMIN_PANEL","UMBRELLA_ORGANIZATION"],"type":"string","$$ref":"#/components/schemas/EntityType","description":"The type of the entity.","example":"ASA"},"uid":{"description":"The unique identifier, represented as a UUID, of the entity in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/Entity"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/Inventory"},"objects":{"description":"Results from the Security Cloud Control objects that match the search term.","items":{},"type":"array"},"policies":{"description":"Results from the Security Cloud Control policies that match the search term.","items":{"properties":{"name":{"description":"The name of the policy in Security Cloud Control.","example":"my-example-policy","type":"string"},"uid":{"description":"The unique identifier, represented as a UUID, of the policy in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"}},"type":"object","$$ref":"#/components/schemas/Policy"},"type":"array"}},"type":"object","$$ref":"#/components/schemas/GlobalSearchResult"}}},"description":"Search Result"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"405":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Method not allowed.","$$ref":"#/components/responses/http405MethodNotAllowed"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Search","tags":["Search"],"__originalOperationId":"search","method":"get","path":"/v1/search"}}