Get Objects - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Objects","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/5d5aecff21bad7bcca77baa7cc8e50f89c820bd5/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":"Get objects in the Security Cloud Control tenant. To use the object APIs, contact customer support or provision Multicloud Defense and turn on object sharing. Note: the object APIs only support operations on network objects and groups.","operationId":"getObjects","parameters":[{"description":"The query to execute. Use the Lucene Query Syntax to construct your query. Possible fields to search by are name, content.","example":"content:*2.2.* AND name:Lab1","in":"query","name":"q","required":false,"schema":{"type":"string"}},{"description":"If enabled, the search will also include results from override objects.","in":"query","name":"includeOverrides","required":false,"schema":{"default":false,"type":"boolean"}},{"description":"The offset of the results retrieved. The Security Cloud Control API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","in":"query","name":"offset","required":false,"schema":{"minimum":0,"type":"string"}},{"description":"The number of results to retrieve.","in":"query","name":"limit","required":false,"schema":{"maximum":200,"minimum":1,"type":"string"}},{"deprecated":true,"description":"The fields to sort results by. This parameter is deprecated.","example":"name:DESC","in":"query","name":"sortBy","required":false,"schema":{"type":"string"}},{"description":"The fields to sort results by.","example":"name:DESC","in":"query","name":"sort","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"count":{"description":"The total number of results available.","example":100,"format":"int64","type":"integer"},"items":{"description":"The list of objects retrieved.","items":{"properties":{"description":{"type":"string"},"issues":{"properties":{"duplicateTargetIds":{"items":{"type":"string"},"type":"array","uniqueItems":true},"unusedTargetIds":{"items":{"type":"string"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/IssuesDto"},"labels":{"items":{"type":"string"},"type":"array","uniqueItems":true},"name":{"type":"string"},"overrideIds":{"items":{"type":"string"},"type":"array","uniqueItems":true},"readOnly":{"type":"boolean"},"tags":{"additionalProperties":{"items":{"type":"string"},"type":"array","uniqueItems":true},"type":"object"},"targetIds":{"items":{"type":"string"},"type":"array","uniqueItems":true},"uid":{"format":"uuid","type":"string"},"value":{"properties":{"defaultContent":{"description":"The default value of the object","example":{"literal":"a:b:c::1"},"oneOf":[{"properties":{"protocol":{"description":"The service object protocol","enum":["TCP","UDP","ICMP","ICMP4","ICMP6","TCP_UDP","IGMP","GGP","ST2","CBT","EGP","IGP","BBNRCCMON","NVP2","PUP","ARGUS","EMCON","XNET","CHAOS","MUX","DCNMEAS","HMP","PRM","XNSIDP","TRUNK1","TRUNK2","LEAF1","LEAF2","RDP","IRTP","ISOTP4","NETBLT","MFENSP","MERITINP","SEP","THREEPC","IDPR","XTP","DDP","IDPRCMTP","TPPLUSPLUS","IL","SDRP","IDRP","RSVP","GRE","MHRP","BNA","ESP","AH","INLSP","SWIPE","NARP","MOBILE","TLSP","SKIP","IPv6NONXT","CFTP","SATEXPAK","KRYPTOLAN","RVD","IPPC","SATMON","VISA","IPCV","CPNX","CPHB","WSN","PVP","BRSATMON","SUNND","WBMON","WBEXPAK","ISOIP","VMTP","SECUREVMTP","VINES","TTP","NSFNETIGP","DGP","TCF","EIGRP","OSPFIGP","SPRITERPC","LARP","MTP","AX25","IPIP","MICP","SCCSP","ETHERIP","ENCAP","GMTP","IFMP","PNNI","PIM","ARIS","SCPS","QNX","AN","IPCOMP","SNP","COMPAQPEER","IPXINIP","VRRP","PGM","L2TP","DDX","IATP","ST","SRP","UTI","SMP","SM","PTP","ISIS","FIRE","CRTP","CRUDP","SSCOPMCE","IPLT","SPS","PIPE","SCTP","FC","DIVERT","CUSTOM"],"example":"TCP","type":"string"},"serviceValue":{"description":"The value of the service object","example":["80","81"],"oneOf":[{"properties":{"icmp4Code":{"enum":["NET_UNREACHABLE","HOST_UNREACHABLE","PROTOCOL_UNREACHABLE","PORT_UNREACHABLE","FRAGMENTATION_NEEDED","SOURCE_ROUTE_FAILED","DEST_NETWORK_UNKNOWN","DEST_HOST_UNKNOWN","SRC_HOST_ISOLATED","COMMUNICATION_DEST_NET_PROHIBITED","COMMUNICATION_DEST_HOST_PROHIBITED","DEST_NET_UNREACHABLE_FOR_TOS","DEST_HOST_UNREACHABLE_FOR_TOS","COMM_ADMINISTRATIVELY_PROHIBITED","HOST_PRECEDENCE_VIOLATION","PRECEDENCE_CUTOFF","REDIRECT_DATAGRAM_NETWORK","REDIRECT_DATAGRAM_HOST","REDIRECT_DATAGRAM_SERVICE_NETWORK","REDIRECT_DATAGRAM_SERVICE_HOST","ALTERNATE_HOST_ADDR","DO_NOT_ROUTE_COMMON_TRAFFIC","NORMAL_ROUTER_ADV","TTL_EXPIRED_TRANSIT","FRAG_ASSEMBLY","PTR_ERROR","MISSING_REQD_OPTION","BAD_LENGTH","BAD_SPI","AUTH_FAILED","DECOMPRESSION_FAILED","DECRYPTION_FAILED","NEED_AUTHENTICATION","NEED_AUTHORIZATION"],"example":"NET_UNREACHABLE","type":"string"},"icmp4Type":{"enum":["ANY","ECHO_REPLY","DESTINATION_UNREACHABLE","SOURCE_QUENCH","REDIRECT_MESSAGE","ALTERNATE_HOST_ADDRESS","ECHO_REQUEST","ROUTER_ADVERTISEMENT","ROUTER_SOLICITATION","TIME_EXCEEDED","PARAMETER_PROBLEM","TIMESTAMP","TIMESTAMP_REPLY","INFO_REQUEST","INFO_REPLY","ADDR_MASK_REQUEST","ADDR_MASK_REPLY","TRACEROUTE","DATAGRAM_CONVERSION_ERROR","MOBILE_HOST_REDIRECT","WHERE_ARE_YOU","HERE_I_AM","MOBILE_REG_REQUEST","MOBILE_REG_REPLY","DOMAIN_NAME_REQUEST","DOMAIN_NAME_REPLY","SKIP_ALGORITHM_DISCOVERY_PROTOCOL","PHOTURIS","EXPERIMENTAL_MOB_PROTOCOLS"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp4Value"},{"properties":{"icmp6Code":{"enum":["NO_ROUTE_DEST","COMMUNICATION_PROHIBITED","BEYOND_SCOPE_SRC_ADDR","ADDRESS_UNREACHABLE","PORT_UNREACHABLE","SOURCE_ADDRESS_FAILED","REJECT_ROUTE","ERROR_SRC_ROUTING_HEADER","HOP_LIMIT_EXCEEDED","FRAGMENT_REASSEMBLY_TIME_EXCEEDED","ERRONEOUS_HEADER_ENCOUNTERED","UNRECOGNIZED_NEXT_HEADER_TYPE_ENCOUNTERED","UNRECOGNIZED_IPV6_OPTION_ENCOUNTERED","IPV6_FIRST_FRAG_HAS_INCOMPLETE_HEADER_CHAIN","SR_UPPER_LAYER_HEADER_ERROR","ROUTER_RENUMBERING_COMMAND","ROUTER_RENUMBERING_RESULT","DATA_CONTAINS_IPV6","DATA_CONTAINS_NAME","DATA_CONTAINS_IPV4","SUCCESSFUL_REPLY","RESPONDER_REFUSES_ANSWER","QTYPE_UNKNOWN"],"example":"ADDRESS_UNREACHABLE","type":"string"},"icmp6Type":{"enum":["ANY","DESTINATION_UNREACHABLE","PACKET_TOO_BIG","TIME_EXCEEDED","PARAMETER_PROBLEM","ECHO_REQUEST","ECHO_REPLY","MULTICAST_LISTENER_QUERY","MULTICAST_LISTENER_REPORT","MULTICAST_LISTENER_DONE","ROUTER_SOLICITATION","ROUTER_ADVERTISEMENT","NEIGHBOUR_SOLICITATION","NEIGHBOUR_ADVERTISEMENT","REDIRECT_MESSAGE","ROUTER_RENUMBERING","ICMP_NODE_INFO_QUERY","ICMP_NODE_INFO_RESPONSE","INVERSE_NEIGHBOR_DISCOVERY_SOLICITATION","INVERSE_NEIGHBOR_DISCOVERY_ADVERTISEMENT","VER2_MULTICAST_LISTENER_REPORT","HOME_AGENT_ADDR_DISCOVERY_REQUEST","HOME_AGENT_ADDR_DISCOVERY_REPLY","MOBILE_PREFIX_SOLICITATION","MOBILE_PREFIX_ADVERTISEMENT","CERT_PATH_SOLICITATION","CERT_PATH_ADVERTISEMENT","ICMP_EXP_MOBILITY_PROTOCOLS","MULTICAST_ROUTER_ADVERTISEMENT","MULTICAST_ROUTER_SOLICITATION","MULTICAST_ROUTER_TERMINATION","FMIPV6_MESSAGE","RPL_CONTROL_MESSAGE","PRIVATE_EXPERIMENTATION","PRIVATE_EXPERIMENTATION_EXTENDED"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp6Value"},{"properties":{"destination":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},"source":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"}},"type":"object","$$ref":"#/components/schemas/SourceDestinationPortsValue"},{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},{"properties":{"protocolValue":{"description":"The literal for a custom protocol value","example":"www","type":"string"}},"type":"object","$$ref":"#/components/schemas/ProtocolValueContent"}],"properties":{"type":{"enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","ICMP_4","ICMP_6","SOURCE_DESTINATION_PORT","PORT","PROTOCOL_VALUE"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectValueContent"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectContent"},{"properties":{"url":{"description":"The URL literal","example":"https://www.cisco.com/","minLength":1,"type":"string"}},"required":["url"],"type":"object","$$ref":"#/components/schemas/UrlObjectContent"},{"description":"The contents of an object group","properties":{"literals":{"description":"List of content literals","items":{"oneOf":[{"properties":{"protocol":{"description":"The service object protocol","enum":["TCP","UDP","ICMP","ICMP4","ICMP6","TCP_UDP","IGMP","GGP","ST2","CBT","EGP","IGP","BBNRCCMON","NVP2","PUP","ARGUS","EMCON","XNET","CHAOS","MUX","DCNMEAS","HMP","PRM","XNSIDP","TRUNK1","TRUNK2","LEAF1","LEAF2","RDP","IRTP","ISOTP4","NETBLT","MFENSP","MERITINP","SEP","THREEPC","IDPR","XTP","DDP","IDPRCMTP","TPPLUSPLUS","IL","SDRP","IDRP","RSVP","GRE","MHRP","BNA","ESP","AH","INLSP","SWIPE","NARP","MOBILE","TLSP","SKIP","IPv6NONXT","CFTP","SATEXPAK","KRYPTOLAN","RVD","IPPC","SATMON","VISA","IPCV","CPNX","CPHB","WSN","PVP","BRSATMON","SUNND","WBMON","WBEXPAK","ISOIP","VMTP","SECUREVMTP","VINES","TTP","NSFNETIGP","DGP","TCF","EIGRP","OSPFIGP","SPRITERPC","LARP","MTP","AX25","IPIP","MICP","SCCSP","ETHERIP","ENCAP","GMTP","IFMP","PNNI","PIM","ARIS","SCPS","QNX","AN","IPCOMP","SNP","COMPAQPEER","IPXINIP","VRRP","PGM","L2TP","DDX","IATP","ST","SRP","UTI","SMP","SM","PTP","ISIS","FIRE","CRTP","CRUDP","SSCOPMCE","IPLT","SPS","PIPE","SCTP","FC","DIVERT","CUSTOM"],"example":"TCP","type":"string"},"serviceValue":{"description":"The value of the service object","example":["80","81"],"oneOf":[{"properties":{"icmp4Code":{"enum":["NET_UNREACHABLE","HOST_UNREACHABLE","PROTOCOL_UNREACHABLE","PORT_UNREACHABLE","FRAGMENTATION_NEEDED","SOURCE_ROUTE_FAILED","DEST_NETWORK_UNKNOWN","DEST_HOST_UNKNOWN","SRC_HOST_ISOLATED","COMMUNICATION_DEST_NET_PROHIBITED","COMMUNICATION_DEST_HOST_PROHIBITED","DEST_NET_UNREACHABLE_FOR_TOS","DEST_HOST_UNREACHABLE_FOR_TOS","COMM_ADMINISTRATIVELY_PROHIBITED","HOST_PRECEDENCE_VIOLATION","PRECEDENCE_CUTOFF","REDIRECT_DATAGRAM_NETWORK","REDIRECT_DATAGRAM_HOST","REDIRECT_DATAGRAM_SERVICE_NETWORK","REDIRECT_DATAGRAM_SERVICE_HOST","ALTERNATE_HOST_ADDR","DO_NOT_ROUTE_COMMON_TRAFFIC","NORMAL_ROUTER_ADV","TTL_EXPIRED_TRANSIT","FRAG_ASSEMBLY","PTR_ERROR","MISSING_REQD_OPTION","BAD_LENGTH","BAD_SPI","AUTH_FAILED","DECOMPRESSION_FAILED","DECRYPTION_FAILED","NEED_AUTHENTICATION","NEED_AUTHORIZATION"],"example":"NET_UNREACHABLE","type":"string"},"icmp4Type":{"enum":["ANY","ECHO_REPLY","DESTINATION_UNREACHABLE","SOURCE_QUENCH","REDIRECT_MESSAGE","ALTERNATE_HOST_ADDRESS","ECHO_REQUEST","ROUTER_ADVERTISEMENT","ROUTER_SOLICITATION","TIME_EXCEEDED","PARAMETER_PROBLEM","TIMESTAMP","TIMESTAMP_REPLY","INFO_REQUEST","INFO_REPLY","ADDR_MASK_REQUEST","ADDR_MASK_REPLY","TRACEROUTE","DATAGRAM_CONVERSION_ERROR","MOBILE_HOST_REDIRECT","WHERE_ARE_YOU","HERE_I_AM","MOBILE_REG_REQUEST","MOBILE_REG_REPLY","DOMAIN_NAME_REQUEST","DOMAIN_NAME_REPLY","SKIP_ALGORITHM_DISCOVERY_PROTOCOL","PHOTURIS","EXPERIMENTAL_MOB_PROTOCOLS"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp4Value"},{"properties":{"icmp6Code":{"enum":["NO_ROUTE_DEST","COMMUNICATION_PROHIBITED","BEYOND_SCOPE_SRC_ADDR","ADDRESS_UNREACHABLE","PORT_UNREACHABLE","SOURCE_ADDRESS_FAILED","REJECT_ROUTE","ERROR_SRC_ROUTING_HEADER","HOP_LIMIT_EXCEEDED","FRAGMENT_REASSEMBLY_TIME_EXCEEDED","ERRONEOUS_HEADER_ENCOUNTERED","UNRECOGNIZED_NEXT_HEADER_TYPE_ENCOUNTERED","UNRECOGNIZED_IPV6_OPTION_ENCOUNTERED","IPV6_FIRST_FRAG_HAS_INCOMPLETE_HEADER_CHAIN","SR_UPPER_LAYER_HEADER_ERROR","ROUTER_RENUMBERING_COMMAND","ROUTER_RENUMBERING_RESULT","DATA_CONTAINS_IPV6","DATA_CONTAINS_NAME","DATA_CONTAINS_IPV4","SUCCESSFUL_REPLY","RESPONDER_REFUSES_ANSWER","QTYPE_UNKNOWN"],"example":"ADDRESS_UNREACHABLE","type":"string"},"icmp6Type":{"enum":["ANY","DESTINATION_UNREACHABLE","PACKET_TOO_BIG","TIME_EXCEEDED","PARAMETER_PROBLEM","ECHO_REQUEST","ECHO_REPLY","MULTICAST_LISTENER_QUERY","MULTICAST_LISTENER_REPORT","MULTICAST_LISTENER_DONE","ROUTER_SOLICITATION","ROUTER_ADVERTISEMENT","NEIGHBOUR_SOLICITATION","NEIGHBOUR_ADVERTISEMENT","REDIRECT_MESSAGE","ROUTER_RENUMBERING","ICMP_NODE_INFO_QUERY","ICMP_NODE_INFO_RESPONSE","INVERSE_NEIGHBOR_DISCOVERY_SOLICITATION","INVERSE_NEIGHBOR_DISCOVERY_ADVERTISEMENT","VER2_MULTICAST_LISTENER_REPORT","HOME_AGENT_ADDR_DISCOVERY_REQUEST","HOME_AGENT_ADDR_DISCOVERY_REPLY","MOBILE_PREFIX_SOLICITATION","MOBILE_PREFIX_ADVERTISEMENT","CERT_PATH_SOLICITATION","CERT_PATH_ADVERTISEMENT","ICMP_EXP_MOBILITY_PROTOCOLS","MULTICAST_ROUTER_ADVERTISEMENT","MULTICAST_ROUTER_SOLICITATION","MULTICAST_ROUTER_TERMINATION","FMIPV6_MESSAGE","RPL_CONTROL_MESSAGE","PRIVATE_EXPERIMENTATION","PRIVATE_EXPERIMENTATION_EXTENDED"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp6Value"},{"properties":{"destination":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},"source":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"}},"type":"object","$$ref":"#/components/schemas/SourceDestinationPortsValue"},{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},{"properties":{"protocolValue":{"description":"The literal for a custom protocol value","example":"www","type":"string"}},"type":"object","$$ref":"#/components/schemas/ProtocolValueContent"}],"properties":{"type":{"enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","ICMP_4","ICMP_6","SOURCE_DESTINATION_PORT","PORT","PROTOCOL_VALUE"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectValueContent"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectContent"},{"properties":{"url":{"description":"The URL literal","example":"https://www.cisco.com/","minLength":1,"type":"string"}},"required":["url"],"type":"object","$$ref":"#/components/schemas/UrlObjectContent"},{"description":"The content of a network object","properties":{"literal":{"description":"The literal content of the network object","example":"a:b:c::1","minLength":1,"type":"string"}},"required":["literal"],"type":"object","$$ref":"#/components/schemas/NetworkObjectContent"}],"properties":{"type":{"enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","ICMP_4","ICMP_6","SOURCE_DESTINATION_PORT","PORT","PROTOCOL_VALUE"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/SingleContent"},"type":"array"},"referencedObjectUids":{"description":"Set of UIDs of the group's referenced objects","example":["7131daad-e813-4b8f-8f42-be1e241e8cdb"],"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/GroupContent"},{"description":"The content of a network object","properties":{"literal":{"description":"The literal content of the network object","example":"a:b:c::1","minLength":1,"type":"string"}},"required":["literal"],"type":"object","$$ref":"#/components/schemas/NetworkObjectContent"}],"$$ref":"#/components/schemas/ObjectContent"},"objectType":{"description":"The type of object","enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","NETWORK_GROUP","URL_GROUP","SERVICE_GROUP"],"example":"NETWORK_OBJECT","type":"string"},"overrides":{"description":"The list of target overrides for the object. Each override the default content for its target.","items":{"example":{"content":"a:b:c::2","targetId":"7131daad-e813-4b8f-8f42-be1e241e8cdb"},"properties":{"content":{"description":"The content value of the override. This overrides the object's default content.","example":{"literal":"a:b:c::1"},"oneOf":[{"properties":{"protocol":{"description":"The service object protocol","enum":["TCP","UDP","ICMP","ICMP4","ICMP6","TCP_UDP","IGMP","GGP","ST2","CBT","EGP","IGP","BBNRCCMON","NVP2","PUP","ARGUS","EMCON","XNET","CHAOS","MUX","DCNMEAS","HMP","PRM","XNSIDP","TRUNK1","TRUNK2","LEAF1","LEAF2","RDP","IRTP","ISOTP4","NETBLT","MFENSP","MERITINP","SEP","THREEPC","IDPR","XTP","DDP","IDPRCMTP","TPPLUSPLUS","IL","SDRP","IDRP","RSVP","GRE","MHRP","BNA","ESP","AH","INLSP","SWIPE","NARP","MOBILE","TLSP","SKIP","IPv6NONXT","CFTP","SATEXPAK","KRYPTOLAN","RVD","IPPC","SATMON","VISA","IPCV","CPNX","CPHB","WSN","PVP","BRSATMON","SUNND","WBMON","WBEXPAK","ISOIP","VMTP","SECUREVMTP","VINES","TTP","NSFNETIGP","DGP","TCF","EIGRP","OSPFIGP","SPRITERPC","LARP","MTP","AX25","IPIP","MICP","SCCSP","ETHERIP","ENCAP","GMTP","IFMP","PNNI","PIM","ARIS","SCPS","QNX","AN","IPCOMP","SNP","COMPAQPEER","IPXINIP","VRRP","PGM","L2TP","DDX","IATP","ST","SRP","UTI","SMP","SM","PTP","ISIS","FIRE","CRTP","CRUDP","SSCOPMCE","IPLT","SPS","PIPE","SCTP","FC","DIVERT","CUSTOM"],"example":"TCP","type":"string"},"serviceValue":{"description":"The value of the service object","example":["80","81"],"oneOf":[{"properties":{"icmp4Code":{"enum":["NET_UNREACHABLE","HOST_UNREACHABLE","PROTOCOL_UNREACHABLE","PORT_UNREACHABLE","FRAGMENTATION_NEEDED","SOURCE_ROUTE_FAILED","DEST_NETWORK_UNKNOWN","DEST_HOST_UNKNOWN","SRC_HOST_ISOLATED","COMMUNICATION_DEST_NET_PROHIBITED","COMMUNICATION_DEST_HOST_PROHIBITED","DEST_NET_UNREACHABLE_FOR_TOS","DEST_HOST_UNREACHABLE_FOR_TOS","COMM_ADMINISTRATIVELY_PROHIBITED","HOST_PRECEDENCE_VIOLATION","PRECEDENCE_CUTOFF","REDIRECT_DATAGRAM_NETWORK","REDIRECT_DATAGRAM_HOST","REDIRECT_DATAGRAM_SERVICE_NETWORK","REDIRECT_DATAGRAM_SERVICE_HOST","ALTERNATE_HOST_ADDR","DO_NOT_ROUTE_COMMON_TRAFFIC","NORMAL_ROUTER_ADV","TTL_EXPIRED_TRANSIT","FRAG_ASSEMBLY","PTR_ERROR","MISSING_REQD_OPTION","BAD_LENGTH","BAD_SPI","AUTH_FAILED","DECOMPRESSION_FAILED","DECRYPTION_FAILED","NEED_AUTHENTICATION","NEED_AUTHORIZATION"],"example":"NET_UNREACHABLE","type":"string"},"icmp4Type":{"enum":["ANY","ECHO_REPLY","DESTINATION_UNREACHABLE","SOURCE_QUENCH","REDIRECT_MESSAGE","ALTERNATE_HOST_ADDRESS","ECHO_REQUEST","ROUTER_ADVERTISEMENT","ROUTER_SOLICITATION","TIME_EXCEEDED","PARAMETER_PROBLEM","TIMESTAMP","TIMESTAMP_REPLY","INFO_REQUEST","INFO_REPLY","ADDR_MASK_REQUEST","ADDR_MASK_REPLY","TRACEROUTE","DATAGRAM_CONVERSION_ERROR","MOBILE_HOST_REDIRECT","WHERE_ARE_YOU","HERE_I_AM","MOBILE_REG_REQUEST","MOBILE_REG_REPLY","DOMAIN_NAME_REQUEST","DOMAIN_NAME_REPLY","SKIP_ALGORITHM_DISCOVERY_PROTOCOL","PHOTURIS","EXPERIMENTAL_MOB_PROTOCOLS"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp4Value"},{"properties":{"icmp6Code":{"enum":["NO_ROUTE_DEST","COMMUNICATION_PROHIBITED","BEYOND_SCOPE_SRC_ADDR","ADDRESS_UNREACHABLE","PORT_UNREACHABLE","SOURCE_ADDRESS_FAILED","REJECT_ROUTE","ERROR_SRC_ROUTING_HEADER","HOP_LIMIT_EXCEEDED","FRAGMENT_REASSEMBLY_TIME_EXCEEDED","ERRONEOUS_HEADER_ENCOUNTERED","UNRECOGNIZED_NEXT_HEADER_TYPE_ENCOUNTERED","UNRECOGNIZED_IPV6_OPTION_ENCOUNTERED","IPV6_FIRST_FRAG_HAS_INCOMPLETE_HEADER_CHAIN","SR_UPPER_LAYER_HEADER_ERROR","ROUTER_RENUMBERING_COMMAND","ROUTER_RENUMBERING_RESULT","DATA_CONTAINS_IPV6","DATA_CONTAINS_NAME","DATA_CONTAINS_IPV4","SUCCESSFUL_REPLY","RESPONDER_REFUSES_ANSWER","QTYPE_UNKNOWN"],"example":"ADDRESS_UNREACHABLE","type":"string"},"icmp6Type":{"enum":["ANY","DESTINATION_UNREACHABLE","PACKET_TOO_BIG","TIME_EXCEEDED","PARAMETER_PROBLEM","ECHO_REQUEST","ECHO_REPLY","MULTICAST_LISTENER_QUERY","MULTICAST_LISTENER_REPORT","MULTICAST_LISTENER_DONE","ROUTER_SOLICITATION","ROUTER_ADVERTISEMENT","NEIGHBOUR_SOLICITATION","NEIGHBOUR_ADVERTISEMENT","REDIRECT_MESSAGE","ROUTER_RENUMBERING","ICMP_NODE_INFO_QUERY","ICMP_NODE_INFO_RESPONSE","INVERSE_NEIGHBOR_DISCOVERY_SOLICITATION","INVERSE_NEIGHBOR_DISCOVERY_ADVERTISEMENT","VER2_MULTICAST_LISTENER_REPORT","HOME_AGENT_ADDR_DISCOVERY_REQUEST","HOME_AGENT_ADDR_DISCOVERY_REPLY","MOBILE_PREFIX_SOLICITATION","MOBILE_PREFIX_ADVERTISEMENT","CERT_PATH_SOLICITATION","CERT_PATH_ADVERTISEMENT","ICMP_EXP_MOBILITY_PROTOCOLS","MULTICAST_ROUTER_ADVERTISEMENT","MULTICAST_ROUTER_SOLICITATION","MULTICAST_ROUTER_TERMINATION","FMIPV6_MESSAGE","RPL_CONTROL_MESSAGE","PRIVATE_EXPERIMENTATION","PRIVATE_EXPERIMENTATION_EXTENDED"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp6Value"},{"properties":{"destination":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},"source":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"}},"type":"object","$$ref":"#/components/schemas/SourceDestinationPortsValue"},{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},{"properties":{"protocolValue":{"description":"The literal for a custom protocol value","example":"www","type":"string"}},"type":"object","$$ref":"#/components/schemas/ProtocolValueContent"}],"properties":{"type":{"enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","ICMP_4","ICMP_6","SOURCE_DESTINATION_PORT","PORT","PROTOCOL_VALUE"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectValueContent"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectContent"},{"properties":{"url":{"description":"The URL literal","example":"https://www.cisco.com/","minLength":1,"type":"string"}},"required":["url"],"type":"object","$$ref":"#/components/schemas/UrlObjectContent"},{"description":"The contents of an object group","properties":{"literals":{"description":"List of content literals","items":{"oneOf":[{"properties":{"protocol":{"description":"The service object protocol","enum":["TCP","UDP","ICMP","ICMP4","ICMP6","TCP_UDP","IGMP","GGP","ST2","CBT","EGP","IGP","BBNRCCMON","NVP2","PUP","ARGUS","EMCON","XNET","CHAOS","MUX","DCNMEAS","HMP","PRM","XNSIDP","TRUNK1","TRUNK2","LEAF1","LEAF2","RDP","IRTP","ISOTP4","NETBLT","MFENSP","MERITINP","SEP","THREEPC","IDPR","XTP","DDP","IDPRCMTP","TPPLUSPLUS","IL","SDRP","IDRP","RSVP","GRE","MHRP","BNA","ESP","AH","INLSP","SWIPE","NARP","MOBILE","TLSP","SKIP","IPv6NONXT","CFTP","SATEXPAK","KRYPTOLAN","RVD","IPPC","SATMON","VISA","IPCV","CPNX","CPHB","WSN","PVP","BRSATMON","SUNND","WBMON","WBEXPAK","ISOIP","VMTP","SECUREVMTP","VINES","TTP","NSFNETIGP","DGP","TCF","EIGRP","OSPFIGP","SPRITERPC","LARP","MTP","AX25","IPIP","MICP","SCCSP","ETHERIP","ENCAP","GMTP","IFMP","PNNI","PIM","ARIS","SCPS","QNX","AN","IPCOMP","SNP","COMPAQPEER","IPXINIP","VRRP","PGM","L2TP","DDX","IATP","ST","SRP","UTI","SMP","SM","PTP","ISIS","FIRE","CRTP","CRUDP","SSCOPMCE","IPLT","SPS","PIPE","SCTP","FC","DIVERT","CUSTOM"],"example":"TCP","type":"string"},"serviceValue":{"description":"The value of the service object","example":["80","81"],"oneOf":[{"properties":{"icmp4Code":{"enum":["NET_UNREACHABLE","HOST_UNREACHABLE","PROTOCOL_UNREACHABLE","PORT_UNREACHABLE","FRAGMENTATION_NEEDED","SOURCE_ROUTE_FAILED","DEST_NETWORK_UNKNOWN","DEST_HOST_UNKNOWN","SRC_HOST_ISOLATED","COMMUNICATION_DEST_NET_PROHIBITED","COMMUNICATION_DEST_HOST_PROHIBITED","DEST_NET_UNREACHABLE_FOR_TOS","DEST_HOST_UNREACHABLE_FOR_TOS","COMM_ADMINISTRATIVELY_PROHIBITED","HOST_PRECEDENCE_VIOLATION","PRECEDENCE_CUTOFF","REDIRECT_DATAGRAM_NETWORK","REDIRECT_DATAGRAM_HOST","REDIRECT_DATAGRAM_SERVICE_NETWORK","REDIRECT_DATAGRAM_SERVICE_HOST","ALTERNATE_HOST_ADDR","DO_NOT_ROUTE_COMMON_TRAFFIC","NORMAL_ROUTER_ADV","TTL_EXPIRED_TRANSIT","FRAG_ASSEMBLY","PTR_ERROR","MISSING_REQD_OPTION","BAD_LENGTH","BAD_SPI","AUTH_FAILED","DECOMPRESSION_FAILED","DECRYPTION_FAILED","NEED_AUTHENTICATION","NEED_AUTHORIZATION"],"example":"NET_UNREACHABLE","type":"string"},"icmp4Type":{"enum":["ANY","ECHO_REPLY","DESTINATION_UNREACHABLE","SOURCE_QUENCH","REDIRECT_MESSAGE","ALTERNATE_HOST_ADDRESS","ECHO_REQUEST","ROUTER_ADVERTISEMENT","ROUTER_SOLICITATION","TIME_EXCEEDED","PARAMETER_PROBLEM","TIMESTAMP","TIMESTAMP_REPLY","INFO_REQUEST","INFO_REPLY","ADDR_MASK_REQUEST","ADDR_MASK_REPLY","TRACEROUTE","DATAGRAM_CONVERSION_ERROR","MOBILE_HOST_REDIRECT","WHERE_ARE_YOU","HERE_I_AM","MOBILE_REG_REQUEST","MOBILE_REG_REPLY","DOMAIN_NAME_REQUEST","DOMAIN_NAME_REPLY","SKIP_ALGORITHM_DISCOVERY_PROTOCOL","PHOTURIS","EXPERIMENTAL_MOB_PROTOCOLS"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp4Value"},{"properties":{"icmp6Code":{"enum":["NO_ROUTE_DEST","COMMUNICATION_PROHIBITED","BEYOND_SCOPE_SRC_ADDR","ADDRESS_UNREACHABLE","PORT_UNREACHABLE","SOURCE_ADDRESS_FAILED","REJECT_ROUTE","ERROR_SRC_ROUTING_HEADER","HOP_LIMIT_EXCEEDED","FRAGMENT_REASSEMBLY_TIME_EXCEEDED","ERRONEOUS_HEADER_ENCOUNTERED","UNRECOGNIZED_NEXT_HEADER_TYPE_ENCOUNTERED","UNRECOGNIZED_IPV6_OPTION_ENCOUNTERED","IPV6_FIRST_FRAG_HAS_INCOMPLETE_HEADER_CHAIN","SR_UPPER_LAYER_HEADER_ERROR","ROUTER_RENUMBERING_COMMAND","ROUTER_RENUMBERING_RESULT","DATA_CONTAINS_IPV6","DATA_CONTAINS_NAME","DATA_CONTAINS_IPV4","SUCCESSFUL_REPLY","RESPONDER_REFUSES_ANSWER","QTYPE_UNKNOWN"],"example":"ADDRESS_UNREACHABLE","type":"string"},"icmp6Type":{"enum":["ANY","DESTINATION_UNREACHABLE","PACKET_TOO_BIG","TIME_EXCEEDED","PARAMETER_PROBLEM","ECHO_REQUEST","ECHO_REPLY","MULTICAST_LISTENER_QUERY","MULTICAST_LISTENER_REPORT","MULTICAST_LISTENER_DONE","ROUTER_SOLICITATION","ROUTER_ADVERTISEMENT","NEIGHBOUR_SOLICITATION","NEIGHBOUR_ADVERTISEMENT","REDIRECT_MESSAGE","ROUTER_RENUMBERING","ICMP_NODE_INFO_QUERY","ICMP_NODE_INFO_RESPONSE","INVERSE_NEIGHBOR_DISCOVERY_SOLICITATION","INVERSE_NEIGHBOR_DISCOVERY_ADVERTISEMENT","VER2_MULTICAST_LISTENER_REPORT","HOME_AGENT_ADDR_DISCOVERY_REQUEST","HOME_AGENT_ADDR_DISCOVERY_REPLY","MOBILE_PREFIX_SOLICITATION","MOBILE_PREFIX_ADVERTISEMENT","CERT_PATH_SOLICITATION","CERT_PATH_ADVERTISEMENT","ICMP_EXP_MOBILITY_PROTOCOLS","MULTICAST_ROUTER_ADVERTISEMENT","MULTICAST_ROUTER_SOLICITATION","MULTICAST_ROUTER_TERMINATION","FMIPV6_MESSAGE","RPL_CONTROL_MESSAGE","PRIVATE_EXPERIMENTATION","PRIVATE_EXPERIMENTATION_EXTENDED"],"example":"DESTINATION_UNREACHABLE","type":"string"}},"type":"object","$$ref":"#/components/schemas/Icmp6Value"},{"properties":{"destination":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},"source":{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"}},"type":"object","$$ref":"#/components/schemas/SourceDestinationPortsValue"},{"properties":{"literal":{"description":"The literal port or range of port values","example":"8000-8080","type":"string"}},"type":"object","$$ref":"#/components/schemas/PortsValue"},{"properties":{"protocolValue":{"description":"The literal for a custom protocol value","example":"www","type":"string"}},"type":"object","$$ref":"#/components/schemas/ProtocolValueContent"}],"properties":{"type":{"enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","ICMP_4","ICMP_6","SOURCE_DESTINATION_PORT","PORT","PROTOCOL_VALUE"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectValueContent"}},"type":"object","$$ref":"#/components/schemas/ServiceObjectContent"},{"properties":{"url":{"description":"The URL literal","example":"https://www.cisco.com/","minLength":1,"type":"string"}},"required":["url"],"type":"object","$$ref":"#/components/schemas/UrlObjectContent"},{"description":"The content of a network object","properties":{"literal":{"description":"The literal content of the network object","example":"a:b:c::1","minLength":1,"type":"string"}},"required":["literal"],"type":"object","$$ref":"#/components/schemas/NetworkObjectContent"}],"properties":{"type":{"enum":["NETWORK_OBJECT","URL_OBJECT","SERVICE_OBJECT","ICMP_4","ICMP_6","SOURCE_DESTINATION_PORT","PORT","PROTOCOL_VALUE"],"type":"string"}},"type":"object","$$ref":"#/components/schemas/SingleContent"},"type":"array"},"referencedObjectUids":{"description":"Set of UIDs of the group's referenced objects","example":["7131daad-e813-4b8f-8f42-be1e241e8cdb"],"items":{"format":"uuid","type":"string"},"type":"array","uniqueItems":true}},"type":"object","$$ref":"#/components/schemas/GroupContent"},{"description":"The content of a network object","properties":{"literal":{"description":"The literal content of the network object","example":"a:b:c::1","minLength":1,"type":"string"}},"required":["literal"],"type":"object","$$ref":"#/components/schemas/NetworkObjectContent"}],"$$ref":"#/components/schemas/ObjectContent"},"targetId":{"description":"The ID of the target. A target can be, for example, a device, service, or a shared policy (Ruleset).","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","type":"string"}},"required":["content"],"type":"object","$$ref":"#/components/schemas/Override"},"type":"array"}},"required":["defaultContent","objectType"],"type":"object","$$ref":"#/components/schemas/SharedObjectValue"}},"type":"object","$$ref":"#/components/schemas/UnifiedObjectListView"},"type":"array"},"limit":{"description":"The number of results retrieved.","example":50,"format":"int64","maximum":200,"type":"integer"},"offset":{"description":"The offset of the results retrieved. The CDO API uses the offset field to determine the index of the first result retrieved, and will retrieve `limit` results from the offset specified.","example":0,"format":"int64","type":"integer"}},"type":"object","$$ref":"#/components/schemas/ListObjectResponse"}}},"description":"A paginated view of the Security Cloud Control objects."},"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"},"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."}},"summary":"Get Objects","tags":["Object Management"],"__originalOperationId":"getObjects","method":"get","path":"/v1/objects"}}