Get All SIURL List - Security Cloud Control Firewall Manager API Documentation - Cisco DevNet

{"type":"api","title":"Get All SIURL List","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":"**Get the list of all security intelligence url lists.**","operationId":"getAllSIURLList","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_config/v1/domain/DomainUUID/object/siurllists?expanded=false&limit=2 ( Get all paginated URL Lists with expanded set to false and limit set to 2 )":{"value":{"items":[{"id":"SIURLListId","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId"},"name":"Descendant-Blocklists-for-URL - Global","type":"SIURLList"},{"id":"SIURLListId","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId"},"name":"Descendant-Do-Not-Block-Lists-for-URL - Global","type":"SIURLList"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=0&limit=2"},"paging":{"count":27,"limit":2,"next":["/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=2&limit=2","/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=4&limit=2","/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=6&limit=2","/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=false&offset=8&limit=2"],"offset":0,"pages":14}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/siurllists?limit=2&expanded=true ( Get all paginated URL Lists with limit set to 2 )":{"value":{"items":[{"fileName":"fmc_ip_list1.txt","id":"SIURLListId","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId"},"metadata":{"domain":{"id":"domainUUID","name":"Global","type":"Domain"},"entryCount":4,"lastUser":{"id":"adminUUID","name":"admin","type":"user"},"listUpdateTime":1605518859,"readOnly":{"state":false},"timestamp":1605518859},"name":"Descendant-Blocklists-for-URL - Global","type":"SIURLList"},{"fileName":"fmc_ip_list2.txt","id":"SIURLListId","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/siurllists/SIURLListId"},"metadata":{"domain":{"id":"domainUUID","name":"Global","type":"Domain"},"entryCount":12,"lastUser":{"id":"adminUUID","name":"admin","type":"user"},"listUpdateTime":1605518859,"readOnly":{"state":false},"timestamp":1605518859},"name":"Descendant-Do-Not-Block-Lists-for-URL - Global","type":"SIURLList"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=0&limit=2"},"paging":{"count":27,"limit":2,"next":["/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=2&limit=2","/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=4&limit=2","/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=6&limit=2","/fmc_config/v1/domain/DomainUUID/object/siurllists?expanded=true&offset=8&limit=2"],"offset":0,"pages":14}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Object representing a user-specified third-party list.","properties":{"description":{"description":"Description of the Security Intelligence list.","type":"string"},"fileName":{"description":"Name of the custom Security Intelligence URL list file as specified by user.","type":"string"},"id":{"description":"Unique identifier representing the Security Intelligence URL list.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","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"},"listType":{"format":"int32","type":"integer"},"metadata":{"description":"Object representing metadata attributes for the SIURLList object.","type":"object","properties":{"domain":{"type":"object","description":"The details about the domain.","properties":{"id":{"description":"Unique UUID of this domain","type":"string"},"links":{"description":"Links to the domain resource URLs.","type":"object","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":{"description":"Name of the domain.","type":"string"},"type":{"description":"Domain type definition (fixed).","type":"string"},"uuid":{"type":"string"}},"$$ref":"#/components/schemas/Domain"},"entryCount":{"format":"int32","type":"integer"},"isLocked":{"type":"boolean"},"lastUser":{"type":"object","description":"This object defines details about the user.","properties":{"id":{"description":"The unique UUID of the user","type":"string"},"links":{"description":"Contains the self referencing links to this resource","type":"object","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":{"description":"Name of the user.","type":"string"},"type":{"description":"The user type (fixed).","type":"string"}},"$$ref":"#/components/schemas/MetadataUser"},"listUpdateTime":{"format":"int32","type":"integer"},"matches":{"items":{"type":"string"},"type":"array"},"readOnly":{"type":"object","description":"Defines the read only conditions if the referenced resource is read only.","properties":{"reason":{"description":"Reason the resource is read only - SYSTEM (if it is system defined), RBAC (if user RBAC permissions make it read only) or DOMAIN (if resource is read only in current domain).","enum":["RBAC","SYSTEM","DOMAIN"],"type":"string"},"state":{"description":"True if this resource us read only and false otherwise.","type":"boolean"}},"$$ref":"#/components/schemas/ReadOnly"},"timestamp":{"format":"int32","type":"integer"},"validEntries":{"items":{"type":"string"},"type":"array"}},"$$ref":"#/components/schemas/SIListMetadata"},"name":{"description":"Name of the Security Intelligence URL List object.","type":"string"},"overridable":{"type":"boolean"},"overrides":{"type":"object","description":"Defines the override details for this object.","properties":{"parent":{"description":"Link to the parent/global resource which is overriden.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","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":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"},"target":{"description":"The device or the domain target on which this override is enabled.","type":"object","properties":{"id":{"description":"Unique identifier representing resource.","type":"string"},"links":{"description":"Object containing links to this resource.","type":"object","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":{"description":"User chosen resource name.","type":"string"},"type":{"description":"Response object associated with resource.","type":"string"}},"$$ref":"#/components/schemas/IReference"}},"$$ref":"#/components/schemas/IOverride"},"type":{"description":"Type must be SIURLList.","type":"string"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/SIURLList"},"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/SIURLListListContainer"}}},"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":["Object"],"__originalOperationId":"getAllSIURLList","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/siurllists"}}