IAP/REST API Index

Owned by Rich Blomseth
Last updated: 14-Aug-2024 by Nina Cardillo

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
AccessGET, PUT/iap/access/zones/{id}
AlarmsGET/iap/alarms  
AlarmsPUT/iap/alarms/clear 
AlarmsGET

/iap/alarms/count 

AlarmsGET, POST/iap/alarms/definitions 
AlarmsGET, DELETE/iap/alarms/definitions/{id} 
AlarmsGET/iap/alarms/definitions/{id}/subscribers 
AlarmsGET

/iap/alarms/dev/count 

AlarmsGET/iap/alarms/dev/count/{deviceId}
AlarmsGET/iap/alarms/device/{deviceId} 
AlarmsPUT/iap/alarms/devs 
AlarmsGET/iap/alarms/export 
AlarmsGET/iap/alarms/ids 
AlarmsGET/iap/alarms/types 
AuthenticationPOST

/iap/auth/login

Authentication
PUT

/iap/auth/logout

Authentication
PUT/iap/auth/resetPwd
AuthenticationGET/iap/auth/sessionTimeout
CapabilitiesPUTiap/capabilities/customer/{id}/deprovision  
CapabilitiesPUTiap/capabilities/customer/{id}/provision
CapabilitiesPUTiap/capabilities/floor/{id}/deprovision  
CapabilitiesPUT

iap/capabilities/floor/{id}/provision 

CapabilitiesPUTiap/capabilities/floorplan/{id}/deprovision  
CapabilitiesPUTiap/capabilities/floorplan/{id}/provision 
CapabilitiesPUTiap/capabilities/grp/{id}/deprovision  
CapabilitiesPUTiap/capabilities/grp/{id}/provision 
CapabilitiesPUTiap/capabilities/gz/{id}/deprovision  
CapabilitiesPUTiap/capabilities/gz/{id}/provision 
CapabilitiesPUTiap/capabilities/zone/{id}/deprovision  
CapabilitiesPUTiap/capabilities/zone/{id}/provision 
Connection 
(Export CON file)		POST/iap/con/export
ContextGET, POST, PUT/iap/context
ContextGET, DELETE/iap/context/{id}
ContextPUT/iap/context/assignDevicesTo/{id}
ContextGET/iap/context/export
ContextPOST/iap/context/import
ContextPUT/iap/context/unassignDevices
CustomersPUT, POST

/iap/customers

CustomersGET,/iap/customers/current
CustomersGET, DELETE/iap/customers/{customerId}
CustomersGET/iap/customers/generateKey
Datapoint CategoriesGET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/cat

Datapoint Default ValuesGET, PUT, DELETE

/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/default

Datapoint LogsGET, PUT, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/{level}
Datapoint LogsGET, PUT, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/minDeltaTime
Datapoint LogsGET, PUT, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/minDeltaValue
Datapoint LogsGET, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/logs/value/{value_param}
Datapoint MonitorGET, PUT, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/monitor
Datapoint Override StateGET, PUT/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/state
Datapoint Override ValueGET, PUT, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value
Datapoint OverridesGET/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides
Datapoint PropertiesGET/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/[{prop_name} | *]
Datapoint PropertiesPUT/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/{prop_name}
Datapoint TagsGET, PUT, DELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags/{tag_name}
Datapoint TagsPOST/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/tags
Datapoint TypeGET, PUT/iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/type
Datapoint ValueGET, 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 RelinquishDELETE/iap/devs/{id}/if/{block}/{block_index}/{datapoint}/overrides/{level}/value
DevicesGET, POST /iap/devs
DevicesGET, DELETE /iap/devs/{id} 
DevicesPUT /iap/devs/{id}/assign/floor/{Fid} 
DevicesPUT /iap/devs/{id}/changeScTo/{sid} 
Device CapabilitiesPUT/iap/devs/{id}/demand 
Device CapabilitiesPUT/iap/devs/{id}/replace  
DevicesPOST/iap/devs/{id}/tags 
DevicesPUT, DELETE/iap/devs/{id}/tags/{tag_param}
Device CapabilitiesPUT/iap/devs/{id}/test 
DevicesPUT /iap/devs/{id}/unassign/floor 
Device CapabilitiesPUT/iap/devs/{id}/wink 
DevicesGET/iap/devs/{param}
DevicesPOST/iap/devs/{param}/tags
Device CapabilitiesPUT/iap/devs/{scId}/rebuild 
DevicesPOST/iap/devs/bulk 
Device CapabilitiesPUT/iap/devs/bulkFirmwareUpdate/{deviceModel} 
DevicesGET /iap/devs/count  
Devices POST/iap/devs/create 
Devices    PUT /iap/devs/delete 
Device CapabilitiesPUT/iap/devs/deprovision 
Device CapabilitiesPUT/iap/devs/discover 
DevicesPUT/iap/devs/dpTypeNames
DevicesPUT /iap/devs/exportByIDs 
Device CapabilitiesGET/iap/devs/firmwareImgList  
DevicesPOST 

/iap/devs/floor/{id}  

DevicesGET/iap/devs/grp/{id} 
DevicesGET /iap/devs/gz/{id} 
DevicesGET/iap/devs/ids 
DevicesPOST /iap/devs/import 
DevicesPUT /iap/devs/listByIDs 
Device CapabilitiesPUT/iap/devs/load/{id} 
Device CapabilitiesPUT/iap/devs/loadAllWith/{fileId} 
Device CapabilitiesPUT/iap/devs/loadWith/{fileId}/{devId} 
DevicesPUT /iap/devs/loadForAllDevices 
Device CapabilitiesGET/iap/devs/lonmode 
Device CapabilitiesPUT/iap/devs/lonmode/{mode} 
DevicesPUT/iap/devs/lon/offnet
DevicesPUT/iap/devs/lon/onnet
Device CapabilitiesPUT/iap/devs/provision 
Device CapabilitiesPUT/iap/devs/reset  
DevicesPUT /iap/devs/updateProperties 
Device TypesPOST/iap/devTypes
Device TypesGET/iap/devTypes/{device_type}
Device TypesPUT/iap/devTypes/{id}
Device TypesPOST/iap/devTypes/delete
Device TypesPOST/iap/devTypes/export
Device TypesPOST/iap/devTypes/export/packaged
Datapoint FavoritesGET, POST/iap/dp/favorites
Datapoint FavoritesGET/iap/dp/favorites/{id}
Datapoint FavoritesPUT/iap/dp/favorites/delete
Datapoint FavoritesGET/iap/dp/favorites/name/{name}
Datapoint FavoritesPUT/iap/dp/favorites/updateTime
Device TypesGET, POST/iap/metafile/{file_type}
Device TypesGET/iap/protocols
DiagnosticsGET

/iap/diagnostics/file/{filename} 

DiagnosticsGET/iap/diagnostics/gather
DLA FilesGET/iap/devType/{device_type}/if/{block}{block_index}/{datapoint}/dla
DLA FilesGET/iap/devType/{device_type}/if/{block){block_index}/{datapoint}/dla/count  
DLA FilesGET/iap/dla/totalParameters
DLA FilesPUT/iap/dlaRules
DLA FilesGET/iap/dlaRules/{device_type}/datapointsToCopy
DLA FilesPUT/iap/dlaRules/clear
DLA FilesPUT/iap/dlaRules/clearAll
DLA FilesPUT/iap/dlaRules/export
DLA FilesPUT/iap/dlaRules/exportAll
DriversGET, POST/iap/drivers
DriversPUT, DELETE/iap/drivers/{id} 
DriversGET/iap/drivers/{name}
DriversGET/iap/drivers/predefined
FloorplansGET, POST/iap/floorplans 
FloorplansPUT, DELETE/iap/floorplans/{id} 
FloorplansGET, POST/iap/floorplans/{id}/floors 
FloorplansGET/iap/floorplans/count 
FloorplansPUT, DELETE/iap/floorplans/floors/{id}
FloorplansGET/iap/floorplans/listByIDs
GeozoneGET, PUT/iap/gz 
GeozoneGET, DELETE/iap/gz/{id} 
GeozoneGET/iap/gz/{id}/children 
GeozonePOST/iap/gz/child 
GeozoneGET/iap/gz/count
GeozonePOST/iap/gz/root
GeozoneGET/iap/gz/roots
GroupsGET, PUT, POST/iap/grp
GroupsPUT/iap/grp/{groupId}/addDevs
GroupsPUT/iap/grp/{groupId}/assign/dev
GroupsPUT/iap/grp/{groupId}/assign/devs
GroupsPUT/iap/grp/{groupId}/assign/dp
GroupsPUT/iap/grp/{groupId}/rmDevs
GroupsPUT/iap/grp/{groupId}/unassign/devs
GroupsPUT/iap/grp/{groupId}/unassign/dp
GroupsGET/iap/grp/count
GroupsPUT/iap/grp/delete
GroupsPUT/iap/grp/doImport/{importId}
GroupsPUT/iap/grp/getApplicable
GroupsGET/iap/grp/gz/{id}
GroupsGET, DELETE/iap/grp/{id}
GroupsPOST/iap/grp/import
Log DestinationGET, POST/iap/log/destination
Log EventsGET, PUT, DELETE/iap/log/ev/{event_id}
Log EventsPOST/iap/log/ev
Log StateGET, PUT/iap/log/state
Log StatusGET/iap/log/status
On-DemandPOST/iap/dp/ondemand
PermissionsGET/iap/permissions
PresetsGET/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/presets
PresetsPUT/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/presets/value
PresetsGET/iap/dp/presets/names
ProtocolsGET, POST/iap/protocols
ProtocolsPUT, DELETE/iap/protocols/{id}
ProtocolsGET/iap/protocols/{name}
ProtocolsGET/iap/protocols/predefined
ReportsGET, POST/iap/reports
ReportsGET, DELETE/iap/reports/{Id}
ReportsGET, PUT, POST/iap/reports/definitions
ReportsGET, DELETE/iap/reports/definitions/{id}
ReportsPUT/iap/reports/definitions/delete
ReportsPUT/iap/reports/delete
ReportsPUT, POST/iap/reports/exportByID
ReportsGET/iap/reports/types
RolesGET/iap/roles
Schedule ServiceGET/iap/sev/{schedule}
Schedule ServiceGET/iap/sev/{schedule}/count
Schedule ServicePOST/iap/sev
Schedule ServicePUT/iap/sev/{id}
Schedule ServicePUT/iap/sev/delete
SMTP ConfigurationGET, POST/iap/smtp/configuration
Transformation ServicePUT/iap/dlaRules
Transformation ServiceGET/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/localization
Transformation ServicePUT/iap/dp/{id}/if/{block}/{block_index}/{datapoint_name}/localization/value
Transformation ServiceGET/iap/dp/localization/names
UsersGET, PUT, POST/iap/users
UsersDELETE/iap/users/{id}
UsersGET/iap/users/{id}/customer
UsersPUT/iap/users/acceptlicense
UsersGET, PUT/iap/users/count
UsersPUT/iap/users/cp
UsersGET/iap/users/current
UsersGET/iap/users/list
UsersGET, POST/iap/users/locale
VersionGET/iap/version
VersionGET, PUT/iap/version/updates
ZonesGET/iap/zones
ZonesGET, PUT/iap/zones/{id}
ZonesGET/iap/zones/{id}/children
ZonesGET/iap/zones/{zone}
ZonesPOST/iap/zones/child
ZonesGET/iap/zones/count
ZonesPUT/iap/zones/delete
ZonesPOST/iap/zones/root
ZonesGET/iap/zones/roots