Organizations

Assign SM seats to a network.

API documentation: assignOrganizationLicensesSeats

Parameters:

• organization_id (str) –

  Organization ID.

• license_id (str) –

  The ID of the SM license to assign seats from.

• network_id (str) –

  The ID of the SM network to assign the seats to.

• seat_count (int) –

  The number of seats to assign to the SM network. Must be less than or equal to the total number of seats of the license.

Returns:

• OrganizationLicensesSeatsResponse –

  Successful operation.

{
  "resultingLicenses": [
    {
      "id": "1234",
      "licenseType": "SME",
      "licenseKey": "Z21234567890",
      "orderNumber": "4C1234567",
      "deviceSerial": "Q234-ABCD-5678",
      "networkId": "N_24329156",
      "state": "active",
      "seatCount": 25,
      "totalDurationInDays": 425,
      "durationInDays": 365,
      "permanentlyQueuedLicenses": [
        {
          "id": "1234",
          "licenseType": "SME",
          "licenseKey": "Z21234567890",
          "orderNumber": "4C1234567",
          "durationInDays": 60
        }
      ],
      "claimDate": "2019-08-29T12:40:10Z",
      "activationDate": "2019-09-01T15:01:46Z",
      "expirationDate": "2020-10-30T15:01:46Z",
      "headLicenseId": "1234"
    }
  ]
}

Assign adaptive policy groups to a policy.

API documentation: assignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroups

Parameters:

• organization_id (str) –

  Organization ID.

• policy (AssignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsPolicy) –

  Policy to assign adaptive policy groups to.

• adaptive_policy_groups (list[AssignOrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsAdaptivePolicyGroupsItem]) –

  Adaptive policy groups to assign.

Returns:

• OrganizationPoliciesGlobalGroupPoliciesAdaptivePolicyGroupsResponse –

  Successful operation.

{
  "success": true
}

Attach sites in this organization to Secure Access.

API documentation: attachOrganizationSaseSites

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[AttachOrganizationSaseSitesItemsItem] | None, default: None ) –

  List of Meraki SD-WAN sites with the associated regions to be attached.

• callback (AttachOrganizationSaseSitesCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Returns:

• GetOrganizationApiRestProvisioningPipelinesJobsOverviewsByPipelineResponse –

  Successful operation.

{
  "items": [
    {
      "pipelineId": "1234",
      "operation": {
        "id": "enrollOrganizationSaseSites"
      },
      "status": "active",
      "counts": {
        "jobs": {
          "total": 3,
          "byStatus": {
            "completed": 1,
            "failed": 1,
            "pending": 1
          }
        }
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 100,
        "remaining": 10
      }
    }
  }
}

Assign devices to a Cellular Data Management Profile in batch.

API documentation: batchOrganizationDevicesCellularDataProfilesAssignmentsCreate

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BatchOrganizationDevicesCellularDataProfilesAssignmentsCreateItemsItem]) –

  List of device-to-profile assignments to create.

Returns:

• BatchOrganizationDevicesCellularDataProfilesAssignmentsCreateResponse –

  Successful operation.

{
  "items": [
    {
      "assignmentId": "42",
      "profile": {
        "id": "1234"
      },
      "device": {
        "serial": "Q234-ABCD-5678"
      }
    }
  ]
}

Delete SSE Connectors by ID.

API documentation: batchOrganizationSaseConnectorsDelete

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BatchOrganizationSaseConnectorsDeleteItemsItem] | None, default: None ) –

  List of connectors to delete (maximum 20 items).

Returns:

• GetOrganizationApiRestProvisioningPipelinesJobsOverviewsByPipelineResponse –

  Successful operation.

{
  "items": [
    {
      "pipelineId": "1234",
      "operation": {
        "id": "enrollOrganizationSaseSites"
      },
      "status": "active",
      "counts": {
        "jobs": {
          "total": 3,
          "byStatus": {
            "completed": 1,
            "failed": 1,
            "pending": 1
          }
        }
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 100,
        "remaining": 10
      }
    }
  }
}

Unassign devices from a Cellular Data Management Profile in batch.

API documentation: bulkOrganizationDevicesCellularDataProfilesAssignmentsDelete

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[BulkOrganizationDevicesCellularDataProfilesAssignmentsDeleteItemsItem]) –

  List of device-to-profile assignments to remove.

Returns:

• None –

  Successful operation.

Perform a packet capture on multiple devices and store in Meraki Cloud.

API documentation: bulkOrganizationDevicesPacketCaptureCapturesCreate

Parameters:

• organization_id (str) –

  Organization ID.

• devices (list[BulkOrganizationDevicesPacketCaptureCapturesCreateDevicesItem]) –

  Device details (maximum of 20 devices allowed).

• notes (str | None, default: None ) –

  Reason for capture.

• duration (int | None, default: None ) –

  Duration of the capture in seconds.

• filter_expression (str | None, default: None ) –

  Filter expression for the capture.

• name (str) –

  Name of packet capture file.

• advanced (BulkOrganizationDevicesPacketCaptureCapturesCreateAdvanced | None, default: None ) –

  Advanced capture options (optional).

Returns:

• BulkOrganizationDevicesPacketCaptureCapturesCreateResponse –

  Successful operation.

{
  "items": [
    {
      "captureId": "1234",
      "network": {
        "id": "N_24329156",
        "name": "Main Office"
      },
      "device": {
        "name": "My AP",
        "serial": "Q234-ABCD-5678"
      },
      "admin": {
        "id": "1234",
        "name": "Miles Meraki"
      },
      "client": {
        "id": "k74272e",
        "mac": "22:33:44:55:66:77"
      },
      "details": [
        {
          "name": "reason",
          "value": "bad_password",
          "productType": "wireless"
        }
      ],
      "name": "file_name",
      "startTs": "2018-02-11T00:00:00.090210Z",
      "ports": "1, 2",
      "status": "new",
      "errorMessage": "Some error message",
      "destination": "upload_to_cloud",
      "process": "manual",
      "file": {
        "size": 1066
      },
      "duration": 60,
      "filterExpression": "(icmp)",
      "counts": {
        "packets": {
          "total": 10
        }
      },
      "interface": "wired"
    }
  ]
}

BulkDelete packet captures from cloud.

API documentation: bulkOrganizationDevicesPacketCaptureCapturesDelete

Parameters:

• organization_id (str) –

  Organization ID.

• capture_ids (list[str]) –

  Delete the packet captures of the specified capture ids.

Returns:

• None –

  Successful operation.

Updating device details (currently only used for Catalyst devices).

API documentation: bulkUpdateOrganizationDevicesDetails

Parameters:

• organization_id (str) –

  Organization ID.

• serials (list[str]) –

  A list of serials of devices to update.

• details (list[BulkUpdateOrganizationDevicesDetailsDetailsItem]) –

  An array of details.

Returns:

• BulkUpdateOrganizationDevicesDetailsResponse –

  Successful operation.

{
  "serials": [
    "Q234-ABCD-0001",
    "Q234-ABCD-0002",
    "Q234-ABCD-0003"
  ]
}

Claim a list of devices, licenses, and/or orders into an organization inventory.

API documentation: claimIntoOrganization

Parameters:

• organization_id (str) –

  Organization ID.

• orders (list[str] | None, default: None ) –

  The numbers of the orders that should be claimed.

• serials (list[str] | None, default: None ) –

  The serials of the devices that should be claimed.

• licenses (list[ClaimIntoOrganizationLicensesItem] | None, default: None ) –

  The licenses that should be claimed.

Returns:

• ClaimIntoOrganizationResponse –

  Successful operation.

{
  "orders": [
    "4CXXXXXXX"
  ],
  "serials": [
    "Q234-ABCD-5678"
  ],
  "licenses": [
    {
      "key": "Z2XXXXXXXXXX",
      "mode": "addDevices"
    }
  ]
}

Claim a list of devices, licenses, and/or orders into an organization inventory.

API documentation: claimIntoOrganizationInventory

Parameters:

• organization_id (str) –

  Organization ID.

• orders (list[str] | None, default: None ) –

  The numbers of the orders that should be claimed.

• serials (list[str] | None, default: None ) –

  The serials of the devices that should be claimed.

• licenses (list[ClaimIntoOrganizationInventoryLicensesItem] | None, default: None ) –

  The licenses that should be claimed.

Returns:

• ClaimIntoOrganizationResponse –

  Successful operation.

{
  "orders": [
    "4CXXXXXXX"
  ],
  "serials": [
    "Q234-ABCD-5678"
  ],
  "licenses": [
    {
      "key": "Z2XXXXXXXXXX",
      "mode": "addDevices"
    }
  ]
}

Claim an order by the secure unique order claim number, the order claim id.

API documentation: claimOrganizationInventoryOrders

Parameters:

• organization_id (str) –

  Organization ID.

• claim_id (str) –

  The unique order claim id.

• subscriptions (list[ClaimOrganizationInventoryOrdersSubscriptionsItem] | None, default: None ) –

  The individual subscriptions to claim.

Returns:

• ClaimOrganizationInventoryOrdersResponse –

  Successful operation.

{
  "claimId": "ABCDEFG12345",
  "number": "97001888",
  "serials": [
    "1234-ABCD-4567"
  ],
  "subscriptions": [
    {
      "subscriptionId": "1234",
      "name": "My UNX Subscription",
      "description": "Wireless Networking Subscription",
      "startDate": "2020-06-30T00:00:00Z",
      "endDate": "2025-06-30T00:00:00Z",
      "isClaimed": false,
      "counts": {
        "seats": {
          "limit": 1
        }
      }
    }
  ]
}

Create a new organization by cloning the addressed organization.

API documentation: cloneOrganization

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the new organization.

Returns:

• OrganizationResponse –

  Successful operation.

{
  "id": "2930418",
  "name": "My organization",
  "url": "https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview",
  "api": {
    "enabled": true
  },
  "licensing": {
    "model": "co-term"
  },
  "cloud": {
    "region": {
      "name": "North America",
      "host": {
        "name": "United States"
      }
    }
  },
  "management": {
    "details": [
      {
        "name": "MSP ID",
        "value": "123456"
      }
    ]
  }
}

Combine multiple networks into a single network.

API documentation: combineOrganizationNetworks

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the combined network.

• network_ids (list[str]) –

  A list of the network IDs that will be combined. If an ID of a combined network is included in this list, the other networks in the list will be grouped into that network.

• enrollment_string (str | None, default: None ) –

  A unique identifier which can be used for device enrollment or easy access through the Meraki SM Registration page or the Self Service Portal. Please note that changing this field may cause existing bookmarks to break. All networks that are part of this combined network will have their enrollment string appended by '-network_type'. If left empty, all exisitng enrollment strings will be deleted.

Returns:

• CombineOrganizationNetworksResponse –

  Successful operation.

{
  "resultingNetwork": {
    "id": "N_24329156",
    "organizationId": "2930418",
    "name": "Main Office",
    "productTypes": [
      "appliance",
      "switch",
      "wireless"
    ],
    "timeZone": "America/Los_Angeles",
    "tags": [
      "tag1",
      "tag2"
    ],
    "enrollmentString": "my-enrollment-string",
    "url": "https://n1.meraki.com//n//manage/nodes/list",
    "notes": "Additional description of the network",
    "isBoundToConfigTemplate": false
  }
}

Move networks from one organization to another.

API documentation: createNetworkMove

Parameters:

• organization_id (str) –

  Organization ID.

• network (CreateNetworkMoveNetwork) –

  Network to be moved.

• organizations (CreateNetworkMoveOrganizations) –

  Organizations involved in the network move.

• simulate (bool | None, default: None ) –

  If true, simulates the network move and validates the operation without committing changes. The network will remain in the source organization.

Returns:

• CreateNetworkMoveResponse –

  Successful operation.

{
  "moveId": "123456",
  "initiator": {
    "admin": {
      "id": "8590064780"
    }
  },
  "organizations": {
    "source": {
      "id": "146307"
    },
    "target": {
      "id": "146308"
    }
  },
  "network": {
    "id": "N_569142402909112097"
  },
  "createdAt": "1970-01-20T15:57:36.000Z",
  "lastUpdatedAt": "1970-01-20T15:57:36.000Z",
  "result": {
    "status": "failed",
    "reason": "Cannot move network: Target organization is invalid or inaccessible."
  }
}

Create a new organization.

API documentation: createOrganization

Parameters:

• name (str) –

  The name of the organization.

• management (CreateOrganizationManagement | None, default: None ) –

  Information about the organization's management system.

Returns:

• OrganizationResponse –

  Successful operation.

{
  "id": "2930418",
  "name": "My organization",
  "url": "https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview",
  "api": {
    "enabled": true
  },
  "licensing": {
    "model": "co-term"
  },
  "cloud": {
    "region": {
      "name": "North America",
      "host": {
        "name": "United States"
      }
    }
  },
  "management": {
    "details": [
      {
        "name": "MSP ID",
        "value": "123456"
      }
    ]
  }
}

Create an action batch.

API documentation: createOrganizationActionBatch

Parameters:

• organization_id (str) –

  Organization ID.

• confirmed (bool | None, default: None ) –

  Set to true for immediate execution. Set to false if the action should be previewed before executing. This property cannot be unset once it is true. Defaults to false.

• synchronous (bool | None, default: None ) –

  Set to true to force the batch to run synchronous. There can be at most 20 actions in synchronous batch. Defaults to false.

• actions (list[CreateOrganizationActionBatchActionsItem]) –

  A set of changes to make as part of this action (more details).

• callback (CreateOrganizationActionBatchCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Returns:

• OrganizationActionBatchResponse –

  Successful operation.

{
  "id": "1234",
  "organizationId": "2930418",
  "confirmed": true,
  "synchronous": false,
  "status": {
    "completed": true,
    "failed": false,
    "errors": [],
    "createdResources": [
      {
        "id": "1284392014819",
        "uri": "/networks/L_XXXXX/groupPolicies/100"
      }
    ]
  },
  "actions": [
    {
      "resource": "/devices/QXXX-XXXX-XXXX/switch/ports/3",
      "operation": "update"
    }
  ],
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

Creates new adaptive policy ACL.

API documentation: createOrganizationAdaptivePolicyAcl

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the adaptive policy ACL.

• description (str | None, default: None ) –

  Description of the adaptive policy ACL.

• rules (list[CreateOrganizationAdaptivePolicyAclRulesItem]) –

  An ordered array of the adaptive policy ACL rules.

• ip_version (CreateOrganizationAdaptivePolicyAclIpVersion) –

  IP version of adpative policy ACL. One of: 'any', 'ipv4' or 'ipv6'.

Returns:

• OrganizationAdaptivePolicyAclResponse –

  Successful operation.

{
  "aclId": "12345678",
  "name": "Block sensitive web traffic",
  "description": "Blocks sensitive web traffic",
  "ipVersion": "ipv6",
  "rules": [
    {
      "policy": "deny",
      "protocol": "tcp",
      "srcPort": "1,33",
      "dstPort": "22-30",
      "log": true,
      "tcpEstablished": true
    }
  ],
  "createdAt": "2021-05-19T17:08:25Z",
  "updatedAt": "2021-05-19T17:11:54Z"
}

Creates a new adaptive policy group.

API documentation: createOrganizationAdaptivePolicyGroup

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the group.

• sgt (int) –

  SGT value of the group.

• description (str | None, default: None ) –

  Description of the group (default: "").

• policy_objects (list[CreateOrganizationAdaptivePolicyGroupPolicyObjectsItem] | None, default: None ) –

  The policy objects that belong to this group; traffic from addresses specified by these policy objects will be tagged with this group's SGT value if no other tagging scheme is being used (each requires one unique attribute) (default: []).

Returns:

• OrganizationAdaptivePolicyGroupResponse –

  Successful operation.

{
  "groupId": "1234",
  "name": "Employee Group",
  "sgt": 1000,
  "description": "Group of XYZ Corp Employees",
  "policyObjects": [
    {
      "id": "2345",
      "name": "Example Policy Object"
    }
  ],
  "isDefaultGroup": false,
  "requiredIpMappings": [],
  "createdAt": "2019-06-27T21:34:25.253480Z",
  "updatedAt": "2019-06-27T21:34:25.253480Z"
}

Add an Adaptive Policy.

API documentation: createOrganizationAdaptivePolicyPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• source_group (CreateOrganizationAdaptivePolicyPolicySourceGroup) –

  The source adaptive policy group (requires one unique attribute).

• destination_group (CreateOrganizationAdaptivePolicyPolicyDestinationGroup) –

  The destination adaptive policy group (requires one unique attribute).

• acls (list[CreateOrganizationAdaptivePolicyPolicyAclsItem] | None, default: None ) –

  An ordered array of adaptive policy ACLs (each requires one unique attribute) that apply to this policy (default: []).

• last_entry_rule (CreateOrganizationAdaptivePolicyPolicyLastEntryRule | None, default: None ) –

  The rule to apply if there is no matching ACL (default: "default").

Returns:

• OrganizationAdaptivePolicyPolicyResponse –

  Successful operation.

{
  "adaptivePolicyId": "111",
  "sourceGroup": {
    "id": "222",
    "name": "IoT Devices",
    "sgt": 50
  },
  "destinationGroup": {
    "id": "333",
    "name": "IoT Servers",
    "sgt": 51
  },
  "acls": [
    {
      "id": "444",
      "name": "Block web"
    }
  ],
  "lastEntryRule": "allow",
  "createdAt": "2019-06-27T21:34:25.253480Z",
  "updatedAt": "2019-06-27T21:34:25.253480Z"
}

Create a new dashboard administrator.

API documentation: createOrganizationAdmin

Parameters:

• organization_id (str) –

  Organization ID.

• email (str) –

  The email of the dashboard administrator. This attribute can not be updated.

• name (str) –

  The name of the dashboard administrator.

• org_access (CreateOrganizationAdminOrgAccess) –

  The privilege of the dashboard administrator on the organization. Can be one of 'full', 'read-only', 'enterprise' or 'none'.

• tags (list[CreateOrganizationAdminTagsItem] | None, default: None ) –

  The list of tags that the dashboard administrator has privileges on.

• networks (list[CreateOrganizationAdminNetworksItem] | None, default: None ) –

  The list of networks that the dashboard administrator has privileges on.

• authentication_method (CreateOrganizationAdminAuthenticationMethod | None, default: None ) –

  No longer used as of Cisco SecureX end-of-life. Can be one of 'Email'. The default is Email authentication.

Returns:

• OrganizationAdminResponse –

  Successful operation.

{
  "id": "212406",
  "name": "Miles Meraki",
  "email": "miles@meraki.com",
  "orgAccess": "none",
  "accountStatus": "ok",
  "twoFactorAuthEnabled": false,
  "hasApiKey": true,
  "lastActive": "2018-02-11T00:00:00Z",
  "tags": [
    {
      "tag": "west",
      "access": "read-only"
    }
  ],
  "networks": [
    {
      "id": "N_24329156",
      "access": "full"
    }
  ],
  "authenticationMethod": "Email"
}

Create an organization-wide alert configuration.

API documentation: createOrganizationAlertsProfile

Parameters:

• organization_id (str) –

  Organization ID.

• type_ (CreateOrganizationAlertsProfileType) –

  The alert type.

• alert_condition (CreateOrganizationAlertsProfileAlertCondition) –

  The conditions that determine if the alert triggers.

• recipients (CreateOrganizationAlertsProfileRecipients) –

  List of recipients that will recieve the alert.

• network_tags (list[str]) –

  Networks with these tags will be monitored for the alert.

• description (str | None, default: None ) –

  User supplied description of the alert.

Returns:

• OrganizationAlertsProfileResponse –

  Successful operation.

{
  "id": "1284392014819",
  "type": "wanUtilization",
  "enabled": true,
  "alertCondition": {
    "duration": 60,
    "window": 600,
    "bit_rate_bps": 10000,
    "interface": "wan1"
  },
  "recipients": {
    "emails": [
      "admin@example.org"
    ],
    "httpServerIds": [
      "aHR0cHM6Ly93d3cuZXhhbXBsZS5jb20vcGF0aA=="
    ]
  },
  "networkTags": [
    "tag1",
    "tag2"
  ],
  "description": "WAN 1 high utilization"
}

Add a new branding policy to an organization.

API documentation: createOrganizationBrandingPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the Dashboard branding policy.

• enabled (bool | None, default: None ) –

  Boolean indicating whether this policy is enabled.

• admin_settings (CreateOrganizationBrandingPolicyAdminSettings | None, default: None ) –

  Settings for describing which kinds of admins this policy applies to.

• help_settings (CreateOrganizationBrandingPolicyHelpSettings | None, default: None ) –

  Settings for describing the modifications to various Help page features. Each property in this object accepts one of 'default or inherit' (do not modify functionality), 'hide' (remove the section from Dashboard), or 'show' (always show the section on Dashboard). Some properties in this object also accept custom HTML used to replace the section on Dashboard; see the documentation for each property to see the allowed values. Each property defaults to 'default or inherit' when not provided.

• custom_logo (CreateOrganizationBrandingPolicyCustomLogo | None, default: None ) –

  Properties describing the custom logo attached to the branding policy.

Returns:

• OrganizationBrandingPolicyResponse –

  Successful operation.

{
  "name": "My Branding Policy",
  "enabled": true,
  "adminSettings": {
    "appliesTo": "All admins of networks...",
    "values": [
      "N_1234",
      "L_5678"
    ]
  },
  "helpSettings": {
    "helpTab": "show",
    "getHelpSubtab": "default or inherit",
    "communitySubtab": "show",
    "casesSubtab": "hide",
    "dataProtectionRequestsSubtab": "default or inherit",
    "getHelpSubtabKnowledgeBaseSearch": "<h1>Some custom HTML content</h1>",
    "universalSearchKnowledgeBaseSearch": "hide",
    "ciscoMerakiProductDocumentation": "show",
    "supportContactInfo": "show",
    "newFeaturesSubtab": "show",
    "firewallInfoSubtab": "hide",
    "apiDocsSubtab": "default or inherit",
    "hardwareReplacementsSubtab": "hide",
    "smForums": "hide",
    "helpWidget": "hide"
  },
  "customLogo": {
    "enabled": true,
    "image": {
      "preview": {
        "url": "https://meraki-na.s3.amazonaws.com/org-assets/my-image.png",
        "expiresAt": "2022-04-06T06:19:27-07:00"
      }
    }
  }
}

Create a new configuration template.

API documentation: createOrganizationConfigTemplate

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the configuration template.

• time_zone (str | None, default: None ) –

  The timezone of the configuration template. For a list of allowed timezones, please see the 'TZ' column in the table in this article. Not applicable if copying from existing network or template.

• copy_from_network_id (str | None, default: None ) –

  The ID of the network or config template to copy configuration from.

Returns:

• OrganizationConfigTemplateResponse –

  Successful operation.

{
  "id": "N_24329156",
  "name": "My config template",
  "productTypes": [
    "appliance",
    "switch",
    "wireless"
  ],
  "timeZone": "America/Los_Angeles"
}

Add a cellular data management profile to this organization.

API documentation: createOrganizationDevicesCellularDataProfile

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the profile to be added. This must be unique.

• description (str) –

  Description of the profile to be added.

• rules (list[CreateOrganizationDevicesCellularDataProfileRulesItem]) –

  The rules associated with this profile. At least one rule and no more than two rules may be defined for a profile.

Returns:

• OrganizationDevicesCellularDataProfileResponse –

  Successful operation.

{
  "profileId": "42",
  "lastUpdatedAt": "2023-08-21T00:00:00Z",
  "name": "some unique profile name",
  "description": "some description",
  "rules": [
    {
      "ruleId": "43",
      "slot": "sim1",
      "uplink": {
        "priority": 1,
        "isPreferred": true
      },
      "cap": {
        "value": 42,
        "threshold": 0.9,
        "term": {
          "resets": "monthly",
          "starts": {
            "hourOfDay": 12,
            "dayOfWeek": "mon",
            "dayOfMonth": 2
          }
        }
      },
      "actions": [
        {
          "type": "failover"
        }
      ]
    }
  ]
}

Migrate devices to another controller or management mode.

API documentation: createOrganizationDevicesControllerMigration

Parameters:

• organization_id (str) –

  Organization ID.

• serials (list[str]) –

  A list of Meraki Serials to migrate.

• target (CreateOrganizationDevicesControllerMigrationTarget) –

  The controller or management mode to which the devices will be migrated.

Returns:

• CreateOrganizationDevicesControllerMigrationResponse –

  Successful operation.

[
  {
    "serial": "QXYZ-DEFG-HIJK",
    "target": "wirelessController",
    "createdAt": "2020-10-21T02:00:00Z",
    "migratedAt": "2020-10-21T03:00:00Z"
  }
]

Perform a packet capture on a device and store in Meraki Cloud.

API documentation: createOrganizationDevicesPacketCaptureCapture

Parameters:

• organization_id (str) –

  Organization ID.

• serials (list[str]) –

  The serial(s) of the device(s).

• name (str) –

  Name of packet capture file.

• output_type (str | None, default: None ) –

  Output type of packet capture file. Possible values: text, pcap, cloudshark, or upload_to_cloud.

• destination (str | None, default: None ) –

  Destination of packet capture file. Possible values: [upload_to_cloud].

• ports (str | None, default: None ) –

  Ports of packet capture file, comma-separated.

• notes (str | None, default: None ) –

  Reason for taking the packet capture.

• duration (int | None, default: None ) –

  Duration in seconds of packet capture.

• filter_expression (str | None, default: None ) –

  Filter expression for packet capture.

• interface (str | None, default: None ) –

  Interface of the device.

• advanced (CreateOrganizationDevicesPacketCaptureCaptureAdvanced | None, default: None ) –

  Advanced filters for IOSXE devices (supported for Campus Gateway devices only).

Returns:

• OrganizationDevicesPacketCaptureCaptureResponse –

  Successful operation.

{
  "captureId": "1234",
  "network": {
    "id": "N_24329156",
    "name": "Main Office"
  },
  "device": {
    "name": "My AP",
    "serial": "Q234-ABCD-5678"
  },
  "admin": {
    "id": "1234",
    "name": "Miles Meraki"
  },
  "client": {
    "id": "k74272e",
    "mac": "22:33:44:55:66:77"
  },
  "details": [
    {
      "name": "reason",
      "value": "bad_password",
      "productType": "wireless"
    }
  ],
  "name": "file_name",
  "startTs": "2018-02-11T00:00:00.090210Z",
  "ports": "1, 2",
  "status": "new",
  "errorMessage": "Some error message",
  "destination": "upload_to_cloud",
  "process": "manual",
  "file": {
    "size": 1066
  },
  "duration": 60,
  "filterExpression": "(icmp)",
  "counts": {
    "packets": {
      "total": 10
    }
  },
  "interface": "wired"
}

Create a schedule for packet capture.

API documentation: createOrganizationDevicesPacketCaptureSchedule

Parameters:

• organization_id (str) –

  Organization ID.

• devices (list[CreateOrganizationDevicesPacketCaptureScheduleDevicesItem]) –

  device details.

• name (str | None, default: None ) –

  Name of the packet capture file.

• notes (str | None, default: None ) –

  Reason for capture.

• duration (int | None, default: None ) –

  Duration of the capture in seconds.

• filter_expression (str | None, default: None ) –

  Filter expression for the capture.

• enabled (bool | None, default: None ) –

  Enable or disable the schedule.

• schedule (CreateOrganizationDevicesPacketCaptureScheduleSchedule | None, default: None ) –

  Schedule details.

Returns:

• OrganizationDevicesPacketCaptureScheduleResponse –

  Successful operation.

{
  "scheduleId": "1234",
  "devices": [
    {
      "device": {
        "serial": "Q234-ABCD-5678",
        "switchports": "1-3, 9",
        "interface": "GigabitEthernet1/0/1"
      }
    }
  ],
  "name": "pcap_file_name",
  "admin": {
    "id": "1234",
    "name": "Miles Meraki"
  },
  "notes": "capture reason",
  "duration": 60,
  "filterExpression": "(icmp)",
  "createdAt": "2018-02-11T00:00:00.090210Z",
  "updatedAt": "2018-02-11T00:00:00.090210Z",
  "captureCount": 2,
  "lastCaptureId": "1234",
  "enabled": true,
  "priority": 1,
  "schedule": {
    "name": "schedule_name",
    "startTs": "2018-02-11T00:00:00.090210Z",
    "endTs": "2018-02-11T00:00:00.090210Z",
    "frequency": "hour",
    "weekdays": [
      "Monday",
      "Tuesday"
    ],
    "recurrence": 1,
    "nextCaptureTs": "2018-02-11T00:00:00.090210Z"
  },
  "warnings": [
    "This schedule conflicts with the schedule Test Schedule at the time 2025-01-28T18:25:06Z"
  ]
}

Create a new early access feature opt-in for an organization.

API documentation: createOrganizationEarlyAccessFeaturesOptIn

Parameters:

• organization_id (str) –

  Organization ID.

• short_name (str) –

  Short name of the early access feature.

• limit_scope_to_networks (list[str] | None, default: None ) –

  A list of network IDs to apply the opt-in to.

Returns:

• GetOrganizationEarlyAccessFeaturesOptInsResponse –

  Successful operation.

{
  "id": "1",
  "shortName": "has_new_feature",
  "limitScopeToNetworks": [
    {
      "id": "L_1234",
      "name": "My Network"
    }
  ],
  "optOutEligibility": {
    "eligible": false,
    "reason": "Please remove devices of type XYZ from your organization",
    "help": {
      "label": "Read more",
      "url": "http://meraki.com/my_help"
    }
  },
  "createdAt": "2022-05-01T04:07:15Z"
}

Swap the devices identified by devices.old with a devices.new, then perform the :afterAction on the devices.old.

API documentation: createOrganizationInventoryDevicesSwapsBulk

Parameters:

• organization_id (str) –

  Organization ID.

• swaps (list[CreateOrganizationInventoryDevicesSwapsBulkSwapsItem]) –

  List of replacments to perform.

Returns:

• OrganizationInventoryDevicesSwapsBulkResponse –

  Successful operation.

{
  "jobId": "1284392014819",
  "swaps": [
    {
      "id": "1284392014819",
      "devices": {
        "old": {
          "mac": "00:11:22:33:44:55",
          "serial": "Q234-ABCD-5678",
          "model": "MR34",
          "name": "My AP"
        },
        "new": {
          "mac": "00:11:22:33:44:55",
          "serial": "Q234-ABCD-5678",
          "model": "MR34",
          "name": "My AP"
        }
      },
      "status": "complete",
      "afterAction": "remove from network",
      "createdAt": "2023-04-24T12:40:11Z",
      "completedAt": "2023-04-24T12:40:12Z",
      "errors": []
    }
  ]
}

Create a network.

API documentation: createOrganizationNetwork

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  The name of the new network.

• product_types (CreateOrganizationNetworkProductTypes) –

  The product type(s) of the new network. If more than one type is included, the network will be a combined network.

• tags (list[str] | None, default: None ) –

  A list of tags to be applied to the network.

• time_zone (str | None, default: None ) –

  The timezone of the network. For a list of allowed timezones, please see the 'TZ' column in the table in this article..

• copy_from_network_id (str | None, default: None ) –

  The ID of the network to copy configuration from. Other provided parameters will override the copied configuration, except type which must match this network's type exactly.

• notes (str | None, default: None ) –

  Add any notes or additional information about this network here.

Returns:

• CreateOrganizationNetworkResponse –

  Successful operation.

{
  "id": "N_24329156",
  "organizationId": "2930418",
  "name": "Main Office",
  "productTypes": [
    "appliance",
    "switch",
    "wireless"
  ],
  "timeZone": "America/Los_Angeles",
  "tags": [
    "tag1",
    "tag2"
  ],
  "enrollmentString": "my-enrollment-string",
  "url": "https://n1.meraki.com//n//manage/nodes/list",
  "notes": "Additional description of the network",
  "isBoundToConfigTemplate": false
}

Create an Organization-Wide Policy Firewall Ruleset.

API documentation: createOrganizationPoliciesGlobalFirewallRuleset

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the firewall ruleset.

• description (str | None, default: None ) –

  Description of the firewall ruleset.

Returns:

• OrganizationPoliciesGlobalFirewallRulesetResponse –

  Successful operation.

{
  "rulesetId": "123",
  "name": "Block Social Media",
  "description": "Block all Social Media",
  "createdAt": "2021-01-01T00:00:00Z",
  "lastUpdatedAt": "2021-01-01T00:00:00Z"
}

Create an Organization-Wide Policy Firewall Rule.

API documentation: createOrganizationPoliciesGlobalFirewallRulesetsRule

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the firewall rule.

• ruleset_id (str) –

  Firewall ruleset ID to associate the rule with.

• policy (CreateOrganizationPoliciesGlobalFirewallRulesetsRulePolicy) –

  Rule policy - allow or deny traffic.

• enabled (bool | None, default: None ) –

  Whether the rule is enabled.

• priority (int | None, default: None ) –

  Rule priority (lower numbers = higher priority).

• description (str | None, default: None ) –

  Description of the firewall rule.

• sources (CreateOrganizationPoliciesGlobalFirewallRulesetsRuleSources) –

  Source traffic criteria. Each source or destination bloc is capped separately per rule at 100 total segment values. The count is segments_values_count: the sum of all values across every segment type in that bloc. Ports use a separate cap of 100.

• destinations (CreateOrganizationPoliciesGlobalFirewallRulesetsRuleDestinations) –

  Destination traffic criteria. Each source or destination bloc is capped separately per rule at 100 total segment values. The count is segments_values_count: the sum of all values across every segment type in that bloc. Ports use a separate cap of 100.

Returns:

• OrganizationPoliciesGlobalFirewallRulesetsRuleResponse –

  Successful operation.

{
  "ruleId": "123",
  "name": "Allow developers",
  "rulesetId": "32",
  "policy": "deny",
  "enabled": true,
  "priority": 100,
  "description": "This is rule 1",
  "sources": {
    "matchCriteria": [
      "addressRanges",
      "ports",
      "policyObjects",
      "policyObjectGroups",
      "applianceVlans"
    ],
    "criteria": {
      "addressRanges": [
        "1.1.1.1",
        "2.2.2.2"
      ],
      "ports": [
        "22",
        "42-46"
      ],
      "policyObjects": [
        {
          "id": "23"
        }
      ],
      "policyObjectGroups": [
        {
          "id": "45"
        }
      ],
      "applianceVlans": [
        {
          "interfaceId": "L_123456789012345678_vlan_200"
        }
      ],
      "siteSpecificVlans": [
        {
          "id": 100,
          "address": {
            "offsets": {
              "ipv4": 25,
              "ipv6": "0:ff:fe01:0"
            }
          }
        }
      ]
    }
  },
  "destinations": {
    "matchCriteria": [
      "addressRanges",
      "services",
      "applicationCategories",
      "applications",
      "policyObjects",
      "policyObjectGroups",
      "applianceVlans"
    ],
    "criteria": {
      "addressRanges": [
        "1.1.1.1",
        "2.2.2.2"
      ],
      "ports": [
        "22",
        "42-46"
      ],
      "services": [
        {
          "protocol": "tcp",
          "ports": [
            "80",
            "443"
          ]
        }
      ],
      "applicationCategories": [
        {
          "id": "meraki:layer7/category/24"
        }
      ],
      "applications": [
        {
          "id": "meraki:layer7/application/5",
          "name": "Advertising.com"
        }
      ],
      "policyObjects": [
        {
          "id": "23"
        }
      ],
      "policyObjectGroups": [
        {
          "id": "45"
        }
      ],
      "applianceVlans": [
        {
          "interfaceId": "L_123456789012345678_vlan_200"
        }
      ],
      "countries": [
        {
          "code": "US"
        }
      ],
      "fqdns": [
        "*.example.com"
      ],
      "siteSpecificVlans": [
        {
          "id": 100,
          "address": {
            "offsets": {
              "ipv4": 25,
              "ipv6": "0:ff:fe01:0"
            }
          }
        }
      ]
    }
  },
  "createdAt": "2021-01-01T00:00:00Z",
  "lastUpdatedAt": "2021-01-01T00:00:00Z"
}

Create an Organization-Wide Policy Ruleset Assignment.

API documentation: createOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

Parameters:

• organization_id (str) –

  Organization ID.

• ruleset_id (str) –

  ID of the ruleset to assign.

• policy_id (str) –

  ID of the policy to assign the ruleset to.

• priority (int | None, default: None ) –

  Priority of the ruleset assignment (lower numbers = higher priority).

Returns:

• OrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignmentResponse –

  Successful operation.

{
  "assignmentId": "123",
  "rulesetId": "456",
  "policyId": "789",
  "priority": 1,
  "createdAt": "2021-01-01T00:00:00Z",
  "lastUpdatedAt": "2021-01-01T00:00:00Z"
}

Create an Organization-Wide Policy.

API documentation: createOrganizationPoliciesGlobalGroupPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of the policy.

• description (str | None, default: None ) –

  Description of the policy.

Returns:

• OrganizationPoliciesGlobalGroupPolicyResponse –

  Successful operation.

{
  "policyId": "123",
  "name": "My policy",
  "description": "My policy description",
  "group": {
    "number": 100
  },
  "createdAt": "2021-01-01T00:00:00Z",
  "lastUpdatedAt": "2021-01-01T00:00:00Z"
}

Creates a new Policy Object.

API documentation: createOrganizationPolicyObject

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  Name of a policy object, unique within the organization (alphanumeric, space, dash, or underscore characters only).

• category (str) –

  Category of a policy object (one of: adaptivePolicy, network).

• type_ (str) –

  Type of a policy object (one of: adaptivePolicyIpv4Cidr, cidr, fqdn, ipAndMask).

• cidr (str | None, default: None ) –

  CIDR Value of a policy object (e.g. 10.11.12.1/24").

• fqdn (str | None, default: None ) –

  Fully qualified domain name of policy object (e.g. "example.com").

• mask (str | None, default: None ) –

  Mask of a policy object (e.g. "255.255.0.0").

• ip (str | None, default: None ) –

  IP Address of a policy object (e.g. "1.2.3.4").

• group_ids (list[str] | None, default: None ) –

  The IDs of policy object groups the policy object belongs to.

Returns:

• OrganizationPolicyObjectResponse –

  Successful operation.

{
  "id": "1234",
  "name": "Web Servers - Datacenter 10",
  "category": "network",
  "type": "cidr",
  "cidr": "10.0.0.0/24",
  "createdAt": "2018-05-12T00:00:00Z",
  "updatedAt": "2018-05-12T00:00:00Z",
  "groupIds": [
    "8"
  ],
  "networkIds": [
    "L_12345",
    "N_123456"
  ]
}

Creates a new Policy Object Group.

API documentation: createOrganizationPolicyObjectsGroup

Parameters:

• organization_id (str) –

  Organization ID.

• name (str) –

  A name for the group of network addresses, unique within the organization (alphanumeric, space, dash, or underscore characters only).

• category (str | None, default: None ) –

  Category of a policy object group (one of: NetworkObjectGroup, GeoLocationGroup, PortObjectGroup, ApplicationGroup).

• object_ids (list[str] | None, default: None ) –

  A list of Policy Object ID's that this NetworkObjectGroup should be associated to (note: these ID's will replace the existing associated Policy Objects).

Returns:

• OrganizationPolicyObjectsGroupResponse –

  Successful operation.

{
  "id": "1234",
  "name": "Web Servers - Datacenter 10",
  "category": "NetworkObjectGroup",
  "createdAt": "2018-05-12T00:00:00Z",
  "updatedAt": "2018-05-12T00:00:00Z",
  "objectIds": [
    100
  ],
  "networkIds": [
    "L_12345",
    "N_123456"
  ]
}

Create a SAML IdP for your organization.

API documentation: createOrganizationSamlIdp

Parameters:

• organization_id (str) –

  Organization ID.

• x509cert_sha1_fingerprint (str) –

  Fingerprint (SHA1) of the SAML certificate provided by your Identity Provider (IdP). This will be used for encryption / validation.

• sso_login_url (str | None, default: None ) –

  Dashboard will redirect users to this URL to log in again when their sessions expire.

• slo_logout_url (str | None, default: None ) –

  Dashboard will redirect users to this URL when they sign out.

Returns:

• GetOrganizationSamlIdpsResponse –

  Successful operation.

[
  {
    "idpId": "1284392014819",
    "consumerUrl": "https://n7.meraki.com/saml/login/XXX",
    "visionConsumerUrl": "https://n7.meraki.com/saml/login/XXX?appTarget=MerakiVision",
    "x509certSha1Fingerprint": "00:11:22:33:44:55:66:77:88:99:00:11:22:33:44:55:66:77:88:99",
    "ssoLoginUrl": "https://onelogin.com/trust/saml2/http-post/sso/3de5f942-e7b8-4cb9-94e3-85828111158b",
    "sloLogoutUrl": "https://onelogin.com/trust/saml2/http-redirect/slo/4155000"
  }
]

Create a SAML role.

API documentation: createOrganizationSamlRole

Parameters:

• organization_id (str) –

  Organization ID.

• role (str) –

  The role of the SAML administrator.

• org_access (str) –

  The privilege of the SAML administrator on the organization. Can be one of 'none', 'read-only', 'full' or 'enterprise' or a custom role in the format custom-role:ID:NAME.

• tags (list[CreateOrganizationSamlRoleTagsItem] | None, default: None ) –

  The list of tags that the SAML administrator has privileges on.

• networks (list[CreateOrganizationSamlRoleNetworksItem] | None, default: None ) –

  The list of networks that the SAML administrator has privileges on.

Returns:

• OrganizationSamlRoleResponse –

  Successful operation.

{
  "id": "1284392014819",
  "role": "myrole",
  "orgAccess": "none",
  "networks": [
    {
      "id": "N_24329156",
      "access": "full"
    }
  ],
  "tags": [
    {
      "tag": "west",
      "access": "read-only"
    }
  ],
  "camera": [
    {
      "orgWide": true,
      "access": "viewAndExport"
    }
  ]
}

Create a new Secure Access integration.

API documentation: createOrganizationSaseIntegration

Parameters:

• organization_id (str) –

  Organization ID.

• api (CreateOrganizationSaseIntegrationApi) –

  API credentials.

Returns:

• OrganizationSaseIntegrationResponse –

  Successful operation.

{
  "integrated": {
    "by": {
      "admin": {
        "name": "John Doe"
      }
    },
    "at": "2025-04-01T12:00:00Z"
  },
  "lastUsedAt": "2025-04-01T12:00:00Z",
  "external": {
    "organization": {
      "id": "1234567890"
    }
  },
  "status": "active"
}

Create a Splash Theme.

API documentation: createOrganizationSplashTheme

Parameters:

• organization_id (str) –

  Organization ID.

• name (str | None, default: None ) –

  theme name.

• base_theme (str | None, default: None ) –

  base theme id.

Returns:

• CreateOrganizationSplashThemeResponse –

  Successful operation.

{
  "id": "482367494044dbbb1d2cc8579d967cef5b4ce59f",
  "name": "My Custom Splash Theme",
  "isSystemTheme": false,
  "themeAssets": [
    {
      "id": "1284392014819",
      "name": "continue.html"
    }
  ]
}

Create a Splash Theme Asset.

API documentation: createOrganizationSplashThemeAsset

Parameters:

• organization_id (str) –

  Organization ID.

• theme_identifier (str) –

  Theme identifier.

• name (str | None, default: None ) –

  File name. Will overwrite files with same name.

• content (str | None, default: None ) –

  a file containing the asset content.

Returns:

• GetOrganizationSplashAssetResponse –

  Successful operation.

{
  "id": "1284392014819",
  "name": "continue.html",
  "fileData": "PGh0bWw+PC9odG1sPg==\n"
}

Delete an organization.

API documentation: deleteOrganization

Parameters:

• organization_id (str) –

  Organization ID.

Returns:

• None –

  Successful operation.

Delete an action batch.

API documentation: deleteOrganizationActionBatch

Parameters:

• organization_id (str) –

  Organization ID.

• action_batch_id (str) –

  Action batch ID.

Returns:

• None –

  Successful operation.

Deletes the specified adaptive policy ACL.

API documentation: deleteOrganizationAdaptivePolicyAcl

Parameters:

• organization_id (str) –

  Organization ID.

• acl_id (str) –

  Acl ID.

Returns:

• None –

  Successful operation.

Deletes the specified adaptive policy group and any associated policies and references.

API documentation: deleteOrganizationAdaptivePolicyGroup

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Returns:

• None –

  Successful operation.

Delete an Adaptive Policy.

API documentation: deleteOrganizationAdaptivePolicyPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Returns:

• None –

  Successful operation.

Revoke all access for a dashboard administrator within this organization.

API documentation: deleteOrganizationAdmin

Parameters:

• organization_id (str) –

  Organization ID.

• admin_id (str) –

  Admin ID.

Returns:

• None –

  Successful operation.

Removes an organization-wide alert config.

API documentation: deleteOrganizationAlertsProfile

Parameters:

• organization_id (str) –

  Organization ID.

• alert_config_id (str) –

  Alert config ID.

Returns:

• None –

  Successful operation.

Delete a branding policy.

API documentation: deleteOrganizationBrandingPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• branding_policy_id (str) –

  Branding policy ID.

Returns:

• None –

  Successful operation.

Remove a configuration template.

API documentation: deleteOrganizationConfigTemplate

Parameters:

• organization_id (str) –

  Organization ID.

• config_template_id (str) –

  Config template ID.

Returns:

• None –

  Successful operation.

Delete a cellular data management profile from this organization.

API documentation: deleteOrganizationDevicesCellularDataProfile

Parameters:

• organization_id (str) –

  Organization ID.

• profile_id (str) –

  Profile ID.

Returns:

• None –

  Successful operation.

Delete a single packet capture from cloud using captureId.

API documentation: deleteOrganizationDevicesPacketCaptureCapture

Parameters:

• organization_id (str) –

  Organization ID.

• capture_id (str) –

  Capture ID.

Returns:

• None –

  Successful operation.

Delete schedule from cloud.

API documentation: deleteOrganizationDevicesPacketCaptureSchedule

Parameters:

• organization_id (str) –

  Organization ID.

• schedule_id (str) –

  Schedule ID.

Returns:

• None –

  Successful operation.

Delete an early access feature opt-in.

API documentation: deleteOrganizationEarlyAccessFeaturesOptIn

Parameters:

• organization_id (str) –

  Organization ID.

• opt_in_id (str) –

  Opt in ID.

Returns:

• None –

  Successful operation.

Delete an Organization-Wide Policy Firewall Ruleset.

API documentation: deleteOrganizationPoliciesGlobalFirewallRuleset

Parameters:

• organization_id (str) –

  Organization ID.

• ruleset_id (str) –

  Ruleset ID.

Returns:

• None –

  Successful operation.

Delete an Organization-Wide Policy Firewall Rule.

API documentation: deleteOrganizationPoliciesGlobalFirewallRulesetsRule

Parameters:

• organization_id (str) –

  Organization ID.

• rule_id (str) –

  Rule ID.

Returns:

• None –

  Successful operation.

Delete an Organization-Wide Policy Ruleset Assignment.

API documentation: deleteOrganizationPoliciesGlobalGroupPoliciesFirewallRulesetsAssignment

Parameters:

• organization_id (str) –

  Organization ID.

• assignment_id (str) –

  Assignment ID.

Returns:

• None –

  Successful operation.

Delete an Organization-Wide Policy.

API documentation: deleteOrganizationPoliciesGlobalGroupPolicy

Parameters:

• organization_id (str) –

  Organization ID.

• policy_id (str) –

  Policy ID.

Returns:

• None –

  Successful operation.

Deletes a Policy Object.

API documentation: deleteOrganizationPolicyObject

Parameters:

• organization_id (str) –

  Organization ID.

• policy_object_id (str) –

  Policy object ID.

Returns:

• None –

  Successful operation.

Deletes a Policy Object Group.

API documentation: deleteOrganizationPolicyObjectsGroup

Parameters:

• organization_id (str) –

  Organization ID.

• policy_object_group_id (str) –

  Policy object group ID.

Returns:

• None –

  Successful operation.

Remove a SAML IdP in your organization.

API documentation: deleteOrganizationSamlIdp

Parameters:

• organization_id (str) –

  Organization ID.

• idp_id (str) –

  Idp ID.

Returns:

• None –

  Successful operation.

Remove a SAML role.

API documentation: deleteOrganizationSamlRole

Parameters:

• organization_id (str) –

  Organization ID.

• saml_role_id (str) –

  Saml role ID.

Returns:

• None –

  Successful operation.

Remove a Secure Access integration.

API documentation: deleteOrganizationSaseIntegration

Parameters:

• organization_id (str) –

  Organization ID.

• integration_id (str) –

  Integration ID.

Returns:

• None –

  Successful operation.

Delete a Splash Theme Asset.

API documentation: deleteOrganizationSplashAsset

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Returns:

• None –

  Successful operation.

Delete a Splash Theme.

API documentation: deleteOrganizationSplashTheme

Parameters:

• organization_id (str) –

  Organization ID.

• id (str) –

  ID.

Returns:

• None –

  Successful operation.

Detach sites in this organization from Secure Access.

API documentation: detachOrganizationSaseSites

Parameters:

• organization_id (str) –

  Organization ID.

• items (list[DetachOrganizationSaseSitesItemsItem] | None, default: None ) –

  List of Secure Access sites to be detached.

• callback (DetachOrganizationSaseSitesCallback | None, default: None ) –

  Details for the callback. Please include either an httpServerId OR url and sharedSecret.

Returns:

• None –

  Successful operation.

{
  "items": [
    {
      "pipelineId": "1234",
      "operation": {
        "id": "enrollOrganizationSaseSites"
      },
      "status": "active",
      "counts": {
        "jobs": {
          "total": 3,
          "byStatus": {
            "completed": 1,
            "failed": 1,
            "pending": 1
          }
        }
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 100,
        "remaining": 10
      }
    }
  }
}

Disable XDR on networks.

API documentation: disableOrganizationIntegrationsXdrNetworks

Parameters:

• organization_id (str) –

  Organization ID.

• networks (list[DisableOrganizationIntegrationsXdrNetworksNetworksItem]) –

  List containing the network ID and the product type to disable XDR on.

Returns:

• OrganizationIntegrationsXdrNetworksResponse –

  Successful operation.

{
  "networks": [
    {
      "networkId": "N_1234567",
      "productTypes": [
        "appliance"
      ],
      "name": "Test network",
      "enabled": false,
      "isEligible": true
    }
  ]
}

Dismiss health alerts.

API documentation: dismissOrganizationAssuranceAlerts

Parameters:

• organization_id (str) –

  Organization ID.

• alert_ids (list[str]) –

  Array of alert IDs to dismiss.

Returns:

• None –

  Successful operation.

Enable XDR on networks.

API documentation: enableOrganizationIntegrationsXdrNetworks

Parameters:

• organization_id (str) –

  Organization ID.

• networks (list[EnableOrganizationIntegrationsXdrNetworksNetworksItem]) –

  List containing the network ID and the product type to enable XDR on.

Returns:

• OrganizationIntegrationsXdrNetworksResponse –

  Successful operation.

{
  "networks": [
    {
      "networkId": "N_1234567",
      "productTypes": [
        "appliance"
      ],
      "name": "Test network",
      "enabled": true,
      "isEligible": true
    }
  ]
}

Get presigned download URL for given packet capture id.

API documentation: generateOrganizationDevicesPacketCaptureCaptureDownloadUrl

Parameters:

• organization_id (str) –

  Organization ID.

• capture_id (str) –

  Capture ID.

Returns:

• GenerateOrganizationDevicesPacketCaptureCaptureDownloadUrlResponse –

  Successful operation.

{
  "captureId": "1234",
  "downloadUrl": "example.com",
  "url": "example.com"
}

Return a list of network move operations in the organization.

API documentation: getNetworkMoves

Parameters:

• organization_id (str) –

  Organization ID.

• per_page (int | None, default: None ) –

  The number of entries per page returned. Acceptable range is 10 - 100. Default is 50.

• starting_after (str | None, default: None ) –

  A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it.

• ending_before (str | None, default: None ) –

  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.

• move_ids (list[str] | None, default: None ) –

  Array of network move operation IDs to include. If not specified, all network moves will be returned.

• total_pages (int | Literal['all'], default: 'all' ) –

  use with per_page to get total results up to total_pages * per_page; -1 or "all" for all pages.

• direction (Literal['prev', 'next'], default: 'next' ) –

  direction to paginate, either "next" (default) or "prev" page.

Returns:

• PaginatedResponse[CreateNetworkMoveResponse] –

  Successful operation.

{
  "items": [
    {
      "moveId": "123456",
      "initiator": {
        "admin": {
          "id": "8590064780"
        }
      },
      "organizations": {
        "source": {
          "id": "146307"
        },
        "target": {
          "id": "146308"
        }
      },
      "network": {
        "id": "N_569142402909112097"
      },
      "createdAt": "1970-01-20T15:57:36.000Z",
      "lastUpdatedAt": "1970-01-20T15:57:36.000Z",
      "result": {
        "status": "failed",
        "reason": "Cannot move network: Target organization is invalid or inaccessible."
      }
    }
  ],
  "meta": {
    "counts": {
      "items": {
        "total": 42,
        "remaining": 12
      }
    }
  }
}

Return an organization.

API documentation: getOrganization

Parameters:

• organization_id (str) –

  Organization ID.

Returns:

• OrganizationResponse –

  Successful operation.

{
  "id": "2930418",
  "name": "My organization",
  "url": "https://dashboard.meraki.com/o/VjjsAd/manage/organization/overview",
  "api": {
    "enabled": true
  },
  "licensing": {
    "model": "co-term"
  },
  "cloud": {
    "region": {
      "name": "North America",
      "host": {
        "name": "United States"
      }
    }
  },
  "management": {
    "details": [
      {
        "name": "MSP ID",
        "value": "123456"
      }
    ]
  }
}

Return an action batch.

API documentation: getOrganizationActionBatch

Parameters:

• organization_id (str) –

  Organization ID.

• action_batch_id (str) –

  Action batch ID.

Returns:

• OrganizationActionBatchResponse –

  Successful operation.

{
  "id": "1234",
  "organizationId": "2930418",
  "confirmed": true,
  "synchronous": false,
  "status": {
    "completed": true,
    "failed": false,
    "errors": [],
    "createdResources": [
      {
        "id": "1284392014819",
        "uri": "/networks/L_XXXXX/groupPolicies/100"
      }
    ]
  },
  "actions": [
    {
      "resource": "/devices/QXXX-XXXX-XXXX/switch/ports/3",
      "operation": "update"
    }
  ],
  "callback": {
    "id": "1284392014819",
    "url": "https://webhook.site/28efa24e-f830-4d9f-a12b-fbb9e5035031",
    "status": "new"
  }
}

Return the list of action batches in the organization.

API documentation: getOrganizationActionBatches

Parameters:

• organization_id (str) –

  Organization ID.

• status (GetOrganizationActionBatchesStatus | None, default: None ) –

  Filter batches by status. Valid types are pending, completed, and failed.

Returns:

• PaginatedResponse[UpdateOrganizationActionBatchResponse] –

  Successful operation.

[
  {
    "id": "1234",
    "organizationId": "2930418",
    "confirmed": true,
    "synchronous": false,
    "status": {
      "completed": true,
      "failed": false,
      "errors": [],
      "createdResources": [
        {
          "id": "1284392014819",
          "uri": "/networks/L_XXXXX/groupPolicies/100"
        }
      ]
    },
    "actions": [
      {
        "resource": "/devices/QXXX-XXXX-XXXX/switch/ports/3",
        "operation": "update"
      }
    ]
  }
]