| Field | Required | Accessor | Description |
|---|---|---|---|
| name | — | Full name of the site | |
| slug | — | Slug | |
| status | — |
Operational status
|
|
| region | — | name | Assigned region |
| group | — | name | Assigned group |
| tenant | — | name | Assigned tenant |
| facility | — | — | Local facility ID or description |
| time_zone | — | — | Time zone (available options) |
| description | — | — | Description |
| physical_address | — | — | Physical location of the building |
| shipping_address | — | — | If different from the physical address |
| latitude | — | — | GPS coordinate in decimal format (xx.yyyyyy) |
| longitude | — | — | GPS coordinate in decimal format (xx.yyyyyy) |
| comments | — | — | Comments |
| tags | — | slug | Tag slugs separated by commas, encased with double quotes (e.g. "tag1,tag2,tag3") |
| id | — | — | Numeric ID of an existing object to update (if not creating a new object) |
Required fields must be specified for all objects.
Related objects may be referenced by any unique attribute. For example, vrf.rd would identify a VRF by its route distinguisher.