Network Locations

Get, create, update, or delete a network's user-defined locations.OpenAPI: YAML | JSON

Each network has 1) a list of user-defined locations at which devices can be represented in network diagrams and 2) an atlas, which can map each device to a user-defined location. Additionally, devices at the same user-defined location can be grouped into device clusters to declutter the network diagram.

The system automatically assigns cloud (AWS/GCP/Azure) devices to predefined cloud locations. All other devices can be assigned to user-defined locations via the atlas. Devices that have no location assigned appear in the default (“Unassigned”) location.

When creating or updating a user-defined location, you can choose its id (like "sjc-01b") or allow the system to generate a numeric one (like "56").

A user-chosen location identifier:

must not exceed 16 characters,
must contain only letters, digits, and hyphens,
must begin with a letter,
must not end with a hyphen or have consecutive hyphens,
must be unique, ignoring case (to avoid confusion), and
must be different from the names of other locations, ignoring case (to avoid confusion).

This section includes:

operations for listing, creating, updating, and deleting user-defined locations,
operations for retrieving and updating the atlas of device location assignments, and
operations for defining and managing device clusters.

Network Locations

Get device locations

Update device locations

Get a network’s locations

Create a network location

Create network locations

Create or update network locations

Get a network location

Update a network location

Delete a network location

Get the device clusters at a location

Create a device cluster at a location

Replace all device clusters at a location

Get a device cluster

Update a device cluster

Delete a device cluster