api.customernetworks.v1 package

Submodules

api.customernetworks.v1.network module

Autogenerated API

api.customernetworks.v1.network.add_customer_network(customer: str = None, location: str = None, flagsToEnable: list = None, zone: str = None, description: str = None, networkAddress: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Add new customer network (PUBLIC)

Return type:

dict

Parameters:
  • customer (str) – Customer ID or short name of the customer that the network belongs to
  • location (str) – Location ID or short name of the location where the network is located
  • flagsToEnable (list) – Flags to enable for the network
  • zone (str) – Zone of the network
  • description (str) – Description of the customer network. Maximum number of characters is 255. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • networkAddress (str) – IP address of the customer network => format:ip
Raises:
Returns:

{“offset”: 240, “limit”: 812, “responseCode”: 200, “count”: 0, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Behind themselves get describe property able.”, “messageTemplate”: “Case me film put opportunity operation identify Mr.”, “field”: “Pick rate Democrat market positive let let.”, “parameter”: {}, “timestamp”: 989708578}], “currentPage”: 197, “size”: 935}

api.customernetworks.v1.network.add_customer_network_comment(networkID: int, comment: str = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Add comment for customer network (PUBLIC)

Return type:

dict

Parameters:
  • networkID (int) – ID of network to update
  • comment (str) – Comment to add to the network => [sw{}$-().[]“‘_/,*+#:@!?;]*
Raises:
Returns:

{“offset”: 751, “limit”: 751, “responseCode”: 200, “count”: 566, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Pm throughout change begin.”, “messageTemplate”: “Customer strong simple race wall.”, “field”: “Subject enter happy able.”, “parameter”: {}, “timestamp”: 580462496}], “currentPage”: 152, “size”: 268}

api.customernetworks.v1.network.delete_customer_network(networkID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Delete customer network (PUBLIC)

Return type:

dict

Parameters:

networkID (int) – ID of network to delete

Raises:
Returns:

{“offset”: 185, “limit”: 711, “responseCode”: 200, “count”: 360, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Pattern team get shake international happy research.”, “messageTemplate”: “Republican according natural one.”, “field”: “Study project investment each series.”, “parameter”: {}, “timestamp”: 727637855}], “currentPage”: 282, “size”: 842}

api.customernetworks.v1.network.delete_customer_network_comment(networkID: int, commentID: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Delete comment from customer network (PUBLIC)

Return type:

dict

Parameters:
  • networkID (int) – ID of parent network
  • commentID (str) – ID of comment to delete
Raises:
Returns:

{“offset”: 636, “limit”: 890, “responseCode”: 200, “count”: 866, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Past per professional account safe.”, “messageTemplate”: “Degree over appear she down ever.”, “field”: “Red energy late rest approach cold after.”, “parameter”: {}, “timestamp”: 1255305240}], “currentPage”: 315, “size”: 398}

api.customernetworks.v1.network.get_customer_network(networkID: int, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get customer network (PUBLIC)

Return type:

dict

Parameters:

networkID (int) – ID of network to get

Raises:
Returns:

{“offset”: 282, “limit”: 384, “responseCode”: 200, “count”: 650, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “More look yes stuff.”, “messageTemplate”: “Specific against firm year close provide.”, “field”: “Maybe wonder responsibility finally.”, “parameter”: {}, “timestamp”: 670037650}], “currentPage”: 260, “size”: 539}

api.customernetworks.v1.network.get_customer_network_comments(networkID: int, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get network’s comments (PUBLIC)

Return type:

dict

Parameters:
  • networkID (int) – ID of network
  • offset (int) – Skip a number of comments
  • limit (int) – Maximum number of returned comments
Raises:
Returns:

{“offset”: 375, “limit”: 476, “responseCode”: 200, “count”: 371, “data”: [{“id”: 165, “description”: “Across international sometimes source.”, “lastUpdatedByUser”: {“id”: 595, “customerID”: 308, “userName”: “patriciawashington”, “name”: “Cheryl Thomas”}, “lastUpdatedTimestamp”: 1393402238, “createdByUser”: {“id”: 412, “customerID”: 898, “userName”: “nherrera”, “name”: “Heather Gardner”}, “createdTimestamp”: 7932368, “zone”: “INTERNAL”, “flags”: [“DNS”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Large cultural report property support.”, “messageTemplate”: “Particularly energy special fish church bar.”, “field”: “Move state through reduce article.”, “parameter”: {}, “timestamp”: 754023358}], “currentPage”: 487, “size”: 252}

api.customernetworks.v1.network.get_customer_networks(customerID: list = None, offset: int = 0, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Get networks belonging to customer(s) (PUBLIC)

Return type:

dict

Parameters:
  • customerID (list) – ID of customer(s)
  • offset (int) – Skip a number of networks
  • limit (int) – Maximum number of returned networks
Raises:
Returns:

{“offset”: 602, “limit”: 309, “responseCode”: 200, “count”: 40, “data”: [{“id”: 562, “description”: “Professional reduce Republican visit war offer hundred.”, “lastUpdatedByUser”: {“id”: 424, “customerID”: 186, “userName”: “brendanbeck”, “name”: “Timothy Ross”}, “lastUpdatedTimestamp”: 316203356, “createdByUser”: {“id”: 851, “customerID”: 162, “userName”: “ian92”, “name”: “George Williams”}, “createdTimestamp”: 955371766, “zone”: “EXTERNAL”, “flags”: [“CLIENT”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Else image new treat.”, “messageTemplate”: “With structure similar ball offer relate serve.”, “field”: “Vote ten form community work success arm.”, “parameter”: {}, “timestamp”: 52887463}], “currentPage”: 257, “size”: 956}

api.customernetworks.v1.network.search_customer_network(limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, addresses: list = None, keywords: list = None, startTimestamp: int = None, endTimestamp: int = None, timeFieldStrategy: list = None, includeFlags: list = None, excludeFlags: list = None, includeSupernet: bool = 'True', includeSubnet: bool = 'True', timeMatchStrategy: str = 'any', includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Search customer network (PUBLIC)

Return type:

dict

Parameters:
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • addresses (list) – A set of IP addresses matched against networks
  • keywords (list) – A set of keywords matched against network’s description
  • startTimestamp (int) – Start of time search period
  • endTimestamp (int) – End of time search period
  • timeFieldStrategy (list) – TimeFieldStrategy to define which timestamp field(s) to match. (default createdTimestamp)
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeSupernet (bool) – Network in search criteria will be searched for matching supernets (default true)
  • includeSubnet (bool) – Network in search criteria will be searched for matching subnets (default true)
  • timeMatchStrategy (str) – TimeMatchStrategy to define how to match startTimestamp and endTimestamp with provided timeFieldStrategies (default any)
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{“offset”: 958, “limit”: 830, “responseCode”: 200, “count”: 284, “data”: [{“id”: 211, “description”: “Medical baby each even beyond detail travel catch.”, “lastUpdatedByUser”: {“id”: 882, “customerID”: 261, “userName”: “schultzeric”, “name”: “Rebecca Merritt”}, “lastUpdatedTimestamp”: 1436762694, “createdByUser”: {“id”: 506, “customerID”: 167, “userName”: “danielgonzalez”, “name”: “Richard Brown”}, “createdTimestamp”: 391803733, “zone”: “UNKNOWN”, “flags”: [“GUEST”]}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “By we focus cover fear enough town.”, “messageTemplate”: “Piece have amount company thus.”, “field”: “Computer above reduce first training business.”, “parameter”: {}, “timestamp”: 563892758}], “currentPage”: 662, “size”: 409}

api.customernetworks.v1.network.update_customer_network(networkID: int, location: str = None, description: str = None, flagsToEnable: list = None, flagsToDisable: list = None, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Update customer network (PUBLIC)

Return type:

dict

Parameters:
  • networkID (int) – ID of network to update
  • location (str) – Location ID or short name of the location where the network is located
  • description (str) – Description of the customer network. Maximum number of characters is 255. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • flagsToEnable (list) – Flags to enable for the network
  • flagsToDisable (list) – Flags to disable for the network
Raises:
Returns:

{“offset”: 820, “limit”: 318, “responseCode”: 200, “count”: 487, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Yeah young offer box.”, “messageTemplate”: “Science against wonder stock fact number everything.”, “field”: “Miss yet he green everything discussion beautiful store.”, “parameter”: {}, “timestamp”: 1416504453}], “currentPage”: 490, “size”: 343}

Module contents