IAP/REST API Index

This page lists the API endpoints in alphabetical order based on the resource name. The available methods and reference documentation are listed for each endpoint.

Resource	Methods	API Endpoint

Resource	Methods	API Endpoint
Access	GET, PUT	/iap/access/zones/{id}
Alarms	GET	/iap/alarms
Alarms	PUT	/iap/alarms/clear
Alarms	GET	/iap/alarms/count
Alarms	GET, POST	/iap/alarms/definitions
Alarms	GET, DELETE	/iap/alarms/definitions/{id}
Alarms	GET	/iap/alarms/definitions/{id}/subscribers
Alarms	GET	/iap/alarms/dev/count
Alarms	GET	/iap/alarms/dev/count/{deviceId}
Alarms	GET	/iap/alarms/device/{deviceId}
Alarms	PUT	/iap/alarms/devs
Alarms	GET	/iap/alarms/export
Alarms	GET	/iap/alarms/ids
Alarms	GET	/iap/alarms/types
Authentication	POST	/iap/auth/login
Authentication	PUT	/iap/auth/logout
Authentication	PUT	/iap/auth/resetPwd
Authentication	GET	/iap/auth/sessionTimeout
Capabilities	PUT	iap/capabilities/customer/{id}/deprovision
Capabilities	PUT	iap/capabilities/customer/{id}/provision
Capabilities	PUT	iap/capabilities/floor/{id}/deprovision
Capabilities	PUT	iap/capabilities/floor/{id}/provision
Capabilities	PUT	iap/capabilities/floorplan/{id}/deprovision
Capabilities	PUT	iap/capabilities/floorplan/{id}/provision
Capabilities	PUT	iap/capabilities/grp/{id}/deprovision
Capabilities	PUT	iap/capabilities/grp/{id}/provision
Capabilities	PUT	iap/capabilities/gz/{id}/deprovision
Capabilities	PUT	iap/capabilities/gz/{id}/provision
Capabilities	PUT	iap/capabilities/zone/{id}/deprovision
Capabilities	PUT	iap/capabilities/zone/{id}/provision
Connection (Export CON file)	POST	/iap/con/export
Context	GET, POST, PUT	/iap/context
Context	GET, DELETE	/iap/context/{id}
Context	PUT	/iap/context/assignDevicesTo/{id}
Context	GET	/iap/context/export
Context	POST	/iap/context/import
Context	PUT	/iap/context/unassignDevices
Customers	PUT, POST	/iap/customers
Customers	GET,	/iap/customers/current
Customers	GET, DELETE	/iap/customers/{customerId}
Customers	GET	/iap/customers/generateKey
Datapoint Categories	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/cat
Datapoint Default Values	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/default
Datapoint Logs	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/{level}
Datapoint Logs	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/minDeltaTime
Datapoint Logs	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/minDeltaValue
Datapoint Logs	GET, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/value/{value_param}
Datapoint Monitor	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/monitor
Datapoint Override State	GET, PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/state
Datapoint Override Value	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value
Datapoint Overrides	GET	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides
Datapoint Properties	GET	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/[{prop_name} \| *]
Datapoint Properties	PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/{prop_name}
Datapoint Tags	GET, PUT, DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags/{tag_name}
Datapoint Tags	POST	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags
Datapoint Type	GET, PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/type
Datapoint Value	GET, PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/value/{prop_name}
Datapoint Value (localized value)	PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/localization/value /iap/devs/{id}/if/{block}/{block_index}/{datapoint}/localization/value
Datapoint Value (preset value)	PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/presets/value /iap/devs/{id}/if/{block}/{block_index}/{datapoint}/presets/value
Datapoint Value (original value)	PUT	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value /iap/devs/{id}/if/{block}/{block_index}/{datapoint}/value
Datapoint Relinquish	DELETE	/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value
Devices	GET, POST	/iap/devs
Devices	GET, DELETE	/iap/devs/{id}
Devices	PUT	/iap/devs/{id}/assign/floor/{Fid}
Devices	PUT	/iap/devs/{id}/changeScTo/{sid}
Device Capabilities	PUT	/iap/devs/{id}/demand
Device Capabilities	PUT	/iap/devs/{id}/replace
Devices	POST	/iap/devs/{id}/tags
Devices	PUT, DELETE	/iap/devs/{id}/tags/{tag_param}
Device Capabilities	PUT	/iap/devs/{id}/test
Devices	PUT	/iap/devs/{id}/unassign/floor
Device Capabilities	PUT	/iap/devs/{id}/wink
Devices	GET	/iap/devs/{param}
Devices	POST	/iap/devs/{param}/tags
Device Capabilities	PUT	/iap/devs/{scId}/rebuild
Devices	POST	/iap/devs/bulk
Device Capabilities	PUT	/iap/devs/bulkFirmwareUpdate/{deviceModel}
Devices	GET	/iap/devs/count
Devices	POST	/iap/devs/create
Devices	PUT	/iap/devs/delete
Device Capabilities	PUT	/iap/devs/deprovision
Device Capabilities	PUT	/iap/devs/discover
Devices	PUT	/iap/devs/dpTypeNames
Devices	PUT	/iap/devs/exportByIDs
Device Capabilities	GET	/iap/devs/firmwareImgList
Devices	POST	/iap/devs/floor/{id}
Devices	GET	/iap/devs/grp/{id}
Devices	GET	/iap/devs/gz/{id}
Devices	GET	/iap/devs/ids
Devices	POST	/iap/devs/import
Devices	PUT	/iap/devs/listByIDs
Device Capabilities	PUT	/iap/devs/load/{id}
Device Capabilities	PUT	/iap/devs/loadAllWith/{fileId}
Device Capabilities	PUT	/iap/devs/loadWith/{fileId}/{devId}
Devices	PUT	/iap/devs/loadForAllDevices
Device Capabilities	GET	/iap/devs/lonmode
Device Capabilities	PUT	/iap/devs/lonmode/{mode}
Devices	PUT	/iap/devs/lon/offnet
Devices	PUT	/iap/devs/lon/onnet
Device Capabilities	PUT	/iap/devs/provision
Device Capabilities	PUT	/iap/devs/reset
Devices	PUT	/iap/devs/updateProperties
Device Types	POST	/iap/devTypes
Device Types	GET	/iap/devTypes/{device_type}
Device Types	PUT	/iap/devTypes/{id}
Device Types	POST	/iap/devTypes/delete
Device Types	POST	/iap/devTypes/export
Device Types	POST	/iap/devTypes/export/packaged
Datapoint Favorites	GET, POST	/iap/dp/favorites
Datapoint Favorites	GET	/iap/dp/favorites/{id}
Datapoint Favorites	PUT	/iap/dp/favorites/delete
Datapoint Favorites	GET	/iap/dp/favorites/name/{name}
Datapoint Favorites	PUT	/iap/dp/favorites/updateTime
Device Types	GET, POST	/iap/metafile/{file_type}
Device Types	GET	/iap/protocols
Diagnostics	GET	/iap/diagnostics/file/{filename}
Diagnostics	GET	/iap/diagnostics/gather
DLA Files	GET	/iap/devType/{device_type}/if/{block}{block_index}/{datapoint}/dla
DLA Files	GET	/iap/devType/{device_type}/if/{block){block_index}/{datapoint}/dla/count
DLA Files	GET	/iap/dla/totalParameters
DLA Files	PUT	/iap/dlaRules
DLA Files	GET	/iap/dlaRules/{device_type}/datapointsToCopy
DLA Files	PUT	/iap/dlaRules/clear
DLA Files	PUT	/iap/dlaRules/clearAll
DLA Files	PUT	/iap/dlaRules/export
DLA Files	PUT	/iap/dlaRules/exportAll
Drivers	GET, POST	/iap/drivers
Drivers	PUT, DELETE	/iap/drivers/{id}
Drivers	GET	/iap/drivers/{name}
Drivers	GET	/iap/drivers/predefined
Floorplans	GET, POST	/iap/floorplans
Floorplans	PUT, DELETE	/iap/floorplans/{id}
Floorplans	GET, POST	/iap/floorplans/{id}/floors
Floorplans	GET	/iap/floorplans/count
Floorplans	PUT, DELETE	/iap/floorplans/floors/{id}
Floorplans	GET	/iap/floorplans/listByIDs
Geozone	GET, PUT	/iap/gz
Geozone	GET, DELETE	/iap/gz/{id}
Geozone	GET	/iap/gz/{id}/children
Geozone	POST	/iap/gz/child
Geozone	GET	/iap/gz/count
Geozone	POST	/iap/gz/root
Geozone	GET	/iap/gz/roots
Groups	GET, PUT, POST	/iap/grp
Groups	PUT	/iap/grp/{groupId}/addDevs
Groups	PUT	/iap/grp/{groupId}/assign/dev
Groups	PUT	/iap/grp/{groupId}/assign/devs
Groups	PUT	/iap/grp/{groupId}/assign/dp
Groups	PUT	/iap/grp/{groupId}/rmDevs
Groups	PUT	/iap/grp/{groupId}/unassign/devs
Groups	PUT	/iap/grp/{groupId}/unassign/dp
Groups	GET	/iap/grp/count
Groups	PUT	/iap/grp/delete
Groups	PUT	/iap/grp/doImport/{importId}
Groups	PUT	/iap/grp/getApplicable
Groups	GET	/iap/grp/gz/{id}
Groups	GET, DELETE	/iap/grp/{id}
Groups	POST	/iap/grp/import
Log Destination	GET, POST	/iap/log/destination
Log Events	GET, PUT, DELETE	/iap/log/ev/{event_id}
Log Events	POST	/iap/log/ev
Log State	GET, PUT	/iap/log/state
Log Status	GET	/iap/log/status
On-Demand	POST	/iap/dp/ondemand
Permissions	GET	/iap/permissions
Presets	GET	/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/presets
Presets	PUT	/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/presets/value
Presets	GET	/iap/dp/presets/names
Protocols	GET, POST	/iap/protocols
Protocols	PUT, DELETE	/iap/protocols/{id}
Protocols	GET	/iap/protocols/{name}
Protocols	GET	/iap/protocols/predefined
Reports	GET, POST	/iap/reports
Reports	GET, DELETE	/iap/reports/{Id}
Reports	GET, PUT, POST	/iap/reports/definitions
Reports	GET, DELETE	/iap/reports/definitions/{id}
Reports	PUT	/iap/reports/definitions/delete
Reports	PUT	/iap/reports/delete
Reports	PUT, POST	/iap/reports/exportByID
Reports	GET	/iap/reports/types
Roles	GET	/iap/roles
Schedule Service	GET	/iap/sev/{schedule}
Schedule Service	GET	/iap/sev/{schedule}/count
Schedule Service	POST	/iap/sev
Schedule Service	PUT	/iap/sev/{id}
Schedule Service	PUT	/iap/sev/delete
SMTP Configuration	GET, POST	/iap/smtp/configuration
Transformation Service	PUT	/iap/dlaRules
Transformation Service	GET	/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/localization
Transformation Service	PUT	/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/localization/value
Transformation Service	GET	/iap/dp/localization/names
Users	GET, PUT, POST	/iap/users
Users	DELETE	/iap/users/{id}
Users	GET	/iap/users/{id}/customer
Users	PUT	/iap/users/acceptlicense
Users	GET, PUT	/iap/users/count
Users	PUT	/iap/users/cp
Users	GET	/iap/users/current
Users	GET	/iap/users/list
Users	GET, POST	/iap/users/locale
Version	GET	/iap/version
Version	GET, PUT	/iap/version/updates
Zones	GET	/iap/zones
Zones	GET, PUT	/iap/zones/{id}
Zones	GET	/iap/zones/{id}/children
Zones	GET	/iap/zones/{zone}
Zones	POST	/iap/zones/child
Zones	GET	/iap/zones/count
Zones	PUT	/iap/zones/delete
Zones	POST	/iap/zones/root
Zones	GET	/iap/zones/roots

IAP/REST API Index

Related content