Sites

updateSiteInfo

PUT
/api/v1/sites/{site_id}

Updates the configuration and metadata for an existing site.

This endpoint allows modification of site properties including location details (address, coordinates, timezone), template associations (alarm, network, RF, security policy templates), site group memberships, and general information (name, notes).

All fields are optional and only provided fields will be updated.

Authorization

Authorization<token>

Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.

Format: Authorization: Token {apitoken}

Notes:

  • An API token generated for a specific admin has the same privileges as that admin
  • An API token is automatically removed if it is not used for more than 90 days
  • SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.

In: header

Path Parameters

site_id*string
Formatuuid

Request Body

application/json

Request Body

Site configuration and metadata within an organization

address?|

full address of the site

alarmtemplate_id?|

Alarm Template ID, this takes precedence over the Org-level alarmtemplate_id

Formatuuid
aptemplate_id?|

AP Template ID, used by APs

Formatuuid
country_code?string

Country code for the site (for AP config generation), in two-character

gatewaytemplate_id?|

Gateway Template ID, used by gateways

Formatuuid
latlng?

Latitude and longitude for the site location

name*string

Display name of the site

networktemplate_id?|

Network Template ID, this takes precedence over Site Settings

Formatuuid
notes?|

Optional, any notes about the site

rftemplate_id?|

RF Template ID, this takes precedence over Site Settings

Formatuuid
routertemplate_id?|

Router Template ID, used by gateways

Formatuuid
secpolicy_id?|

Security policy identifier applied to this site

Formatuuid
sitegroup_ids?array<>

Site group identifiers for groups that include this site

sitetemplate_id?|

Site template identifier applied to this site

Formatuuid
timezone?string

IANA time zone name for the site

Default"UTC"
tzoffset?integer

Time zone offset value derived from the site's timezone

Default0

Response Body

curl -X PUT "https://example.com/api/v1/sites/000000ab-00ab-00ab-00ab-0000000000ab" \  -H "Content-Type: application/json" \  -d '{    "address": "string",    "alarmtemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "country_code": "string",    "latlng": {      "lat": 0,      "lng": 0    },    "name": "string",    "networktemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "notes": "string",    "rftemplate_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "secpolicy_id": "b069b358-4c97-5319-1f8c-7c5ca64d6ab1",    "sitegroup_ids": [      "b069b358-4c97-5319-1f8c-7c5ca64d6ab1"    ],    "timezone": "string"  }'
{  "address": "1601 S. Deanza Blvd., Cupertino, CA, 95014",  "alarmtemplate_id": "684dfc5c-fe77-2290-eb1d-ef3d677fe168",  "aptemplate_id": "16bdf952-ade2-4491-80b0-85ce506c760b",  "country_code": "US",  "created_time": 0,  "gatewaytemplate_id": "6f9b2e75-9b2f-b5ae-81e3-e14c76f1a90f",  "id": "497f6eca-6276-5005-bfeb-53cbbbba6f17",  "latlng": {    "lat": 37.295833,    "lng": -122.032946  },  "modified_time": 0,  "name": "Mist Office",  "networktemplate_id": "12ae9bd2-e0ab-107b-72e8-a7a005565ec2",  "notes": "string",  "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",  "rftemplate_id": "bb8a9017-1e36-5d6c-6f2b-551abe8a76a2",  "secpolicy_id": "3bcd0beb-5d0a-4cbd-92c1-14aea91e98ef",  "sitegroup_ids": [    "497f6eca-6276-5006-bfeb-53cbbbba6f18"  ],  "timezone": "America/Los_Angeles"}