{
  "opencollection": "1.0.0",
  "info": {
    "name": "Forward Networks: Complete Aliases Network Locations API",
    "version": "26.6"
  },
  "items": [
    {
      "info": {
        "name": "Network Locations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get device locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/atlas",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The response is a JSON object that maps device names to their location ids.\n\nSample response: `{\"atl-edge-fw01\": \"2\", \"ny-edge-fw2\": \"1\"}`"
        },
        {
          "info": {
            "name": "Update device locations",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/networks/:networkId/atlas",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "The request is a JSON object that maps device names to their new location ids.\n\nSample request: `{\"atl-edge-fw01\": \"2\", \"ny-edge-fw2\": \"1\"}`"
        },
        {
          "info": {
            "name": "Get a network’s locations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/locations",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a network’s locations"
        },
        {
          "info": {
            "name": "Create a network location",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/networks/:networkId/locations",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a network location"
        },
        {
          "info": {
            "name": "Create network locations",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/networks/:networkId/locations",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Creates multiple locations at once. Can be helpful when first setting up a network.\n\nFails (as a precautionary measure) with 409 Conflict if the network already has any network locations."
        },
        {
          "info": {
            "name": "Create or update network locations",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/networks/:networkId/locations",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Any patches that specify an existing location’s `id` will update the existing location. Any other patches\nwill each create a new location. Patches are applied sequentially."
        },
        {
          "info": {
            "name": "Get a network location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/locations/:locationId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a network location"
        },
        {
          "info": {
            "name": "Update a network location",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/networks/:networkId/locations/:locationId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "All JSON properties in the request body are optional. Include only the properties you wish to\nchange."
        },
        {
          "info": {
            "name": "Delete a network location",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/networks/:networkId/locations/:locationId",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "When a location with devices is deleted, all of its devices will be unassigned."
        },
        {
          "info": {
            "name": "Get the device clusters at a location",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/locations/:locationId/clusters",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get the device clusters at a location"
        },
        {
          "info": {
            "name": "Create a device cluster at a location",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/api/networks/:networkId/locations/:locationId/clusters",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create a device cluster at a location"
        },
        {
          "info": {
            "name": "Replace all device clusters at a location",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/api/networks/:networkId/locations/:locationId/clusters",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Replace all device clusters at a location"
        },
        {
          "info": {
            "name": "Get a device cluster",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/api/networks/:networkId/locations/:locationId/clusters/:clusterName",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Get a device cluster"
        },
        {
          "info": {
            "name": "Update a device cluster",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "/api/networks/:networkId/locations/:locationId/clusters/:clusterName",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "All JSON properties in the request body are optional. Include only the properties you wish to\nchange."
        },
        {
          "info": {
            "name": "Delete a device cluster",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "/api/networks/:networkId/locations/:locationId/clusters/:clusterName",
            "params": [
              {
                "name": "networkId",
                "value": "",
                "type": "path"
              },
              {
                "name": "locationId",
                "value": "",
                "type": "path"
              },
              {
                "name": "clusterName",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a device cluster"
        }
      ]
    }
  ],
  "bundled": true
}