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 = None, 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’: 714, ‘limit’: 329, ‘responseCode’: 200, ‘count’: 16, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Office strategy fund conference reveal half lose.’, ‘messageTemplate’: ‘Establish personal right safe food operation.’, ‘field’: ‘Beautiful avoid onto close one represent.’, ‘parameter’: {}, ‘timestamp’: 257426112}], ‘currentPage’: 760, ‘size’: 765}

api.customernetworks.v1.network.add_customer_network_comment(networkID: int, comment: str = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 601, ‘limit’: 225, ‘responseCode’: 200, ‘count’: 450, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Back nothing structure return popular spend six remember.’, ‘messageTemplate’: ‘Manager act style seat shoulder part other answer.’, ‘field’: ‘Small finish order station everyone world do.’, ‘parameter’: {}, ‘timestamp’: 977932054}], ‘currentPage’: 997, ‘size’: 425}

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

Delete customer network (PUBLIC)

Return type:

dict

Parameters:

networkID (int) – ID of network to delete

Raises:
Returns:

{‘offset’: 110, ‘limit’: 75, ‘responseCode’: 200, ‘count’: 516, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Father policy growth may process heavy.’, ‘messageTemplate’: ‘Peace know drug quite movie new worker.’, ‘field’: ‘Particular according hour inside bill.’, ‘parameter’: {}, ‘timestamp’: 1253181263}], ‘currentPage’: 349, ‘size’: 802}

api.customernetworks.v1.network.delete_customer_network_comment(networkID: int, commentID: str, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 878, ‘limit’: 499, ‘responseCode’: 200, ‘count’: 512, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Serious gas tell training whose he create.’, ‘messageTemplate’: ‘Challenge stay administration sometimes toward away response.’, ‘field’: ‘Challenge nature senior bring arrive program east.’, ‘parameter’: {}, ‘timestamp’: 213586077}], ‘currentPage’: 946, ‘size’: 903}

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

Get customer network (PUBLIC)

Return type:

dict

Parameters:

networkID (int) – ID of network to get

Raises:
Returns:

{‘offset’: 209, ‘limit’: 613, ‘responseCode’: 200, ‘count’: 826, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Near difficult your you.’, ‘messageTemplate’: ‘Behavior exactly late.’, ‘field’: ‘Respond stop build onto south respond authority.’, ‘parameter’: {}, ‘timestamp’: 479901243}], ‘currentPage’: 125, ‘size’: 862}

api.customernetworks.v1.network.get_customer_network_comments(networkID: int, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 130, ‘limit’: 800, ‘responseCode’: 200, ‘count’: 370, ‘data’: [{‘id’: 72, ‘description’: ‘Including position key leave.’, ‘lastUpdatedByUser’: {‘id’: 66, ‘customerID’: 16, ‘userName’: ‘hadams’, ‘name’: ‘Monica Parks’}, ‘lastUpdatedTimestamp’: 726768113, ‘createdByUser’: {‘id’: 151, ‘customerID’: 218, ‘userName’: ‘ylee’, ‘name’: ‘Laura Ramirez’}, ‘createdTimestamp’: 895295118, ‘zone’: ‘UNKNOWN’, ‘flags’: [‘PROXY’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Cut day PM direction marriage.’, ‘messageTemplate’: ‘Home provide television occur party office.’, ‘field’: ‘Thing ground hot bar nature material short.’, ‘parameter’: {}, ‘timestamp’: 1273609753}], ‘currentPage’: 461, ‘size’: 32}

api.customernetworks.v1.network.get_customer_networks(customerID: list = None, offset: int = None, limit: int = 25, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 937, ‘limit’: 115, ‘responseCode’: 200, ‘count’: 448, ‘data’: [{‘id’: 656, ‘description’: ‘Movie car resource watch just a experience.’, ‘lastUpdatedByUser’: {‘id’: 473, ‘customerID’: 251, ‘userName’: ‘lstanton’, ‘name’: ‘Kevin Harris’}, ‘lastUpdatedTimestamp’: 1111212027, ‘createdByUser’: {‘id’: 831, ‘customerID’: 622, ‘userName’: ‘danielsdiana’, ‘name’: ‘Joseph Mills’}, ‘createdTimestamp’: 427455679, ‘zone’: ‘DMZ’, ‘flags’: [‘SERVER’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Watch interesting TV important herself in.’, ‘messageTemplate’: ‘According system rest market.’, ‘field’: ‘Might beautiful start.’, ‘parameter’: {}, ‘timestamp’: 1074706822}], ‘currentPage’: 749, ‘size’: 924}

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 = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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’: 420, ‘limit’: 307, ‘responseCode’: 200, ‘count’: 116, ‘data’: [{‘id’: 585, ‘description’: ‘Travel man mother feeling.’, ‘lastUpdatedByUser’: {‘id’: 645, ‘customerID’: 389, ‘userName’: ‘michellemckinney’, ‘name’: ‘Marc Harmon’}, ‘lastUpdatedTimestamp’: 407560369, ‘createdByUser’: {‘id’: 466, ‘customerID’: 425, ‘userName’: ‘olivia56’, ‘name’: ‘Brandon Strong’}, ‘createdTimestamp’: 863908611, ‘zone’: ‘INTERNAL’, ‘flags’: [‘SCANNER’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Piece week have them similar chair arrive.’, ‘messageTemplate’: ‘Before much of improve Republican.’, ‘field’: ‘Sister town measure deal.’, ‘parameter’: {}, ‘timestamp’: 1392901224}], ‘currentPage’: 283, ‘size’: 145}

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 = None, 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’: 519, ‘limit’: 655, ‘responseCode’: 200, ‘count’: 413, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Write bank look piece base international.’, ‘messageTemplate’: ‘Partner admit explain see best.’, ‘field’: ‘Animal executive least land discussion computer.’, ‘parameter’: {}, ‘timestamp’: 637197039}], ‘currentPage’: 212, ‘size’: 412}

Module contents