def delete_organization(self, organization_id):
"""Does a DELETE request to /organizations/{organizationId}.
Delete an organization
Args:
organization_id (string): TODO: type description here. Example:
Returns:
void: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(organization_id=organization_id)
# Prepare query URL
_url_path = '/organizations/{organizationId}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'organizationId': organization_id})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
_request = self.http_client.delete(_query_url)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
def get_organizations(self):
"""Does a GET request to /organizations.
List the organizations that the user has privileges on
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Prepare query URL
_url_path = '/organizations'
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def provision_network_clients(self, options=dict()):
"""Does a POST request to /networks/{networkId}/clients/provision.
Provisions a client with a name and policy. Clients can be provisioned
before they associate to the network.
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
provision_network_clients -- ProvisionNetworkClientsModel
-- TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(
network_id=options.get("network_id"),
provision_network_clients=options.get("provision_network_clients"))
# Prepare query URL
_url_path = '/networks/{networkId}/clients/provision'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'networkId': options.get('network_id', None)})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.post(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(
options.get('provision_network_clients')))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def unbind_network(self, network_id):
"""Does a POST request to /networks/{networkId}/unbind.
Unbind a network from a template.
Args:
network_id (string): TODO: type description here. Example:
Returns:
void: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/unbind'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'networkId': network_id})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
_request = self.http_client.post(_query_url)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
def update_network_bluetooth_settings(self, options=dict()):
"""Does a PUT request to /networks/{networkId}/bluetoothSettings.
Update the Bluetooth settings for a network. See the docs page for <a
href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energ
y_(BLE)">Bluetooth settings</a>.
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
update_network_bluetooth_settings --
UpdateNetworkBluetoothSettingsModel -- TODO: type
description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/bluetoothSettings'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'networkId': options.get('network_id', None)})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.put(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(
options.get('update_network_bluetooth_settings')))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_client_splash_authorization_status(self,
options=dict()):
"""Does a GET request to /networks/{networkId}/clients/{clientId}/splashAuthorizationStatus.
Return the splash authorization for a client, for each SSID they've
associated with through splash. Only enabled SSIDs with Click-through
splash enabled will be included. Clients can be identified by a client
key or either the MAC or IP depending on whether the network uses
Track-by-IP.
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
client_id -- string -- TODO: type description here.
Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"),
client_id=options.get("client_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/clients/{clientId}/splashAuthorizationStatus'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': options.get('network_id', None),
'clientId': options.get('client_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_pii_request(self,
options=dict()):
"""Does a GET request to /networks/{networkId}/pii/requests/{requestId}.
Return a PII request
## ALTERNATE PATH
```
/organizations/{organizationId}/pii/requests/{requestId}
```
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
request_id -- string -- TODO: type description here.
Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"),
request_id=options.get("request_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/pii/requests/{requestId}'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': options.get('network_id', None),
'requestId': options.get('request_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_sm_target_groups(self,
options=dict()):
"""Does a GET request to /networks/{networkId}/sm/targetGroups.
List the target groups in this network
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
with_details -- bool -- Boolean indicating if the the ids
of the devices or users scoped by the target group
should be included in the response
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/sm/targetGroups'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': options.get('network_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_parameters = {
'withDetails': options.get('with_details', None)
}
_query_builder = APIHelper.append_url_with_query_parameters(_query_builder,
_query_parameters, Configuration.array_serialization)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def update_organization_saml_role(self,
options=dict()):
"""Does a PUT request to /organizations/{organizationId}/samlRoles/{samlRoleId}.
Update a SAML role
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
organization_id -- string -- TODO: type description here.
Example:
saml_role_id -- string -- TODO: type description here.
Example:
update_organization_saml_role --
UpdateOrganizationSamlRoleModel -- TODO: type
description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(organization_id=options.get("organization_id"),
saml_role_id=options.get("saml_role_id"))
# Prepare query URL
_url_path = '/organizations/{organizationId}/samlRoles/{samlRoleId}'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'organizationId': options.get('organization_id', None),
'samlRoleId': options.get('saml_role_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.put(_query_url, headers=_headers, parameters=APIHelper.json_serialize(options.get('update_organization_saml_role')))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_organization_networks(self, options=dict()):
"""Does a GET request to /organizations/{organizationId}/networks.
List the networks in an organization
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
organization_id -- string -- TODO: type description here.
Example:
config_template_id -- string -- An optional parameter that
is the ID of a config template. Will return all
networks bound to that template.
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(
organization_id=options.get("organization_id"))
# Prepare query URL
_url_path = '/organizations/{organizationId}/networks'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path,
{'organizationId': options.get('organization_id', None)})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_parameters = {
'configTemplateId': options.get('config_template_id', None)
}
_query_builder = APIHelper.append_url_with_query_parameters(
_query_builder, _query_parameters,
Configuration.array_serialization)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def update_network_ssid_l_3_firewall_rules(self,
options=dict()):
"""Does a PUT request to /networks/{networkId}/ssids/{number}/l3FirewallRules.
Update the L3 firewall rules of an SSID on an MR network
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
number -- string -- TODO: type description here. Example:
update_network_ssid_l_3_firewall_rules --
UpdateNetworkSsidL3FirewallRulesModel -- TODO: type
description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"),
number=options.get("number"))
# Prepare query URL
_url_path = '/networks/{networkId}/ssids/{number}/l3FirewallRules'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': options.get('network_id', None),
'number': options.get('number', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.put(_query_url, headers=_headers, parameters=APIHelper.json_serialize(options.get('update_network_ssid_l_3_firewall_rules')))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def update_device_camera_quality_and_retention_settings(
self, options=dict()):
"""Does a PUT request to /devices/{serial}/camera/qualityAndRetentionSettings.
Update quality and retention settings for the given camera
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
serial -- string -- TODO: type description here. Example:
update_device_camera_quality_and_retention_settings --
UpdateDeviceCameraQualityAndRetentionSettingsModel --
TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(serial=options.get("serial"))
# Prepare query URL
_url_path = '/devices/{serial}/camera/qualityAndRetentionSettings'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'serial': options.get('serial', None)})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.put(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(
options.get(
'update_device_camera_quality_and_retention_settings')))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_organization_insight_monitored_media_server(self, options=dict()):
"""Does a GET request to /organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}.
Return a monitored media server for this organization. Only valid for
organizations with Meraki Insight.
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
organization_id -- string -- TODO: type description here.
Example:
monitored_media_server_id -- string -- TODO: type
description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(
organization_id=options.get("organization_id"),
monitored_media_server_id=options.get("monitored_media_server_id"))
# Prepare query URL
_url_path = '/organizations/{organizationId}/insight/monitoredMediaServers/{monitoredMediaServerId}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {
'organizationId':
options.get('organization_id', None),
'monitoredMediaServerId':
options.get('monitored_media_server_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def claim_organization(self,
options=dict()):
"""Does a POST request to /organizations/{organizationId}/claim.
Claim a list of devices, licenses, and/or orders into an organization.
When claiming by order, all devices and licenses in the order will be
claimed; licenses will be added to the organization and devices will
be placed in the organization's inventory.
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
organization_id -- string -- TODO: type description here.
Example:
claim_organization -- ClaimOrganizationModel -- TODO: type
description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(organization_id=options.get("organization_id"))
# Prepare query URL
_url_path = '/organizations/{organizationId}/claim'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'organizationId': options.get('organization_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.post(_query_url, headers=_headers, parameters=APIHelper.json_serialize(options.get('claim_organization')))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_device_performance(self,
options=dict()):
"""Does a GET request to /networks/{networkId}/devices/{serial}/performance.
Return the performance score for a single device. Only primary MX
devices supported. If no data is available, a 204 error code is
returned.
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
serial -- string -- TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"),
serial=options.get("serial"))
# Prepare query URL
_url_path = '/networks/{networkId}/devices/{serial}/performance'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': options.get('network_id', None),
'serial': options.get('serial', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_device_camera_analytics_recent(self, options=dict()):
"""Does a GET request to /devices/{serial}/camera/analytics/recent.
Returns most recent record for analytics zones
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
serial -- string -- TODO: type description here. Example:
object_type -- ObjectTypeEnum -- [optional] The object
type for which analytics will be retrieved. The
default object type is person. The available types are
[person, vehicle].
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(serial=options.get("serial"))
# Prepare query URL
_url_path = '/devices/{serial}/camera/analytics/recent'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'serial': options.get('serial', None)})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_parameters = {'objectType': options.get('object_type', None)}
_query_builder = APIHelper.append_url_with_query_parameters(
_query_builder, _query_parameters,
Configuration.array_serialization)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_pii_requests(self,
network_id):
"""Does a GET request to /networks/{networkId}/pii/requests.
List the PII requests for this network or organization
## ALTERNATE PATH
```
/organizations/{organizationId}/pii/requests
```
Args:
network_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/pii/requests'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': network_id
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def delete_organization_admin(self, options=dict()):
"""Does a DELETE request to /organizations/{organizationId}/admins/{id}.
Revoke all access for a dashboard administrator within this
organization
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
organization_id -- string -- TODO: type description here.
Example:
id -- string -- TODO: type description here. Example:
Returns:
void: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(
organization_id=options.get("organization_id"),
id=options.get("id"))
# Prepare query URL
_url_path = '/organizations/{organizationId}/admins/{id}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {
'organizationId': options.get('organization_id', None),
'id': options.get('id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
_request = self.http_client.delete(_query_url)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
def delete_network_switch_port_schedule(self, options=dict()):
"""Does a DELETE request to /networks/{networkId}/switch/portSchedules/{portScheduleId}.
Delete a switch port schedule
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
port_schedule_id -- string -- TODO: type description here.
Example:
Returns:
void: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(
network_id=options.get("network_id"),
port_schedule_id=options.get("port_schedule_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/switch/portSchedules/{portScheduleId}'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {
'networkId': options.get('network_id', None),
'portScheduleId': options.get('port_schedule_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare and execute request
_request = self.http_client.delete(_query_url)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
def create_organization(self, create_organization):
"""Does a POST request to /organizations.
Create a new organization
Args:
create_organization (CreateOrganizationModel): TODO: type
description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(create_organization=create_organization)
# Prepare query URL
_url_path = '/organizations'
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json',
'content-type': 'application/json; charset=utf-8'
}
# Prepare and execute request
_request = self.http_client.post(
_query_url,
headers=_headers,
parameters=APIHelper.json_serialize(create_organization))
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_switch_settings_qos_rules_order(self,
network_id):
"""Does a GET request to /networks/{networkId}/switch/settings/qosRules/order.
Return the quality of service rule IDs by order in which they will be
processed by the switch
Args:
network_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/switch/settings/qosRules/order'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': network_id
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_traffic_shaping_dscp_tagging_options(self,
network_id):
"""Does a GET request to /networks/{networkId}/trafficShaping/dscpTaggingOptions.
Returns the available DSCP tagging options for your traffic shaping
rules.
Args:
network_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/trafficShaping/dscpTaggingOptions'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': network_id
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_organization_openapi_spec(self,
organization_id):
"""Does a GET request to /organizations/{organizationId}/openapiSpec.
Return the OpenAPI 2.0 Specification of the organization's API
documentation in JSON
Args:
organization_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(organization_id=organization_id)
# Prepare query URL
_url_path = '/organizations/{organizationId}/openapiSpec'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'organizationId': organization_id
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_cellular_gateway_settings_subnet_pool(self,
network_id):
"""Does a GET request to /networks/{networkId}/cellularGateway/settings/subnetPool.
Return the subnet pool and mask configured for MGs in the network.
Args:
network_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/cellularGateway/settings/subnetPool'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': network_id
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_device_switch_ports(self,
serial):
"""Does a GET request to /devices/{serial}/switchPorts.
List the switch ports for a switch
Args:
serial (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(serial=serial)
# Prepare query URL
_url_path = '/devices/{serial}/switchPorts'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'serial': serial
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_organization_branding_policies_priorities(self, organization_id):
"""Does a GET request to /organizations/{organizationId}/brandingPolicies/priorities.
Return the branding policy IDs of an organization in priority order.
IDs are ordered in ascending order of priority (IDs later in the array
have higher priority).
Args:
organization_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(organization_id=organization_id)
# Prepare query URL
_url_path = '/organizations/{organizationId}/brandingPolicies/priorities'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'organizationId': organization_id})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_bluetooth_settings(self, network_id):
"""Does a GET request to /networks/{networkId}/bluetoothSettings.
Return the Bluetooth settings for a network. <a
href="https://documentation.meraki.com/MR/Bluetooth/Bluetooth_Low_Energ
y_(BLE)">Bluetooth settings</a> must be enabled on the network.
Args:
network_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/bluetoothSettings'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'networkId': network_id})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def split_network(self, network_id):
"""Does a POST request to /networks/{networkId}/split.
Split a combined network into individual networks for each type of
device
Args:
network_id (string): TODO: type description here. Example:
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=network_id)
# Prepare query URL
_url_path = '/networks/{networkId}/split'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'networkId': network_id})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.post(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_events(self, options=dict()):
"""Does a GET request to /networks/{networkId}/events.
List the events for the network
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
product_type -- string -- The product type to fetch events
for. This parameter is required for networks with
multiple device types. Valid types are wireless,
appliance, switch, systemsManager, camera, and
cellularGateway
included_event_types -- list of string -- A list of event
types. The returned events will be filtered to only
include events with these types.
excluded_event_types -- list of string -- A list of event
types. The returned events will be filtered to exclude
events with these types.
device_mac -- string -- The MAC address of the Meraki
device which the list of events will be filtered with
device_serial -- string -- The serial of the Meraki device
which the list of events will be filtered with
device_name -- string -- The name of the Meraki device
which the list of events will be filtered with
client_ip -- string -- The IP of the client which the list
of events will be filtered with. Only supported for
track-by-IP networks.
client_mac -- string -- The MAC address of the client
which the list of events will be filtered with. Only
supported for track-by-MAC networks.
client_name -- string -- The name, or partial name, of the
client which the list of events will be filtered with
sm_device_mac -- string -- The MAC address of the Systems
Manager device which the list of events will be
filtered with
sm_device_name -- string -- The name of the Systems
Manager device which the list of events will be
filtered with
per_page -- int -- The number of entries per page
returned. Acceptable range is 3 - 1000. Default is
10.
starting_after -- string -- A token used by the server to
indicate the start of the page. Often this is a
timestamp or an ID but it is not limited to those.
This parameter should not be defined by client
applications. The link for the first, last, prev, or
next page in the HTTP Link header should define it.
ending_before -- string -- A token used by the server to
indicate the end of the page. Often this is a
timestamp or an ID but it is not limited to those.
This parameter should not be defined by client
applications. The link for the first, last, prev, or
next page in the HTTP Link header should define it.
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/events'
_url_path = APIHelper.append_url_with_template_parameters(
_url_path, {'networkId': options.get('network_id', None)})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_parameters = {
'productType': options.get('product_type', None),
'includedEventTypes': options.get('included_event_types', None),
'excludedEventTypes': options.get('excluded_event_types', None),
'deviceMac': options.get('device_mac', None),
'deviceSerial': options.get('device_serial', None),
'deviceName': options.get('device_name', None),
'clientIp': options.get('client_ip', None),
'clientMac': options.get('client_mac', None),
'clientName': options.get('client_name', None),
'smDeviceMac': options.get('sm_device_mac', None),
'smDeviceName': options.get('sm_device_name', None),
'perPage': options.get('per_page', None),
'startingAfter': options.get('starting_after', None),
'endingBefore': options.get('ending_before', None)
}
_query_builder = APIHelper.append_url_with_query_parameters(
_query_builder, _query_parameters,
Configuration.array_serialization)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {'accept': 'application/json'}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
def get_network_clients(self,
options=dict()):
"""Does a GET request to /networks/{networkId}/clients.
List the clients that have used this network in the timespan
Args:
options (dict, optional): Key-value pairs for any of the
parameters to this API Endpoint. All parameters to the
endpoint are supplied through the dictionary with their names
being the key and their desired values being the value. A list
of parameters that can be used are::
network_id -- string -- TODO: type description here.
Example:
t_0 -- string -- The beginning of the timespan for the
data. The maximum lookback period is 31 days from
today.
timespan -- float -- The timespan for which the
information will be fetched. If specifying timespan,
do not specify parameter t0. The value must be in
seconds and be less than or equal to 31 days. The
default is 1 day.
per_page -- int -- The number of entries per page
returned. Acceptable range is 3 - 1000. Default is
10.
starting_after -- string -- A token used by the server to
indicate the start of the page. Often this is a
timestamp or an ID but it is not limited to those.
This parameter should not be defined by client
applications. The link for the first, last, prev, or
next page in the HTTP Link header should define it.
ending_before -- string -- A token used by the server to
indicate the end of the page. Often this is a
timestamp or an ID but it is not limited to those.
This parameter should not be defined by client
applications. The link for the first, last, prev, or
next page in the HTTP Link header should define it.
Returns:
mixed: Response from the API. Successful operation
Raises:
APIException: When an error occurs while fetching the data from
the remote API. This exception includes the HTTP Response
code, an error message, and the HTTP body that was received in
the request.
"""
# Validate required parameters
self.validate_parameters(network_id=options.get("network_id"))
# Prepare query URL
_url_path = '/networks/{networkId}/clients'
_url_path = APIHelper.append_url_with_template_parameters(_url_path, {
'networkId': options.get('network_id', None)
})
_query_builder = Configuration.base_uri
_query_builder += _url_path
_query_parameters = {
't0': options.get('t_0', None),
'timespan': options.get('timespan', None),
'perPage': options.get('per_page', None),
'startingAfter': options.get('starting_after', None),
'endingBefore': options.get('ending_before', None)
}
_query_builder = APIHelper.append_url_with_query_parameters(_query_builder,
_query_parameters, Configuration.array_serialization)
_query_url = APIHelper.clean_url(_query_builder)
# Prepare headers
_headers = {
'accept': 'application/json'
}
# Prepare and execute request
_request = self.http_client.get(_query_url, headers=_headers)
CustomHeaderAuth.apply(_request)
_context = self.execute_request(_request)
self.validate_response(_context)
# Return appropriate type
return APIHelper.json_deserialize(_context.response.raw_body)
