{ "opencollection": "1.0.0", "info": { "name": "Cisco Meraki Dashboard API — organizations", "version": "1.72.0" }, "request": { "auth": { "type": "apikey", "key": "X-Cisco-Meraki-API-Key", "value": "{{X-Cisco-Meraki-API-Key}}", "placement": "header" } }, "items": [ { "info": { "name": "organizations", "type": "folder" }, "items": [ { "info": { "name": "List the organizations that the user has privileges on", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations", "params": [ { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 9000. Default is 9000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the organizations that the user has privileges on" }, { "info": { "name": "Create a new organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new organization" }, { "info": { "name": "Return an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Return an organization" }, { "info": { "name": "Update an organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an organization" }, { "info": { "name": "Delete an organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Delete an organization" }, { "info": { "name": "Return the list of action batches in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/actionBatches", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "status", "value": "", "type": "query", "description": "Filter batches by status. Valid types are pending, completed, and failed." } ] }, "docs": "Return the list of action batches in the organization" }, { "info": { "name": "Create an action batch", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/actionBatches", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an action batch" }, { "info": { "name": "Return an action batch", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/actionBatches/:actionBatchId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "actionBatchId", "value": "", "type": "path", "description": "Action batch ID" } ] }, "docs": "Return an action batch" }, { "info": { "name": "Update an action batch", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/actionBatches/:actionBatchId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "actionBatchId", "value": "", "type": "path", "description": "Action batch ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an action batch" }, { "info": { "name": "Delete an action batch", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/actionBatches/:actionBatchId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "actionBatchId", "value": "", "type": "path", "description": "Action batch ID" } ] }, "docs": "Delete an action batch" }, { "info": { "name": "List adaptive policy ACLs in a organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/acls", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List adaptive policy ACLs in a organization" }, { "info": { "name": "Creates new adaptive policy ACL", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/acls", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates new adaptive policy ACL" }, { "info": { "name": "Returns the adaptive policy ACL information", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/acls/:aclId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" } ] }, "docs": "Returns the adaptive policy ACL information" }, { "info": { "name": "Updates an adaptive policy ACL", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/acls/:aclId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an adaptive policy ACL" }, { "info": { "name": "Deletes the specified adaptive policy ACL", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/acls/:aclId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "aclId", "value": "", "type": "path", "description": "Acl ID" } ] }, "docs": "Deletes the specified adaptive policy ACL. Note this adaptive policy ACL will also be removed from policies using it." }, { "info": { "name": "List adaptive policy groups in a organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/groups", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List adaptive policy groups in a organization" }, { "info": { "name": "Creates a new adaptive policy group", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/groups", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new adaptive policy group" }, { "info": { "name": "Returns an adaptive policy group", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/groups/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Returns an adaptive policy group" }, { "info": { "name": "Updates an adaptive policy group", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/groups/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an adaptive policy group. If updating \"Infrastructure\", only the SGT is allowed. Cannot update \"Unknown\"." }, { "info": { "name": "Deletes the specified adaptive policy group and any associated policies and references", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/groups/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Deletes the specified adaptive policy group and any associated policies and references" }, { "info": { "name": "Returns adaptive policy aggregate statistics for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Returns adaptive policy aggregate statistics for an organization" }, { "info": { "name": "List adaptive policies in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/policies", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List adaptive policies in an organization" }, { "info": { "name": "Add an Adaptive Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/policies", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an Adaptive Policy" }, { "info": { "name": "Return an adaptive policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/policies/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Return an adaptive policy" }, { "info": { "name": "Update an Adaptive Policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/policies/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Adaptive Policy" }, { "info": { "name": "Delete an Adaptive Policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/policies/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Delete an Adaptive Policy" }, { "info": { "name": "Returns global adaptive policy settings in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/settings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Returns global adaptive policy settings in an organization" }, { "info": { "name": "Update global adaptive policy settings", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/adaptivePolicy/settings", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update global adaptive policy settings" }, { "info": { "name": "List the dashboard administrators in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/admins", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter the result set by the included set of network IDs" } ] }, "docs": "List the dashboard administrators in this organization" }, { "info": { "name": "Create a new dashboard administrator", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/admins", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new dashboard administrator" }, { "info": { "name": "Update an administrator", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/admins/:adminId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "adminId", "value": "", "type": "path", "description": "Admin ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an administrator" }, { "info": { "name": "Revoke all access for a dashboard administrator within this organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/admins/:adminId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "adminId", "value": "", "type": "path", "description": "Admin ID" } ] }, "docs": "Revoke all access for a dashboard administrator within this organization" }, { "info": { "name": "List all organization-wide alert configurations", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/alerts/profiles", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List all organization-wide alert configurations" }, { "info": { "name": "Create an organization-wide alert configuration", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/alerts/profiles", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an organization-wide alert configuration" }, { "info": { "name": "Update an organization-wide alert config", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/alerts/profiles/:alertConfigId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "alertConfigId", "value": "", "type": "path", "description": "Alert config ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an organization-wide alert config" }, { "info": { "name": "Removes an organization-wide alert config", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/alerts/profiles/:alertConfigId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "alertConfigId", "value": "", "type": "path", "description": "Alert config ID" } ] }, "docs": "Removes an organization-wide alert config" }, { "info": { "name": "List pipeline jobs, with optional status filtering", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/api/rest/provisioning/pipelines/jobs", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "pipelineIds", "value": "", "type": "query", "description": "Pipeline IDs to retrieve jobs for" }, { "name": "status", "value": "", "type": "query", "description": "If provided, filters jobs by status" } ] }, "docs": "List pipeline jobs, with optional status filtering" }, { "info": { "name": "Retrieves pipeline overviews with aggregated job status counts", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/api/rest/provisioning/pipelines/jobs/overviews/byPipeline", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "pipelineIds", "value": "", "type": "query", "description": "Pipeline IDs to retrieve overviews for" } ] }, "docs": "Retrieves pipeline overviews with aggregated job status counts" }, { "info": { "name": "List the API requests made by an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/apiRequests", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "adminId", "value": "", "type": "query", "description": "Filter the results by the ID of the admin who made the API requests" }, { "name": "path", "value": "", "type": "query", "description": "Filter the results by the path of the API requests" }, { "name": "method", "value": "", "type": "query", "description": "Filter the results by the method of the API requests (must be 'GET', 'PUT', 'POST' or 'DELETE')" }, { "name": "responseCode", "value": "", "type": "query", "description": "Filter the results by the response code of the API requests" }, { "name": "sourceIp", "value": "", "type": "query", "description": "Filter the results by the IP address of the originating API request" }, { "name": "userAgent", "value": "", "type": "query", "description": "Filter the results by the user agent string of the API request" }, { "name": "version", "value": "", "type": "query", "description": "Filter the results by the API version of the API request" }, { "name": "operationIds", "value": "", "type": "query", "description": "Filter the results by one or more operation IDs for the API request" } ] }, "docs": "List the API requests made by an organization" }, { "info": { "name": "Return an aggregated overview of API requests data", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/apiRequests/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days." } ] }, "docs": "Return an aggregated overview of API requests data" }, { "info": { "name": "Tracks organizations' API requests by response code across a given time period", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/apiRequests/overview/responseCodes/byInterval", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 31 days. If interval is provided, the timespan will be autocalculated." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 120, 3600, 14400, 21600. The default is 21600. Interval is calculated if time params are provided." }, { "name": "version", "value": "", "type": "query", "description": "Filter by API version of the endpoint. Allowable values are: [0, 1]" }, { "name": "operationIds", "value": "", "type": "query", "description": "Filter by operation ID of the endpoint" }, { "name": "sourceIps", "value": "", "type": "query", "description": "Filter by source IP that made the API request" }, { "name": "adminIds", "value": "", "type": "query", "description": "Filter by admin ID of user that made the API request" }, { "name": "userAgent", "value": "", "type": "query", "description": "Filter by user agent string for API request. This will filter by a complete or partial match." } ] }, "docs": "Tracks organizations' API requests by response code across a given time period" }, { "info": { "name": "Return all health alerts for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 4 - 300. Default is 30." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'." }, { "name": "networkId", "value": "", "type": "query", "description": "Optional parameter to filter alerts by network ids." }, { "name": "severity", "value": "", "type": "query", "description": "Optional parameter to filter by severity type." }, { "name": "types", "value": "", "type": "query", "description": "Optional parameter to filter by alert type." }, { "name": "tsStart", "value": "", "type": "query", "description": "Optional parameter to filter by starting timestamp" }, { "name": "tsEnd", "value": "", "type": "query", "description": "Optional parameter to filter by end timestamp" }, { "name": "category", "value": "", "type": "query", "description": "Optional parameter to filter by category." }, { "name": "sortBy", "value": "", "type": "query", "description": "Optional parameter to set column to sort by." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter by primary device serial" }, { "name": "deviceTypes", "value": "", "type": "query", "description": "Optional parameter to filter by device types" }, { "name": "deviceTags", "value": "", "type": "query", "description": "Optional parameter to filter by device tags" }, { "name": "active", "value": "", "type": "query", "description": "Optional parameter to filter by active alerts defaults to true" }, { "name": "dismissed", "value": "", "type": "query", "description": "Optional parameter to filter by dismissed alerts defaults to false" }, { "name": "resolved", "value": "", "type": "query", "description": "Optional parameter to filter by resolved alerts defaults to false" }, { "name": "suppressAlertsForOfflineNodes", "value": "", "type": "query", "description": "When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false." } ] }, "docs": "Return all health alerts for an organization" }, { "info": { "name": "Dismiss health alerts", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/dismiss", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Dismiss health alerts" }, { "info": { "name": "Return overview of active health alerts for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkId", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by network ids." }, { "name": "severity", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by severity type." }, { "name": "types", "value": "", "type": "query", "description": "Optional parameter to filter by alert type." }, { "name": "tsStart", "value": "", "type": "query", "description": "Optional parameter to filter by starting timestamp" }, { "name": "tsEnd", "value": "", "type": "query", "description": "Optional parameter to filter by end timestamp" }, { "name": "category", "value": "", "type": "query", "description": "Optional parameter to filter by category." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter by primary device serial" }, { "name": "deviceTypes", "value": "", "type": "query", "description": "Optional parameter to filter by device types" }, { "name": "deviceTags", "value": "", "type": "query", "description": "Optional parameter to filter by device tags" }, { "name": "active", "value": "", "type": "query", "description": "Optional parameter to filter by active alerts defaults to true" }, { "name": "dismissed", "value": "", "type": "query", "description": "Optional parameter to filter by dismissed alerts defaults to false" }, { "name": "resolved", "value": "", "type": "query", "description": "Optional parameter to filter by resolved alerts defaults to false" }, { "name": "suppressAlertsForOfflineNodes", "value": "", "type": "query", "description": "When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false." } ] }, "docs": "Return overview of active health alerts for an organization" }, { "info": { "name": "Return a Summary of Alerts grouped by network and severity", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/overview/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'." }, { "name": "networkId", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by network id." }, { "name": "severity", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by severity type." }, { "name": "types", "value": "", "type": "query", "description": "Optional parameter to filter by alert type." }, { "name": "tsStart", "value": "", "type": "query", "description": "Optional parameter to filter by starting timestamp" }, { "name": "tsEnd", "value": "", "type": "query", "description": "Optional parameter to filter by end timestamp" }, { "name": "category", "value": "", "type": "query", "description": "Optional parameter to filter by category." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter by primary device serial" }, { "name": "deviceTypes", "value": "", "type": "query", "description": "Optional parameter to filter by device types" }, { "name": "deviceTags", "value": "", "type": "query", "description": "Optional parameter to filter by device tags" }, { "name": "active", "value": "", "type": "query", "description": "Optional parameter to filter by active alerts defaults to true" }, { "name": "dismissed", "value": "", "type": "query", "description": "Optional parameter to filter by dismissed alerts defaults to false" }, { "name": "resolved", "value": "", "type": "query", "description": "Optional parameter to filter by resolved alerts defaults to false" }, { "name": "suppressAlertsForOfflineNodes", "value": "", "type": "query", "description": "When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false." } ] }, "docs": "Return a Summary of Alerts grouped by network and severity" }, { "info": { "name": "Return a Summary of Alerts grouped by type and severity", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/overview/byType", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'ascending'." }, { "name": "networkId", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by network ids." }, { "name": "severity", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by severity type." }, { "name": "types", "value": "", "type": "query", "description": "Optional parameter to filter by alert type." }, { "name": "tsStart", "value": "", "type": "query", "description": "Optional parameter to filter by starting timestamp" }, { "name": "tsEnd", "value": "", "type": "query", "description": "Optional parameter to filter by end timestamp" }, { "name": "category", "value": "", "type": "query", "description": "Optional parameter to filter by category." }, { "name": "sortBy", "value": "", "type": "query", "description": "Optional parameter to set column to sort by." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter by primary device serial" }, { "name": "deviceTypes", "value": "", "type": "query", "description": "Optional parameter to filter by device types" }, { "name": "deviceTags", "value": "", "type": "query", "description": "Optional parameter to filter by device tags" }, { "name": "active", "value": "", "type": "query", "description": "Optional parameter to filter by active alerts defaults to true" }, { "name": "dismissed", "value": "", "type": "query", "description": "Optional parameter to filter by dismissed alerts defaults to false" }, { "name": "resolved", "value": "", "type": "query", "description": "Optional parameter to filter by resolved alerts defaults to false" }, { "name": "includeDeviceTags", "value": "", "type": "query", "description": "Include grouped device tags for each alert type in the response." }, { "name": "includeNetworks", "value": "", "type": "query", "description": "Include affected networks for each alert type in the response." }, { "name": "suppressAlertsForOfflineNodes", "value": "", "type": "query", "description": "When set to true the api will only return connectivity alerts for a given device if that device is in an offline state. This only applies to devices. This is ignored when resolved is true. Example: If a Switch has a VLan Mismatch and is Unreachable. only the Unreachable alert will be returned. Defaults to false." } ] }, "docs": "Return a Summary of Alerts grouped by type and severity" }, { "info": { "name": "Returns historical health alert overviews", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/overview/historical", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "segmentDuration", "value": "", "type": "query", "description": "Amount of time in seconds for each segment in the returned dataset" }, { "name": "networkId", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by network ids." }, { "name": "severity", "value": "", "type": "query", "description": "Optional parameter to filter alerts overview by severity type." }, { "name": "types", "value": "", "type": "query", "description": "Optional parameter to filter by alert type." }, { "name": "tsStart", "value": "", "type": "query", "description": "Parameter to define starting timestamp of historical totals" }, { "name": "tsEnd", "value": "", "type": "query", "description": "Optional parameter to filter by end timestamp defaults to the current time" }, { "name": "category", "value": "", "type": "query", "description": "Optional parameter to filter by category." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter by primary device serial" }, { "name": "deviceTypes", "value": "", "type": "query", "description": "Optional parameter to filter by device types" } ] }, "docs": "Returns historical health alert overviews" }, { "info": { "name": "Restore health alerts from dismissed", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/restore", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restore health alerts from dismissed" }, { "info": { "name": "Return a list of Category Types", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/taxonomy/categories", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Return a list of Category Types" }, { "info": { "name": "Return a list of alert types", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/taxonomy/types", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Return a list of alert types" }, { "info": { "name": "Return a singular Health Alert by its id", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/assurance/alerts/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Return a singular Health Alert by its id" }, { "info": { "name": "List the branding policies of an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List the branding policies of an organization" }, { "info": { "name": "Add a new branding policy to an organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a new branding policy to an organization" }, { "info": { "name": "Return the branding policy IDs of an organization in priority order", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies/priorities", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "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)." }, { "info": { "name": "Update the priority ordering of an organization's branding policies.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies/priorities", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the priority ordering of an organization's branding policies." }, { "info": { "name": "Return a branding policy", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies/:brandingPolicyId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "brandingPolicyId", "value": "", "type": "path", "description": "Branding policy ID" } ] }, "docs": "Return a branding policy" }, { "info": { "name": "Update a branding policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies/:brandingPolicyId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "brandingPolicyId", "value": "", "type": "path", "description": "Branding policy ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a branding policy" }, { "info": { "name": "Delete a branding policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/brandingPolicies/:brandingPolicyId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "brandingPolicyId", "value": "", "type": "path", "description": "Branding policy ID" } ] }, "docs": "Delete a branding policy" }, { "info": { "name": "Claim a list of devices, licenses, and/or orders into an organization inventory", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/claim", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Claim a list of devices, licenses, and/or orders into an organization inventory. 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. This operation can be used up to ten times within a single five minute window." }, { "info": { "name": "Return data usage (in megabits per second) over time for all clients in the given organization within a given time range.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/clients/bandwidthUsageHistory", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return data usage (in megabits per second) over time for all clients in the given organization within a given time range." }, { "info": { "name": "Return summary information around client data usage (in kb) across the given organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/clients/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day." } ] }, "docs": "Return summary information around client data usage (in kb) across the given organization." }, { "info": { "name": "Return the client details in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/clients/search", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 5. Default is 5." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "mac", "value": "", "type": "query", "description": "The MAC address of the client. Required." } ] }, "docs": "Return the client details in an organization" }, { "info": { "name": "Create a new organization by cloning the addressed organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/clone", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new organization by cloning the addressed organization" }, { "info": { "name": "List the configuration templates for this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/configTemplates", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List the configuration templates for this organization" }, { "info": { "name": "Create a new configuration template", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/configTemplates", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new configuration template" }, { "info": { "name": "Return a single configuration template", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/configTemplates/:configTemplateId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "configTemplateId", "value": "", "type": "path", "description": "Config template ID" } ] }, "docs": "Return a single configuration template" }, { "info": { "name": "Update a configuration template", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/configTemplates/:configTemplateId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "configTemplateId", "value": "", "type": "path", "description": "Config template ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a configuration template" }, { "info": { "name": "Remove a configuration template", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/configTemplates/:configTemplateId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "configTemplateId", "value": "", "type": "path", "description": "Config template ID" } ] }, "docs": "Remove a configuration template" }, { "info": { "name": "View the Change Log for your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/configurationChanges", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 365 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 365 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100000. Default is 5000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkId", "value": "", "type": "query", "description": "Filters on the given network" }, { "name": "adminId", "value": "", "type": "query", "description": "Filters on the given Admin" } ] }, "docs": "View the Change Log for your organization" }, { "info": { "name": "List the devices in an organization that have been assigned to a network.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 5000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "configurationUpdatedAfter", "value": "", "type": "query", "description": "Filter results by whether or not the device's configuration has been updated after the given timestamp" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by network." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect." }, { "name": "tags", "value": "", "type": "query", "description": "Optional parameter to filter devices by tags." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "Optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." }, { "name": "name", "value": "", "type": "query", "description": "Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match." }, { "name": "mac", "value": "", "type": "query", "description": "Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match." }, { "name": "serial", "value": "", "type": "query", "description": "Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match." }, { "name": "model", "value": "", "type": "query", "description": "Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match." }, { "name": "macs", "value": "", "type": "query", "description": "Optional parameter to filter devices by one or more MAC addresses. All returned devices will have a MAC address that is an exact match." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter devices by one or more serial numbers. All returned devices will have a serial number that is an exact match." }, { "name": "sensorMetrics", "value": "", "type": "query", "description": "Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices." }, { "name": "sensorAlertProfileIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices." }, { "name": "models", "value": "", "type": "query", "description": "Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match." } ] }, "docs": "List the devices in an organization that have been assigned to a network." }, { "info": { "name": "List the availability information for devices in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/availabilities", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by network ID. This filter uses multiple exact matches." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by device product types. This filter uses multiple exact matches. Valid types are wireless, appliance, switch, camera, cellularGateway, sensor, wirelessController, and campusGateway" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by device serial numbers. This filter uses multiple exact matches." }, { "name": "tags", "value": "", "type": "query", "description": "An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). This filter uses multiple exact matches." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." }, { "name": "statuses", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by device status. This filter uses multiple exact matches." } ] }, "docs": "List the availability information for devices in an organization. The data returned by this endpoint is updated every 5 minutes." }, { "info": { "name": "List the availability history information for devices in an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/availabilities/changeHistory", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by device serial numbers" }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by device product types" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by network IDs" }, { "name": "statuses", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by device statuses" } ] }, "docs": "List the availability history information for devices in an organization." }, { "info": { "name": "List devices eligible for Cellular Data Management profile assignment in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/devices", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "includeAssigned", "value": "", "type": "query", "description": "Whether to include devices that have already been assigned to a Cellular Data Management Profile" }, { "name": "includedSerials", "value": "", "type": "query", "description": "List of device serials to force-include in the response when the devices would otherwise be filtered out. This override is primarily useful for keeping selected devices visible while paging through results. Maximum 1000 serials." }, { "name": "excludedSerials", "value": "", "type": "query", "description": "List of device serials to force-exclude from the response when the devices would otherwise be returned. This override is primarily useful for hiding selected devices while paging through results. Maximum 1000 serials." }, { "name": "includedProfileIds", "value": "", "type": "query", "description": "List of Cellular Data Management Profile IDs to include in the results. Maximum 1000 profile IDs." }, { "name": "excludedProfileIds", "value": "", "type": "query", "description": "List of Cellular Data Management Profile IDs to exclude from the results. Maximum 1000 profile IDs." }, { "name": "deviceTypes", "value": "", "type": "query", "description": "List of device types to filter by. Maximum 1000 device types." }, { "name": "slots", "value": "", "type": "query", "description": "List of SIM slot types that devices must support. Accepted values are sim1, sim2, and esim. Maximum 3 slots." }, { "name": "name", "value": "", "type": "query", "description": "Name of the device to filter by (partial matches allowed)" }, { "name": "serials", "value": "", "type": "query", "description": "List of device serials to filter by. Maximum 1000 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List devices eligible for Cellular Data Management profile assignment in this organization. Returns paginated device assignment candidates with current profile, software version, modem, and SIM details. Supports filtering by device serials, profile IDs, device types, and supported SIM slots." }, { "info": { "name": "List cellular data management profiles in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "profileIds", "value": "", "type": "query", "description": "Optional parameter to filter the results by Data Management Profile ID." }, { "name": "serials", "value": "", "type": "query", "description": "Devices to find Cellular Data Management Profiles for." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List cellular data management profiles in this organization. Returns each configured cellular data management profile in this organization, including its rules and assigned-device summary counts. Supports filtering by `profileIds` and `serials` and uses cursor pagination." }, { "info": { "name": "Add a cellular data management profile to this organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add a cellular data management profile to this organization. Creates a cellular data management profile in this organization and returns the created profile, including its rules and actions." }, { "info": { "name": "List Cellular Data Management Profile assignments in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles/assignments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "profileIds", "value": "", "type": "query", "description": "Optional parameter to find assignments by Profile IDs. Maximum 1000 profile IDs." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to find assignments by Device Serials. Maximum 1000 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List Cellular Data Management Profile assignments in this organization. Returns paginated device-to-profile assignments and supports filtering by profile IDs and device serials." }, { "info": { "name": "Assign devices to a Cellular Data Management Profile in batch", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles/assignments/batchCreate", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign devices to a Cellular Data Management Profile in batch. Creates up to 100 device-to-profile assignments and returns the created assignment IDs." }, { "info": { "name": "Unassign devices from a Cellular Data Management Profile in batch", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles/assignments/bulkDelete", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Unassign devices from a Cellular Data Management Profile in batch. Removes up to 100 device-to-profile assignments and returns no response body on success." }, { "info": { "name": "Update a Cellular Data Management Profile", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles/:profileId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "profileId", "value": "", "type": "path", "description": "Profile ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a Cellular Data Management Profile. Note that changes made to this endpoint will overwrite existing settings for the profile so the entire profile, rules and actions should be sent when making an update." }, { "info": { "name": "Delete a cellular data management profile from this organization", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/profiles/:profileId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "profileId", "value": "", "type": "path", "description": "Profile ID" } ] }, "docs": "Delete a cellular data management profile from this organization. Removes the profile, including its associated rules and node assignments, and notifies affected devices of the resulting configuration change." }, { "info": { "name": "List current cellular data usage for devices in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/usage/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serials", "value": "", "type": "query", "description": "Filter the results by device serials. Maximum 1000 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List current cellular data usage for devices in this organization. Returns a paginated per-device view of current SIM usage in each device's current usage period (as set by the device's configuration). Supports filtering by device serials." }, { "info": { "name": "List historical cellular data usage grouped by device and interval in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/data/usage/history/byDevice/byInterval", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serials", "value": "", "type": "query", "description": "Required parameter to filter the results by device serials. Maximum 10 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 10. Default is 5." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 366 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 1 day. If interval is provided, the timespan will be autocalculated." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 300, 1200, 14400, 86400. The default is 86400. Interval is calculated if time params are provided." } ] }, "docs": "List historical cellular data usage grouped by device and interval in this organization. Returns a paginated per-device time series with per-SIM totals and supports the standard t0, t1, timespan, and interval query parameters." }, { "info": { "name": "List the latest cellular geolocation telemetry for devices in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/geolocations", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter the results by device serials. Maximum 1000 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the latest cellular geolocation telemetry for devices in an organization. Data is refreshed at most once every 90 minutes." }, { "info": { "name": "List the latest cellular uplink signal information for devices in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/uplinks/bands/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter the results by device serials. Maximum 1000 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the latest cellular uplink signal information for devices in an organization. Data is refreshed at most once every 90 minutes." }, { "info": { "name": "List the latest cellular tower information for devices in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/cellular/uplinks/towers/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter the results by device serials. Maximum 1000 serials." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the latest cellular tower information for devices in an organization. Data is refreshed at most once every 90 minutes." }, { "info": { "name": "Retrieve device migration statuses in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/controller/migrations", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serials", "value": "", "type": "query", "description": "A list of Meraki Serials for which to retrieve migrations" }, { "name": "networkIds", "value": "", "type": "query", "description": "Filter device migrations by network IDs" }, { "name": "target", "value": "", "type": "query", "description": "Filter device migrations by target destination" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "Retrieve device migration statuses in an organization" }, { "info": { "name": "Migrate devices to another controller or management mode", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/controller/migrations", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Migrate devices to another controller or management mode" }, { "info": { "name": "Updating device details (currently only used for Catalyst devices)", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/details/bulkUpdate", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updating device details (currently only used for Catalyst devices)" }, { "info": { "name": "Lists the count for each device model", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/overview/byModel", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "models", "value": "", "type": "query", "description": "Optional parameter to filter devices by one or more models. All returned devices will have a model that is an exact match." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by networkId." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device by device product types. This filter uses multiple exact matches." } ] }, "docs": "Lists the count for each device model" }, { "info": { "name": "List Packet Captures", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "captureIds", "value": "", "type": "query", "description": "Return the packet captures of the specified capture ids" }, { "name": "networkIds", "value": "", "type": "query", "description": "Return the packet captures of the specified network(s)" }, { "name": "serials", "value": "", "type": "query", "description": "Return the packet captures of the specified device(s)" }, { "name": "process", "value": "", "type": "query", "description": "Return the packet captures of the specified process" }, { "name": "captureStatus", "value": "", "type": "query", "description": "Return the packet captures of the specified capture status" }, { "name": "name", "value": "", "type": "query", "description": "Return the packet captures matching the specified name" }, { "name": "clientMac", "value": "", "type": "query", "description": "Return the packet captures matching the specified client macs" }, { "name": "notes", "value": "", "type": "query", "description": "Return the packet captures matching the specified notes" }, { "name": "deviceName", "value": "", "type": "query", "description": "Return the packet captures matching the specified device name" }, { "name": "adminName", "value": "", "type": "query", "description": "Return the packet captures matching the admin name" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 365 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 365 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 365 days. The default is 365 days." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "Sorted order of entries. Order options are 'ascending' and 'descending'. Default is 'descending'." } ] }, "docs": "List Packet Captures. The current license level allows storage of up to 10 capture files in the cloud. When this limit is reached and a new capture is taken, the oldest capture will be automatically deleted to ensure sufficient space. Additional storage for switches will be available with an advantage license at a future date. These future capabilities will be consistent with what is available today via advantage licensing for access points." }, { "info": { "name": "Perform a packet capture on a device and store in Meraki Cloud", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Perform a packet capture on a device and store in Meraki Cloud. Only a single switch may be chosen per request, while multiple access points are allowed at once." }, { "info": { "name": "Perform a packet capture on multiple devices and store in Meraki Cloud.", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures/bulkCreate", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Perform a packet capture on multiple devices and store in Meraki Cloud." }, { "info": { "name": "BulkDelete packet captures from cloud", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures/bulkDelete", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "BulkDelete packet captures from cloud" }, { "info": { "name": "Delete a single packet capture from cloud using captureId", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures/:captureId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "captureId", "value": "", "type": "path", "description": "Capture ID" } ] }, "docs": "Delete a single packet capture from cloud using captureId" }, { "info": { "name": "Get presigned download URL for given packet capture id", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures/:captureId/downloadUrl/generate", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "captureId", "value": "", "type": "path", "description": "Capture ID" } ] }, "docs": "Get presigned download URL for given packet capture id" }, { "info": { "name": "Stop a specific packet capture (not supported for Catalyst devices)", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/captures/:captureId/stop", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "captureId", "value": "", "type": "path", "description": "Capture ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Stop a specific packet capture (not supported for Catalyst devices)" }, { "info": { "name": "List the Packet Capture Schedules", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/schedules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "scheduleIds", "value": "", "type": "query", "description": "Return the packet captures schedules of the specified packet capture schedule ids" }, { "name": "networkIds", "value": "", "type": "query", "description": "Return the scheduled packet captures of the specified network(s)" }, { "name": "deviceIds", "value": "", "type": "query", "description": "Return the scheduled packet captures of the specified device(s)" } ] }, "docs": "List the Packet Capture Schedules" }, { "info": { "name": "Create a schedule for packet capture", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/schedules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a schedule for packet capture" }, { "info": { "name": "Bulk update priorities of pcap schedules", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/schedules/reorder", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Bulk update priorities of pcap schedules" }, { "info": { "name": "Update a schedule for packet capture", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/schedules/:scheduleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "scheduleId", "value": "", "type": "path", "description": "Schedule ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a schedule for packet capture" }, { "info": { "name": "Delete schedule from cloud", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/packetCapture/schedules/:scheduleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "scheduleId", "value": "", "type": "path", "description": "Schedule ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete schedule from cloud" }, { "info": { "name": "List the most recent status information for power modules in rackmount MX and MS devices that support them", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/powerModules/statuses/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by network ID. This filter uses multiple exact matches." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by device product types. This filter uses multiple exact matches." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by device serial numbers. This filter uses multiple exact matches." }, { "name": "tags", "value": "", "type": "query", "description": "An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). This filter uses multiple exact matches." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." } ] }, "docs": "List the most recent status information for power modules in rackmount MX and MS devices that support them. The data returned by this endpoint is updated every 5 minutes." }, { "info": { "name": "List the provisioning statuses information for devices in an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/provisioning/statuses", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter device by network ID. This filter uses multiple exact matches." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device by device product types. This filter uses multiple exact matches." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device by device serial numbers. This filter uses multiple exact matches." }, { "name": "status", "value": "", "type": "query", "description": "An optional parameter to filter devices by the provisioning status. Accepted statuses: unprovisioned, incomplete, complete." }, { "name": "tags", "value": "", "type": "query", "description": "An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). This filter uses multiple exact matches." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." } ] }, "docs": "List the provisioning statuses information for devices in an organization." }, { "info": { "name": "List the status of every Meraki device in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/statuses", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by network ids." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter devices by serials." }, { "name": "statuses", "value": "", "type": "query", "description": "Optional parameter to filter devices by statuses. Valid statuses are [\"online\", \"alerting\", \"offline\", \"dormant\"]." }, { "name": "productTypes", "value": "", "type": "query", "description": "An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect." }, { "name": "models", "value": "", "type": "query", "description": "Optional parameter to filter devices by models." }, { "name": "tags", "value": "", "type": "query", "description": "An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below)." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." } ] }, "docs": "List the status of every Meraki device in the organization" }, { "info": { "name": "Return an overview of current device statuses", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/statuses/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "productTypes", "value": "", "type": "query", "description": "An optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect." }, { "name": "networkIds", "value": "", "type": "query", "description": "An optional parameter to filter device statuses by network." } ] }, "docs": "Return an overview of current device statuses" }, { "info": { "name": "Returns syslog servers configured for the networks within an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/syslog/servers/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "IDs of the networks for which to fetch syslog servers; suggested maximum array size is 100" } ] }, "docs": "Returns syslog servers configured for the networks within an organization." }, { "info": { "name": "Returns roles that can be assigned to a syslog server for a given network.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/syslog/servers/roles/byNetwork", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "IDs of the networks for which to fetch valid syslog server roles; suggested maximum array size is 100" } ] }, "docs": "Returns roles that can be assigned to a syslog server for a given network." }, { "info": { "name": "Return the memory utilization history in kB for devices in the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/system/memory/usage/history/byInterval", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 20. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 31 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 31 days. The default is 2 hours. If interval is provided, the timespan will be autocalculated." }, { "name": "interval", "value": "", "type": "query", "description": "The time interval in seconds for returned data. The valid intervals are: 300, 1200, 3600, 14400. The default is 300. Interval is calculated if time params are provided." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter the result set by the included set of network IDs" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities history by device serial numbers" }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device statuses by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway, and secureConnect." } ] }, "docs": "Return the memory utilization history in kB for devices in the organization." }, { "info": { "name": "List the current uplink addresses for devices in an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/uplinks/addresses/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter device uplinks by network ID. This filter uses multiple exact matches." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter device uplinks by device product types. This filter uses multiple exact matches." }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter device availabilities by device serial numbers. This filter uses multiple exact matches." }, { "name": "tags", "value": "", "type": "query", "description": "An optional parameter to filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below). This filter uses multiple exact matches." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return devices which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." } ] }, "docs": "List the current uplink addresses for devices in an organization." }, { "info": { "name": "Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/devices/uplinksLossAndLatency", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 60 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 5 minutes after t0. The latest possible time that t1 can be is 2 minutes into the past." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 5 minutes. The default is 5 minutes." }, { "name": "uplink", "value": "", "type": "query", "description": "Optional filter for a specific WAN uplink. Valid uplinks are wan1, wan2, wan3, cellular. Default will return all uplinks." }, { "name": "ip", "value": "", "type": "query", "description": "Optional filter for a specific destination IP. Default will return all destination IPs." } ] }, "docs": "Return the uplink loss and latency for every MX in the organization from at latest 2 minutes ago" }, { "info": { "name": "List the available early access features for organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/earlyAccess/features", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List the available early access features for organization" }, { "info": { "name": "List the early access feature opt-ins for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/earlyAccess/features/optIns", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List the early access feature opt-ins for an organization" }, { "info": { "name": "Create a new early access feature opt-in for an organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/earlyAccess/features/optIns", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new early access feature opt-in for an organization" }, { "info": { "name": "Show an early access feature opt-in for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/earlyAccess/features/optIns/:optInId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "optInId", "value": "", "type": "path", "description": "Opt in ID" } ] }, "docs": "Show an early access feature opt-in for an organization" }, { "info": { "name": "Update an early access feature opt-in for an organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/earlyAccess/features/optIns/:optInId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "optInId", "value": "", "type": "path", "description": "Opt in ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an early access feature opt-in for an organization" }, { "info": { "name": "Delete an early access feature opt-in", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/earlyAccess/features/optIns/:optInId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "optInId", "value": "", "type": "path", "description": "Opt in ID" } ] }, "docs": "Delete an early access feature opt-in" }, { "info": { "name": "Get firmware upgrade information for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/firmware/upgrades", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "status", "value": "", "type": "query", "description": "Optional parameter to filter the upgrade by status." }, { "name": "productTypes", "value": "", "type": "query", "description": "Optional parameter to filter the upgrade by product type." } ] }, "docs": "Get firmware upgrade information for an organization" }, { "info": { "name": "Get firmware upgrade status for the filtered devices", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/firmware/upgrades/byDevice", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter by network" }, { "name": "serials", "value": "", "type": "query", "description": "Optional parameter to filter by serial number. All returned devices will have a serial number that is an exact match." }, { "name": "macs", "value": "", "type": "query", "description": "Optional parameter to filter by one or more MAC addresses belonging to devices. All devices returned belong to MAC addresses that are an exact match." }, { "name": "firmwareUpgradeBatchIds", "value": "", "type": "query", "description": "Optional parameter to filter by firmware upgrade batch ids." }, { "name": "upgradeStatuses", "value": "", "type": "query", "description": "Optional parameter to filter by firmware upgrade statuses." }, { "name": "currentUpgradesOnly", "value": "", "type": "query", "description": "Optional parameter to filter to only current or pending upgrade statuses." }, { "name": "limitPerDevice", "value": "", "type": "query", "description": "Optional parameter to limit the number of upgrade statuses returned per device. If omitted, a value of 5 is used." } ] }, "docs": "Get firmware upgrade status for the filtered devices. This endpoint currently only supports Meraki switches and access points." }, { "info": { "name": "List auto locate details for each device in your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/floorPlans/autoLocate/devices", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 10000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by one or more network IDs" }, { "name": "floorPlanIds", "value": "", "type": "query", "description": "Optional parameter to filter devices by one or more floorplan IDs" } ] }, "docs": "List auto locate details for each device in your organization" }, { "info": { "name": "List the status of auto locate for each floorplan in your organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/floorPlans/autoLocate/statuses", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 10000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter floorplans by one or more network IDs" }, { "name": "floorPlanIds", "value": "", "type": "query", "description": "Optional parameter to filter floorplans by one or more floorplan IDs" } ] }, "docs": "List the status of auto locate for each floorplan in your organization" }, { "info": { "name": "Provides a list of integrations that can be enabled for an Organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/integrations/deployable", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Provides a list of integrations that can be enabled for an Organization." }, { "info": { "name": "Provides a list of integrations enabled for an Organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/integrations/deployed", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Provides a list of integrations enabled for an Organization." }, { "info": { "name": "Returns the networks in the organization that have XDR enabled", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/integrations/xdr/networks", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkIds", "value": "", "type": "query", "description": "Optional parameter to filter the results by network IDs" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100. Default is 20." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "Returns the networks in the organization that have XDR enabled" }, { "info": { "name": "Disable XDR on networks", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/integrations/xdr/networks/disable", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Disable XDR on networks" }, { "info": { "name": "Enable XDR on networks", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/integrations/xdr/networks/enable", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Enable XDR on networks" }, { "info": { "name": "Claim a list of devices, licenses, and/or orders into an organization inventory", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/claim", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Claim a list of devices, licenses, and/or orders into an organization inventory. 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. This operation can be used up to ten times within a single five minute window." }, { "info": { "name": "Return the device inventory for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/devices", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "usedState", "value": "", "type": "query", "description": "Filter results by used or unused inventory. Accepted values are 'used' or 'unused'." }, { "name": "search", "value": "", "type": "query", "description": "Search for devices in inventory based on serial number, mac address, or model." }, { "name": "macs", "value": "", "type": "query", "description": "Search for devices in inventory based on mac addresses." }, { "name": "networkIds", "value": "", "type": "query", "description": "Search for devices in inventory based on network ids. Use explicit 'null' value to get available devices only." }, { "name": "serials", "value": "", "type": "query", "description": "Search for devices in inventory based on serials." }, { "name": "models", "value": "", "type": "query", "description": "Search for devices in inventory based on model." }, { "name": "orderNumbers", "value": "", "type": "query", "description": "Search for devices in inventory based on order numbers." }, { "name": "tags", "value": "", "type": "query", "description": "Filter devices by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below)." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "To use with 'tags' parameter, to filter devices which contain ANY or ALL given tags. Accepted values are 'withAnyTags' or 'withAllTags', default is 'withAnyTags'." }, { "name": "productTypes", "value": "", "type": "query", "description": "Filter devices by product type. Accepted values are appliance, camera, campusGateway, cellularGateway, secureConnect, sensor, switch, systemsManager, wireless, and wirelessController." }, { "name": "eoxStatuses", "value": "", "type": "query", "description": "Filter devices by EoX status. Accepted values are 'endOfSale', 'endOfSupport', 'nearEndOfSupport', or 'null'. Use 'null' to filter for devices with no EOX data. Supports multiple values for multi-select filtering." } ] }, "docs": "Return the device inventory for an organization" }, { "info": { "name": "Fetch the EOX summary for an organization, including counts of devices that are end-of-sale, end-of-support, and end-of-support-soon.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/devices/eox/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Fetch the EOX summary for an organization, including counts of devices that are end-of-sale, end-of-support, and end-of-support-soon." }, { "info": { "name": "Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old.", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/devices/swaps/bulk", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old." }, { "info": { "name": "List of device swaps for a given request ID ({id}).", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/devices/swaps/bulk/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "List of device swaps for a given request ID ({id})." }, { "info": { "name": "Return a single device from the inventory of an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/devices/:serial", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "serial", "value": "", "type": "path", "description": "Serial" } ] }, "docs": "Return a single device from the inventory of an organization" }, { "info": { "name": "Claim an order by the secure unique order claim number, the order claim id", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/orders/claim", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Claim an order by the secure unique order claim number, the order claim id" }, { "info": { "name": "Preview the results and status of an order claim by the secure order id", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/orders/preview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Preview the results and status of an order claim by the secure order id" }, { "info": { "name": "Release a list of claimed devices from an organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/inventory/release", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Release a list of claimed devices from an organization." }, { "info": { "name": "List the licenses for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "deviceSerial", "value": "", "type": "query", "description": "Filter the licenses to those assigned to a particular device. Returned in the same order that they are queued to the device." }, { "name": "networkId", "value": "", "type": "query", "description": "Filter the licenses to those assigned in a particular network" }, { "name": "state", "value": "", "type": "query", "description": "Filter the licenses to those in a particular state. Can be one of 'active', 'expired', 'expiring', 'recentlyQueued', 'unused' or 'unusedActive'" } ] }, "docs": "List the licenses for an organization" }, { "info": { "name": "Assign SM seats to a network", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/assignSeats", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign SM seats to a network. This will increase the managed SM device limit of the network" }, { "info": { "name": "Move licenses to another organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/move", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move licenses to another organization. This will also move any devices that the licenses are assigned to" }, { "info": { "name": "Move SM seats to another organization", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/moveSeats", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move SM seats to another organization" }, { "info": { "name": "Return an overview of the license state for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Return an overview of the license state for an organization" }, { "info": { "name": "Renew SM seats of a license", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/renewSeats", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Renew SM seats of a license. This will extend the license expiration date of managed SM devices covered by this license" }, { "info": { "name": "Display a license", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/:licenseId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "licenseId", "value": "", "type": "path", "description": "License ID" } ] }, "docs": "Display a license" }, { "info": { "name": "Update a license", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/licenses/:licenseId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "licenseId", "value": "", "type": "path", "description": "License ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a license" }, { "info": { "name": "Returns the login security settings for an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/loginSecurity", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Returns the login security settings for an organization." }, { "info": { "name": "Update the login security settings for an organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/loginSecurity", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the login security settings for an organization" }, { "info": { "name": "List the networks that the user has privileges on in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/networks", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "configTemplateId", "value": "", "type": "query", "description": "An optional parameter that is the ID of a config template. Will return all networks bound to that template." }, { "name": "isBoundToConfigTemplate", "value": "", "type": "query", "description": "An optional parameter to filter config template bound networks. If configTemplateId is set, this cannot be false." }, { "name": "tags", "value": "", "type": "query", "description": "An optional parameter to filter networks by tags. The filtering is case-sensitive. If tags are included, 'tagsFilterType' should also be included (see below)." }, { "name": "tagsFilterType", "value": "", "type": "query", "description": "An optional parameter of value 'withAnyTags' or 'withAllTags' to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, 'withAnyTags' will be selected." }, { "name": "productTypes", "value": "", "type": "query", "description": "An optional parameter to filter networks by product type. Results will have at least one of the included product types." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the networks that the user has privileges on in an organization" }, { "info": { "name": "Create a network", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/networks", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a network" }, { "info": { "name": "Combine multiple networks into a single network", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/networks/combine", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Combine multiple networks into a single network" }, { "info": { "name": "Return a list of network move operations in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/networks/moves", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 10 - 100. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "moveIds", "value": "", "type": "query", "description": "Array of network move operation IDs to include. If not specified, all network moves will be returned." } ] }, "docs": "Return a list of network move operations in the organization" }, { "info": { "name": "Move networks from one organization to another", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/networks/moves", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Move networks from one organization to another. For more information and caveats around network move limitations see the Network Portability documentation." }, { "info": { "name": "Return the OpenAPI Specification of the organization's API documentation in JSON", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/openapiSpec", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "version", "value": "", "type": "query", "description": "OpenAPI Specification version to return. Default is 2" } ] }, "docs": "Return the OpenAPI Specification of the organization's API documentation in JSON" }, { "info": { "name": "Get policies for all clients with policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/assignments/byClient", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 31 days from today." }, { "name": "timespan", "value": "", "type": "query", "description": "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." }, { "name": "includeUndetectedClients", "value": "", "type": "query", "description": "Include provisioned clients that have not associated to the network. Default: false" }, { "name": "networkIds", "value": "", "type": "query", "description": "Network Ids (minimum: 1, maximum: 30)" } ] }, "docs": "Get policies for all clients with policies" }, { "info": { "name": "List application categories with their associated applications", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/applicationCategories", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List application categories with their associated applications" }, { "info": { "name": "List Organization-Wide Policy Firewall Rulesets", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "rulesetIds", "value": "", "type": "query", "description": "Filter rulesets by IDs" }, { "name": "name", "value": "", "type": "query", "description": "Filter rulesets by name (partial match, case-insensitive). If multiple instances are provided, only the last one is used." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List Organization-Wide Policy Firewall Rulesets" }, { "info": { "name": "Create an Organization-Wide Policy Firewall Ruleset", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Organization-Wide Policy Firewall Ruleset" }, { "info": { "name": "List Organization-Wide Policy Firewall Rules", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "rulesetIds", "value": "", "type": "query", "description": "Filter rules by firewall ruleset IDs" }, { "name": "ruleIds", "value": "", "type": "query", "description": "Filter rules by rule IDs" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List Organization-Wide Policy Firewall Rules" }, { "info": { "name": "Create an Organization-Wide Policy Firewall Rule", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets/rules", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Organization-Wide Policy Firewall Rule" }, { "info": { "name": "Update an Organization-Wide Policy Firewall Rule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "Rule ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Organization-Wide Policy Firewall Rule" }, { "info": { "name": "Delete an Organization-Wide Policy Firewall Rule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets/rules/:ruleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "ruleId", "value": "", "type": "path", "description": "Rule ID" } ] }, "docs": "Delete an Organization-Wide Policy Firewall Rule" }, { "info": { "name": "Update an Organization-Wide Policy Firewall Ruleset", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets/:rulesetId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "rulesetId", "value": "", "type": "path", "description": "Ruleset ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Organization-Wide Policy Firewall Ruleset" }, { "info": { "name": "Delete an Organization-Wide Policy Firewall Ruleset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/firewall/rulesets/:rulesetId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "rulesetId", "value": "", "type": "path", "description": "Ruleset ID" } ] }, "docs": "Delete an Organization-Wide Policy Firewall Ruleset" }, { "info": { "name": "List Organization-Wide Policies", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "name", "value": "", "type": "query", "description": "Filter policies by name (partial match, case-insensitive). If multiple instances are provided, only the last one is used." }, { "name": "policyIds", "value": "", "type": "query", "description": "Filter policies by IDs" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List Organization-Wide Policies" }, { "info": { "name": "Create an Organization-Wide Policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Organization-Wide Policy" }, { "info": { "name": "Assign adaptive policy groups to a policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/adaptivePolicyGroups/assign", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Assign adaptive policy groups to a policy" }, { "info": { "name": "List adaptive policy group assignments", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/adaptivePolicyGroups/assignments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "assignmentIds", "value": "", "type": "query", "description": "Filter assignments by assignment IDs" }, { "name": "policyIds", "value": "", "type": "query", "description": "Filter assignments by policy IDs" }, { "name": "adaptivePolicyGroupIds", "value": "", "type": "query", "description": "Filter assignments by adaptive policy group IDs" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List adaptive policy group assignments" }, { "info": { "name": "Remove adaptive policy groups from a policy", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/adaptivePolicyGroups/remove", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Remove adaptive policy groups from a policy" }, { "info": { "name": "List Organization-Wide Policy Ruleset Assignments", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/firewall/rulesets/assignments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "rulesetIds", "value": "", "type": "query", "description": "Filter assignments by ruleset IDs" }, { "name": "policyIds", "value": "", "type": "query", "description": "Filter assignments by policy IDs" }, { "name": "assignmentIds", "value": "", "type": "query", "description": "Filter assignments by assignment IDs" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 100. Default is 100." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List Organization-Wide Policy Ruleset Assignments" }, { "info": { "name": "Create an Organization-Wide Policy Ruleset Assignment", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/firewall/rulesets/assignments", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create an Organization-Wide Policy Ruleset Assignment" }, { "info": { "name": "Update an Organization-Wide Policy Ruleset Assignment", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/firewall/rulesets/assignments/:assignmentId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "assignmentId", "value": "", "type": "path", "description": "Assignment ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Organization-Wide Policy Ruleset Assignment" }, { "info": { "name": "Delete an Organization-Wide Policy Ruleset Assignment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/firewall/rulesets/assignments/:assignmentId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "assignmentId", "value": "", "type": "path", "description": "Assignment ID" } ] }, "docs": "Delete an Organization-Wide Policy Ruleset Assignment" }, { "info": { "name": "Update an Organization-Wide Policy", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/:policyId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an Organization-Wide Policy" }, { "info": { "name": "Delete an Organization-Wide Policy", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policies/global/group/policies/:policyId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyId", "value": "", "type": "path", "description": "Policy ID" } ] }, "docs": "Delete an Organization-Wide Policy" }, { "info": { "name": "Lists Policy Objects belonging to the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 10 - 5000. Default is 5000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "Lists Policy Objects belonging to the organization." }, { "info": { "name": "Creates a new Policy Object", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Policy Object. Note: type `ipAndMask` is deprecated; use `cidr`." }, { "info": { "name": "Lists Policy Object Groups belonging to the organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/groups", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 10 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "Lists Policy Object Groups belonging to the organization." }, { "info": { "name": "Creates a new Policy Object Group.", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/groups", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new Policy Object Group." }, { "info": { "name": "Shows details of a Policy Object Group.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/groups/:policyObjectGroupId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyObjectGroupId", "value": "", "type": "path", "description": "Policy object group ID" } ] }, "docs": "Shows details of a Policy Object Group." }, { "info": { "name": "Updates a Policy Object Group.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/groups/:policyObjectGroupId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyObjectGroupId", "value": "", "type": "path", "description": "Policy object group ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Policy Object Group." }, { "info": { "name": "Deletes a Policy Object Group.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/groups/:policyObjectGroupId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyObjectGroupId", "value": "", "type": "path", "description": "Policy object group ID" } ] }, "docs": "Deletes a Policy Object Group." }, { "info": { "name": "Shows details of a Policy Object.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/:policyObjectId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyObjectId", "value": "", "type": "path", "description": "Policy object ID" } ] }, "docs": "Shows details of a Policy Object." }, { "info": { "name": "Updates a Policy Object", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/:policyObjectId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyObjectId", "value": "", "type": "path", "description": "Policy object ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a Policy Object. Note: type `ipAndMask` is deprecated; use `cidr`." }, { "info": { "name": "Deletes a Policy Object.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/policyObjects/:policyObjectId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "policyObjectId", "value": "", "type": "path", "description": "Policy object ID" } ] }, "docs": "Deletes a Policy Object." }, { "info": { "name": "Returns the SAML SSO enabled settings for an organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Returns the SAML SSO enabled settings for an organization." }, { "info": { "name": "Updates the SAML SSO enabled settings for an organization.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the SAML SSO enabled settings for an organization." }, { "info": { "name": "List the SAML IdPs in your organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml/idps", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List the SAML IdPs in your organization." }, { "info": { "name": "Create a SAML IdP for your organization.", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml/idps", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a SAML IdP for your organization." }, { "info": { "name": "Get a SAML IdP from your organization.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml/idps/:idpId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "idpId", "value": "", "type": "path", "description": "Idp ID" } ] }, "docs": "Get a SAML IdP from your organization." }, { "info": { "name": "Update a SAML IdP in your organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml/idps/:idpId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "idpId", "value": "", "type": "path", "description": "Idp ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a SAML IdP in your organization" }, { "info": { "name": "Remove a SAML IdP in your organization.", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/saml/idps/:idpId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "idpId", "value": "", "type": "path", "description": "Idp ID" } ] }, "docs": "Remove a SAML IdP in your organization." }, { "info": { "name": "List the SAML roles for this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/samlRoles", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List the SAML roles for this organization" }, { "info": { "name": "Create a SAML role", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/samlRoles", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a SAML role" }, { "info": { "name": "Return a SAML role", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/samlRoles/:samlRoleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "samlRoleId", "value": "", "type": "path", "description": "Saml role ID" } ] }, "docs": "Return a SAML role" }, { "info": { "name": "Update a SAML role", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/samlRoles/:samlRoleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "samlRoleId", "value": "", "type": "path", "description": "Saml role ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a SAML role" }, { "info": { "name": "Remove a SAML role", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/samlRoles/:samlRoleId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "samlRoleId", "value": "", "type": "path", "description": "Saml role ID" } ] }, "docs": "Remove a SAML role" }, { "info": { "name": "List SSE Connectors for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/connectors", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List SSE Connectors for an organization" }, { "info": { "name": "Delete SSE Connectors by ID", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/connectors/batchDelete", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete SSE Connectors by ID" }, { "info": { "name": "Create a new Secure Access integration", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/integrations", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new Secure Access integration" }, { "info": { "name": "Get details of a Secure Access integration", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/integrations/:integrationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Get details of a Secure Access integration" }, { "info": { "name": "Remove a Secure Access integration", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/integrations/:integrationId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "integrationId", "value": "", "type": "path", "description": "Integration ID" } ] }, "docs": "Remove a Secure Access integration" }, { "info": { "name": "List of MX networks or templates that can be enrolled into Secure Access", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/networks/eligible", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 5." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "search", "value": "", "type": "query", "description": "If provided, filters results by network name" } ] }, "docs": "List of MX networks or templates that can be enrolled into Secure Access" }, { "info": { "name": "List regions", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/regions", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List regions" }, { "info": { "name": "List of enrolled SASE sites in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/sites", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 10." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "search", "value": "", "type": "query", "description": "If provided, filters results by search string" }, { "name": "status", "value": "", "type": "query", "description": "If provided, filters results by site status label (e.g., 'good')" }, { "name": "siteId", "value": "", "type": "query", "description": "If provided, returns only the site matching this ID" } ] }, "docs": "List of enrolled SASE sites in this organization" }, { "info": { "name": "Attach sites in this organization to Secure Access", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/sites/attach", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Attach sites in this organization to Secure Access. For an organization, a maximum of 2500 sites can be attached if they are in spoke mode or a maximum of 10 sites can be attached in hub mode." }, { "info": { "name": "Get the connectivity history of SASE sites in this organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/sites/connectivity/history/bySite", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "siteIds", "value": "", "type": "query", "description": "Array of site IDs to fetch connectivity status data (maximum 100 values)" }, { "name": "timespan", "value": "", "type": "query", "description": "Timespan for the status data (e.g., '-2hours')" } ] }, "docs": "Get the connectivity history of SASE sites in this organization" }, { "info": { "name": "List high-level SASE site statuses (healthy, degraded, offline)", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/sites/connectivity/overview", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List high-level SASE site statuses (healthy, degraded, offline)" }, { "info": { "name": "Detach sites in this organization from Secure Access", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/sites/detach", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Detach sites in this organization from Secure Access. This will remove the sites from Secure Access." }, { "info": { "name": "Update the configuration for a site", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/sase/sites/:siteId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "siteId", "value": "", "type": "path", "description": "Site ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the configuration for a site. Currently, only supports updating default route enablement." }, { "info": { "name": "Return the SNMP settings for an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/snmp", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "Return the SNMP settings for an organization" }, { "info": { "name": "Update the SNMP settings for an organization", "type": "http" }, "http": { "method": "PUT", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/snmp", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the SNMP settings for an organization" }, { "info": { "name": "Get a Splash Theme Asset", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/splash/assets/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Get a Splash Theme Asset" }, { "info": { "name": "Delete a Splash Theme Asset", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/splash/assets/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Delete a Splash Theme Asset" }, { "info": { "name": "List Splash Themes", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/splash/themes", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ] }, "docs": "List Splash Themes" }, { "info": { "name": "Create a Splash Theme", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/splash/themes", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Splash Theme" }, { "info": { "name": "Delete a Splash Theme", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/splash/themes/:id", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "id", "value": "", "type": "path", "description": "ID" } ] }, "docs": "Delete a Splash Theme" }, { "info": { "name": "Create a Splash Theme Asset", "type": "http" }, "http": { "method": "POST", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/splash/themes/:themeIdentifier/assets", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "themeIdentifier", "value": "", "type": "path", "description": "Theme identifier" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a Splash Theme Asset" }, { "info": { "name": "Return the top 10 appliances sorted by utilization over given time range.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/appliances/byUtilization", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return the top 10 appliances sorted by utilization over given time range." }, { "info": { "name": "Return the top applications sorted by data usage over given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/applications/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "device", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "networkId", "value": "", "type": "query", "description": "Match result to an exact network id" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return the top applications sorted by data usage over given time range. Default unit is megabytes." }, { "info": { "name": "Return the top application categories sorted by data usage over given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/applications/categories/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "networkId", "value": "", "type": "query", "description": "Match result to an exact network id" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return the top application categories sorted by data usage over given time range. Default unit is megabytes." }, { "info": { "name": "Return metrics for organization's top 10 clients by data usage (in mb) over given time range.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/clients/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return metrics for organization's top 10 clients by data usage (in mb) over given time range." }, { "info": { "name": "Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/clients/manufacturers/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer." }, { "info": { "name": "Return metrics for organization's top 10 devices sorted by data usage over given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/devices/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return metrics for organization's top 10 devices sorted by data usage over given time range. Default unit is megabytes." }, { "info": { "name": "Return metrics for organization's top 10 device models sorted by data usage over given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/devices/models/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return metrics for organization's top 10 device models sorted by data usage over given time range. Default unit is megabytes." }, { "info": { "name": "List the client and status overview information for the networks in an organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/networks/byStatus", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 5000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." } ] }, "docs": "List the client and status overview information for the networks in an organization. Usage is measured in kilobytes and from the last seven days." }, { "info": { "name": "Return metrics for organization's top 10 ssids by data usage over given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/ssids/byUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 8 hours and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return metrics for organization's top 10 ssids by data usage over given time range. Default unit is megabytes." }, { "info": { "name": "Return metrics for organization's top 10 switches by energy usage over given time range", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/summary/top/switches/byEnergyUsage", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "networkTag", "value": "", "type": "query", "description": "Match result to an exact network tag" }, { "name": "deviceTag", "value": "", "type": "query", "description": "Match result to an exact device tag" }, { "name": "quantity", "value": "", "type": "query", "description": "Set number of desired results to return. Default is 10. Maximum is 50" }, { "name": "ssidName", "value": "", "type": "query", "description": "Filter results by ssid name" }, { "name": "usageUplink", "value": "", "type": "query", "description": "Filter results by usage uplink" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 186 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be greater than or equal to 25 minutes and be less than or equal to 186 days. The default is 1 day." } ] }, "docs": "Return metrics for organization's top 10 switches by energy usage over given time range. Default unit is joules." }, { "info": { "name": "List the uplink status of every Meraki MX, MG and Z series devices in the organization", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/uplinks/statuses", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "networkIds", "value": "", "type": "query", "description": "A list of network IDs. The returned devices will be filtered to only include these networks." }, { "name": "serials", "value": "", "type": "query", "description": "A list of serial numbers. The returned devices will be filtered to only include these serials." }, { "name": "iccids", "value": "", "type": "query", "description": "A list of ICCIDs. The returned devices will be filtered to only include these ICCIDs." } ] }, "docs": "List the uplink status of every Meraki MX, MG and Z series devices in the organization" }, { "info": { "name": "Return a list of alert types to be used with managing webhook alerts", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/webhooks/alertTypes", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "productType", "value": "", "type": "query", "description": "Filter sample alerts to a specific product type" } ] }, "docs": "Return a list of alert types to be used with managing webhook alerts" }, { "info": { "name": "Return the status of an API callback", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/webhooks/callbacks/statuses/:callbackId", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "callbackId", "value": "", "type": "path", "description": "Callback ID" } ] }, "docs": "Return the status of an API callback" }, { "info": { "name": "Return the log of webhook POSTs sent", "type": "http" }, "http": { "method": "GET", "url": "https://api.meraki.com/{basePath}/organizations/:organizationId/webhooks/logs", "params": [ { "name": "organizationId", "value": "", "type": "path", "description": "Organization ID" }, { "name": "t0", "value": "", "type": "query", "description": "The beginning of the timespan for the data. The maximum lookback period is 30 days from today." }, { "name": "t1", "value": "", "type": "query", "description": "The end of the timespan for the data. t1 can be a maximum of 30 days after t0." }, { "name": "timespan", "value": "", "type": "query", "description": "The timespan for which the information will be fetched. If specifying timespan, do not specify parameters t0 and t1. The value must be in seconds and be less than or equal to 30 days. The default is 1 day." }, { "name": "perPage", "value": "", "type": "query", "description": "The number of entries per page returned. Acceptable range is 3 - 1000. Default is 50." }, { "name": "startingAfter", "value": "", "type": "query", "description": "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." }, { "name": "endingBefore", "value": "", "type": "query", "description": "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." }, { "name": "url", "value": "", "type": "query", "description": "The URL the webhook was sent to" } ] }, "docs": "Return the log of webhook POSTs sent" } ] } ], "bundled": true }