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

{"type":"api","title":"Get All Custom 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 custom Security Intelligence URL Lists.**","operationId":"getAllCustomSIURLList","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/customsiurllists?expanded=false&limit=2 ( Get all paginated security intelligence URL lists with expanded set to false and limit set to 2 )":{"value":{"items":[{"id":"039c5244-9568-11ed-b64f-8b48d9209b4f","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f"},"name":"ABBA","type":"CustomSIURLListObject"},{"id":"883029aa-9535-11ed-ab58-e346d9209b4f","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/customsiurllists/883029aa-9535-11ed-ab58-e346d9209b4f"},"name":"AABB","type":"CustomSIURLListObject"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=false&offset=0&limit=2"},"paging":{"count":6,"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"],"offset":0,"pages":3}}},"Example 2 : GET /fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=true&limit=2 ( Get all paginated security intelligence URL lists with expanded set to true and limit set to 2 )":{"value":{"items":[{"fileName":"file1","id":"039c5244-9568-11ed-b64f-8b48d9209b4f","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/customsiurllists/039c5244-9568-11ed-b64f-8b48d9209b4f"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"entryCount":36,"lastUser":{"id":"68d03c42-d9bd-11dc-89f2-b7961d42c462","name":"admin","type":"user"},"readOnly":{"state":false},"timestamp":1673851723},"name":"ABBA","type":"CustomSIURLListObject"},{"fileName":"file2","id":"883029aa-9535-11ed-ab58-e346d9209b4f","links":{"self":"/fmc_config/v1/domain/DomainUUID/object/customsiurllists/883029aa-9535-11ed-ab58-e346d9209b4f"},"metadata":{"domain":{"id":"e276abec-e0f2-11e3-8169-6d9ed49b625f","name":"Global","type":"Domain"},"entryCount":36,"lastUser":{"id":"68d03c42-d9bd-11dc-89f2-b7961d42c462","name":"admin","type":"user"},"readOnly":{"state":false},"timestamp":1673738838},"name":"AABB","type":"CustomSIURLListObject"}],"links":{"self":"/fmc_config/v1/domain/DomainUUID/object/customsiurllists?expanded=true&offset=0&limit=2"},"paging":{"count":6,"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"],"offset":0,"pages":3}}}},"schema":{"type":"object","properties":{"items":{"type":"array","description":"Object representing a static list of URL addresses uploaded by the user","properties":{"description":{"type":"string"},"fileName":{"description":"Name of the custom Security Intelligence URL List file as specified by user.","type":"string"},"files":{"items":{"type":"object","properties":{"attrib":{"type":"string"},"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"},"path":{"type":"string"},"type":{"type":"string"}},"$$ref":"#/components/schemas/IFileWrapper"},"type":"array"},"filesMap":{"type":"object","additionalProperties":{"type":"string"},"$$ref":"#/components/schemas/LLFilesMap"},"id":{"description":"Unique identifier of custom Security Intelligence URL List object.","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"},"metadata":{"description":"Object representing metadata attributes for the CustomSIURLList 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"},"invalidEntryCount":{"format":"int32","type":"integer"},"invalidLines":{"type":"string"},"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"},"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"},"totalEntryCount":{"format":"int32","type":"integer"}},"$$ref":"#/components/schemas/CustomSIListMetadata"},"name":{"description":"Name of the custom Security Intelligence URL List object.","type":"string"},"type":{"description":"Must be CustomSIURLListObject","type":"string"},"validateOnly":{"description":"Validate the uploaded list file only. By default is set to false.","type":"boolean"},"version":{"description":"Version number of the response object.","type":"string"}},"$$ref":"#/components/schemas/CustomSIURLList"},"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/CustomSIURLListListContainer"}}},"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":"getAllCustomSIURLList","method":"get","path":"/v1/cdfmc/api/fmc_config/v1/domain/{domainUUID}/object/customsiurllists"}}