/locations

post

https://{BaseUrl}/api/v3.0/locations

This endpoint allows you to create a new location. Support for Location-based camera grouping is only available in the professional and enterprise editions.

Body Params

address

object

notes

string

length between 0 and 128

Description for the location

geometry

object | null

GeoJSON structure to store polygon for the specific location. Currently the only supported geometry type is MultiPolygon, but in the future more GeoJSON schemas might be supported, so clients should be able to handle unknown schemas.

This field must be in the standard GeoJSON format, as described in https://datatracker.ietf.org/doc/html/rfc7946

Please read https://datatracker.ietf.org/doc/html/rfc7946 for more information about the GeoJSON standard.

childLocationCount

string

effectivePermissions

string

resourceCounts

string

resourceStatusCounts

string

name

string

required

length between 1 and 126

parentId

string

Defaults to null

Unique identifier of this location's parent location in the hierarchy

isDefault

boolean

Defaults to false

Specifies if a new device should be automatically assigned to this location if not supplied

Responses

Language

Credentials

Bearer

JWT

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Location created

400The supplied object is invalid. Error detail will contain the validation error.

401You are not authenticated. Please authenticate and try again.

403You have no permission to access the specified resource.

404Referenced resource could not be found.

500Something went wrong in the server. Please try again.