web sdk endpoints

Web SDK endpoint reference

The Web SDK exposes a fixed set of HTTP endpoints organized by functional area. The tables below catalog every endpoint and link to the page that covers it in depth.

Entity endpoints

Endpoint	Method	Purpose
/entity/exists/{id}	GET	Check if entity exists
/entity/{id}	GET	Get complete entity data
/entity/basic/{id}	GET	Get basic entity properties only
/entity?q={query}	GET	Read entity properties and call entity methods
/entity?q={query}	POST	Read, create, or update entities and call entity methods
/entity/{id}	DELETE	Delete entity

Calling an entity method through GET can change entity state.

See The /entity endpoint.

Events endpoints

Endpoint	Method	Purpose
/events	GET	Redirects to the streaming endpoint on the streaming port
/events/subscribe?q={query}	GET	Subscribe to events
/events/subscribed	GET	List current subscriptions
/events/unsubscribe?q={query}	GET	Unsubscribe from events
/events/closeconnection/{connectionId}	POST	Close streaming connection
/events/RaiseEvent/{eventType}/{entityId}	POST	Raise system event
/events/RaiseCustomEvent/{customEventId}/{entityId}/{message}	POST	Raise custom event
/events/alarmMonitoring/{onOrOff}	POST	Toggle alarm monitoring

See Monitoring events and alarms.

Alarm endpoints

Endpoint	Method	Purpose
/alarm?q={query}	GET	Trigger and acknowledge alarms, and check their status
/activealarms	GET	Get list of active alarms

Report endpoints

Endpoint	Method	Purpose
/report/{reportType}?q={query}	GET	Execute reports with filters

See The /report endpoint.

Task endpoints

Endpoint	Method	Purpose
/tasks/public	GET	Get public saved tasks
/tasks/private	GET	Get private saved tasks
/tasks/execute/{guid}	POST	Execute saved task by GUID
/tasks/public/execute/{taskType}/{taskName}	POST	Execute public saved task
/tasks/private/execute/{taskType}/{taskName}	POST	Execute private saved task

See Executing saved tasks.

Action endpoints

Endpoint	Method	Purpose
/action?q={query}	POST	Execute action manager operations

See The /action endpoint.

Macro endpoints

Endpoint	Method	Purpose
/activemacros	GET	List running macros
/activemacrosdetails	GET	Get details about running macros

See Working with macros.

Incident endpoints

Endpoint	Method	Purpose
/incident?q={query}	PUT	Create incidents
/incident?q={query}	GET	Read incidents
/incident/{incidentGuid}	GET	Get specific incident

See The /incident endpoint.

Custom field endpoints

Endpoint	Method	Purpose
/customField/{entityId}/{customFieldName}	GET	Get custom field value
/customField/{entityId}/{customFieldName}/{value}	PUT	Set custom field value
/customField/{entityType}/{customFieldName}/{dataType}/{defaultValue}	POST	Create custom field
/customField/{entityType}/{customFieldName}/Encrypt/{dataType}/{defaultValue}	POST	Create encrypted custom field
/customField/{entityType}/{customFieldName}	DELETE	Delete custom field

See Working with custom fields.

Configuration endpoints

Endpoint	Method	Purpose
/	GET	Test service online status
/GetWebTokenEncoded	GET	Get encoded web token
/GetWebTokenDecoded	GET	Get the web token's decoded payload
/creationpartition/{partitionIds}	POST	Set default creation partitions
/ignoreremoteexception/{state}	POST	Configure exception handling

See Querying system information for web tokens and exception handling, Getting started with the Web SDK for keep-alive and session details, and Working with partitions for creation partitions.

Custom entity type endpoints

Endpoint	Method	Purpose
/customEntityType/all	GET	Get all custom entity types
/customEntityType/{customEntityTypeDescriptorId}	GET	Get specific custom entity type
/customEntityType/{customEntityTypeDescriptorId}	DELETE	Delete custom entity type

See Managing custom entity types.

Custom card format endpoints

Endpoint	Method	Purpose
/customCardFormats/all	GET	Get all custom card formats
/customCardFormats/getByName/{name}	GET	Get card format by name
/customCardFormats/getByFormatId/{formatId}	GET	Get card format by format ID
/customCardFormats/getById/{id}	GET	Get card format by ID
/customCardFormats/add	POST	Create new custom card format
/customCardFormats/updateByName/{name}	PUT	Update card format by name
/customCardFormats/updateByFormatId/{formatId}	PUT	Update card format by format ID
/customCardFormats/updateById/{id}	PUT	Update card format by ID
/customCardFormats/deleteByName/{name}	DELETE	Delete card format by name
/customCardFormats/deleteByFormatId/{formatId}	DELETE	Delete card format by format ID
/customCardFormats/deleteById/{id}	DELETE	Delete card format by ID

See The /customCardFormats endpoint.

License usage endpoints

Endpoint	Method	Purpose
/licenseItemUsage	GET	Get license usage information
/licenseItemUsage/{name}	GET	Get specific license item usage

See License usage.

See also

• The /entity endpoint: The /entity endpoint and shared q= query syntax.
• Working with partitions: Partition membership and entity scope.
• Getting started with Security Center Web SDK: Authentication, your first API call, and Web SDK role setup.