Get All REST Observable - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get All REST Observable","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/54f4ba30-7fe2-3433-bbd5-a4d458aee37e","info":{"title":"Cisco Cloud-delivered Firewall Management Center (cdFMC) API","version":"1.15.0","description":"Use the documentation to explore the endpoints the cdFMC has to offer","contact":{"name":"Cisco Firepower TAC","email":"ngfw-support@cisco.com"}},"tags":[{"name":"Analysis"},{"name":"Audit"},{"name":"Backup"},{"name":"Change Management"},{"name":"Chassis"},{"name":"Deployment"},{"name":"Device Clusters"},{"name":"Device Groups"},{"name":"Device HA Pairs"},{"name":"Devices"},{"name":"Health"},{"name":"Integration"},{"name":"Intelligence"},{"name":"License"},{"name":"Network Map"},{"name":"Object"},{"name":"Policy"},{"name":"Policy Assignments"},{"name":"Search"},{"name":"Status"},{"name":"System Configuration"},{"name":"System Information"},{"name":"Templates"},{"name":"Troubleshoot"},{"name":"Updates"},{"name":"Users"}],"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":{"deprecated":false,"description":"**API Operations on Observable objects.**","operationId":"getAllRESTObservable","parameters":[{"name":"domainUUID","description":"Domain UUID","in":"path","required":true,"schema":{"type":"string"},"$$ref":"#/components/parameters/domainUUID"},{"name":"offset","description":"Index of first item to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/offset"},{"name":"limit","description":"Number of items to return.","in":"query","required":false,"schema":{"format":"int32","type":"integer"},"$$ref":"#/components/parameters/limit"},{"name":"expanded","description":"If set to true, the GET response displays a list of objects with additional attributes.","in":"query","required":false,"schema":{"type":"boolean"},"$$ref":"#/components/parameters/expanded"}],"responses":{"200":{"content":{"application/json":{"examples":{"Example 1 : GET /fmc_tid/v1/domain/domainUUID/tid/observable ( Get all Observable instances. )":{"value":{"items":[{"links":{"self":"/fmc_tid/v1/domain/domainUUID/tid/observable/observableUUID"},"name":"Observable name 1","type":"observable"},{"links":{"self":"/fmc_tid/v1/domain/domainUUID/tid/observable/observableUUID"},"name":"Observable name 2","type":"observable"}],"links":{"self":"/fmc_tid/v1/domain/domainUUID/tid/observable"},"paging":{"count":2,"limit":2,"offset":0,"pages":1}}}},"schema":{"type":"object","properties":{"items":{"type":"array","properties":{"customProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"llfeedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/RESTFeedProperty"},"description":{"type":"string"},"effectiveProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"llfeedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/RESTFeedProperty"},"id":{"type":"string"},"indicatorCount":{"format":"int32","type":"integer"},"inheritedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"llfeedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/RESTFeedProperty"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"metadata":{"type":"object","properties":{"domain":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IDomain"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","properties":{"id":{"type":"string"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"name":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IMetadataUser"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","properties":{"reason":{"enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"type":"boolean"}},"$$ref":"#/components/schemas/IReadonly"},"timestamp":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/IMetadata"},"name":{"type":"string"},"observable":{"type":"object","properties":{"customProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"dbid":{"type":"string"},"effectiveProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"id":{"type":"string"},"indicatorCount":{"format":"int32","type":"integer"},"inheritedProperty":{"type":"object","properties":{"action":{"type":"string"},"allowlist":{"type":"boolean"},"expirationTime":{"format":"int32","type":"integer"},"publish":{"type":"boolean"},"tags":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLTags"},"ttl":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/LLFeedProperty"},"miscData":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLMiscData"},"observableType":{"type":"string"},"type":{"type":"string"},"unEncryptedDBId":{"type":"string"},"updatedAt":{"format":"int32","type":"integer"},"value":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/LLObservable"},"observableType":{"type":"string"},"type":{"type":"string"},"updatedAt":{"format":"int32","type":"integer"},"value":{"type":"string"},"version":{"type":"string"}},"$$ref":"#/components/schemas/RESTObservable"},"links":{"type":"object","description":"This defines the self referencing links for the given resource.","properties":{"parent":{"description":"Full resource URL path to reference the parent (if any) for this resource.","type":"string"},"self":{"description":"Full resource URL path to reference this particular resource.","type":"string"}},"$$ref":"#/components/schemas/ILinks"},"paging":{"type":"object","properties":{"count":{"format":"int32","type":"integer"},"limit":{"format":"int32","type":"integer"},"offset":{"format":"int32","type":"integer"},"pages":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/PagingContainer"}},"$$ref":"#/components/schemas/RESTObservableListContainer"}}},"description":"OK"},"default":{"content":{"application/json":{"schema":{"type":"object","properties":{"category":{"description":"Describes the category of the error thrown.","enum":["FRAMEWORK","OTHER","VALIDATION"],"type":"string"},"messages":{"description":"List of error messages which the response has.","items":{"type":"object","properties":{"bulkPayloadIndex":{"description":"More details about the error.","type":"string"},"code":{"description":"More details about the error.","type":"string"},"description":{"description":"More details about the error.","type":"string"},"details":{"description":"More details about the error.","type":"string"},"errorCode":{"description":"More details about the error.","type":"string"},"location":{"description":"More details about the error.","type":"string"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorMessagesContainer"},"type":"array"},"severity":{"description":"Specifies the Highest level severity among all the error messages.","enum":["ERROR","WARN"],"type":"string"}},"$$ref":"#/components/schemas/ErrorResponse"}}},"description":"Error"}},"tags":["Intelligence"],"__originalOperationId":"getAllRESTObservable","method":"get","path":"/v1/cdfmc/api/fmc_tid/v1/domain/{domainUUID}/tid/observable"}}