/
CA
capensis
/
Canopsis Community API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 11m ago · Updated 2w ago
latest
OpenAPI 3.0.1
GNU AGPLv3
raw.githubusercontent.com
2026-08-11
403
5
593.2 KB
7c842289e811
account
2
get
Get account
put
Update account
alarm-display-names
1
get
Find alarm display names
alarm-tag-labels
1
get
Get labels of alarm tags
alarm-tags
7
get
Get alarm tags
post
Create an internal alarm tag
get
Get an alarm tag by id
put
Update an alarm tag by id
delete
Delete an alarm tag by id
get
Get pattern fields for alarm tags
delete
Bulk delete alarm tags
alarms
32
get
Count alarms
post
Start export alarms
get
Get status of export alarms
get
Get result of export alarms
post
Get alarms' details
get
Get alarms' links
get
Find all alarms
get
Get alarm by id
put
Ack alarm
put
Remove ack alarm
put
Assoc ticket alarm
put
Remove alarm ticket
put
Add bookmark to an alarm
delete
Remove bookmark from an alarm
put
Cancel alarm
put
Change state alarm
put
Comment alarm
put
Snooze alarm
put
Uncancel alarm
put
Ack alarms
put
Remove ack alarms
put
Assoc ticket alarms
put
Remove alarm tickets
put
Cancel alarms
put
Change state alarms
put
Comment alarms
put
Snooze alarms
put
Uncancel alarms
get
Find opened alarms of component's resource
get
Find opened alarms of service's dependencies
get
Get open alarm by entity
get
Find resolved alarms of entity
associativetables
3
get
Get associativetable by name
post
Create/update associativetable
delete
Delete associativetable by name
auth
4
get
Get file access
get
Get logged user count
post
Log in
post
Log out
broadcast-messages
7
get
Get all active broadcast-message
get
Find all broadcast-message
post
Create broadcast-message
get
Get broadcast-message by id
put
Update broadcast-message by id
delete
Delete broadcast-message by id
put
Read broadcast message by id
color-themes
6
delete
Bulk delete color themes
get
Find all color theme
post
Create color theme
get
Get color theme by id
put
Update color theme by id
delete
Delete color theme by id
comment-templates
6
delete
Bulk delete comment templates
get
Find all comment templates
post
Create comment template
get
Get comment template by id
put
Update comment template by id
delete
Delete comment template by id
contextgraph-import
3
put
Create new import task
put
Create new import partial task
get
Get import status by id
datastorage
2
get
Get conf
put
Update conf
entities
12
put
Bulk disable entities
put
Bulk enable entities
get
Find entities
post
Archive disabled entities
post
Archive unlinked entities
post
Check state setting
post
Clean archived entities
get
Get context graph by id
get
Get state setting by entity id
post
Start export entities
get
Get status of export entities
get
Get result of export entities
entity-categories
5
get
Find entity categories
post
Create entity category
get
Get entity category by id
put
Update entity category by id
delete
Delete entity category by id
entity-comments
3
get
Find entity comments
post
Create entity comment
put
Update entity comment by id
entity-infos-dictionary
2
get
Find entity infos keys
get
Find entity infos values
entitybasics
3
get
Get entity by id
put
Update entity by id
delete
Delete entity by id
entityinfosproperties
6
delete
Bulk delete entity infos properties
get
Find all entity infos properties
post
Create entity infos property
get
Get entity info property by id
put
Update entity info property by id
delete
Delete entity info property by id
entityservices
12
put
Bulk update entityservices
post
Bulk create entityservices
delete
Bulk delete entityservices
get
Get entity service's dependencies by id
get
Get entity's impacted services by id
post
Create entity service
get
Get entity service by id
put
Update entity service by id
delete
Delete entity service by id
get
Get available template variables for entity services
post
Validate entity service templates
get
Get pattern fields for entity services
entityupstream
2
get
Get entity's downstreams by id
get
Get entity's upstream by id
eventfilters
17
put
Bulk update eventfilters
post
Bulk create eventfilters
delete
Bulk delete eventfilters
put
Bulk enable eventfilters
put
Bulk disable eventfilters
get
Find all eventfilter
post
Create eventfilter
get
Get eventfilter by id
put
Update eventfilter by id
delete
Delete eventfilter by id
get
Get failures of event filter rule by id
put
Make failures of event filter rule by id as read
post
Db export eventfilter rules
get
Get available copy variables for event filter rules
get
Get available template variables for event filter rules
post
Validate event filter rule templates
get
Get pattern fields for event filters
events
1
post
Send event/events
exportconfiguration
1
post
Export configurations
externaldata
20
delete
Bulk delete rows from external data table
get
Get status of external data export job
post
Create external data export job
get
Get result of external data export job
post
Create external data import job
put
Preview external data import job with column configuration
put
Complete external data import job
get
Get data of external data import job
get
Get status of external data import job
get
Find all external data tables
post
Create external data table
get
Get external data table by id
put
Update external data table by id
delete
Delete external data table by id
get
Find all external data rows in table
post
Create row in external data table
get
Get schema of external data table
get
Get row from external data table by id
put
Update row in external data table by id
delete
Delete row from external data table by id
files
4
get
List files by ID
post
Upload files
get
Get file by ID
delete
Delete file
flappingrules
10
delete
Bulk delete flapping rules
put
Bulk enable flapping rules
put
Bulk disable flapping rules
get
Find all flapping rule
post
Create flapping rule
get
Get flapping rule by id
put
Update flapping rule by id
delete
Delete flapping rule by id
post
Db export flapping rules
get
Get pattern fields for flapping rules
healthcheck
6
get
Get healthcheck status
get
Get engines' order
get
Get healthcheck parameters
put
Update healthcheck parameters
get
Get healthcheck status code
get
Get short healthcheck status
icons
6
get
List of icons
post
Create an icon
get
Get an icon by id
put
Update an icon
delete
Delete an icon
patch
Patch an icon
idlerules
12
put
Bulk update idlerules
post
Bulk create idlerules
delete
Bulk delete idlerules
put
Bulk enable idlerules
put
Bulk disable idlerules
get
Find idle rules
post
Create idle rule
get
Get idle rule by id
put
Update idle rule by id
delete
Delete idle rule by id
post
Db export idle rules
get
Get pattern fields for idle rules
internal
3
get
Get application information
put
update user interface
delete
delete user interface
linkrules
13
delete
Bulk delete link rules
put
Bulk enable link rules
put
Bulk disable link rules
get
Get link categories
get
Find all link rule
post
Create link rule
get
Get link rule by id
put
Update link rule by id
delete
Delete link rule by id
post
Db export link rules
get
Get available template variables for link rules
post
Validate link rule templates
get
Get pattern fields for link rules
maintenance
1
put
Enable or disable maintenance
message-rate-stats
1
get
Find message rate stats
notification
3
get
Get notification settings
put
Update notification settings
get
Get notifications
optimize-patterns
4
post
Start entity pattern optimization
get
Get entity pattern optimization job status
put
Accept or reject an optimization suggestion
delete
Cancel an optimization job
pbehavior-comments
2
post
Create pbehavior comment
delete
Delete pbehavior comment by id
pbehavior-exceptions
9
post
Import pbehavior exception
get
Find all pbehavior exceptions
post
Create pbehavior exception
get
Get pbehavior exception by id
put
Update behavior exception by id
delete
Delete pbehavior exception by id
delete
Bulk delete pbehavior exceptions
put
Bulk hide pbehavior exceptions
put
Bulk unhide pbehavior exceptions
pbehavior-ics
1
get
Get pbehavior ICS by id
pbehavior-reasons
8
get
Find pbehavior reasons
post
Create pbehavior reason
get
Get pbehavior reason by id
put
Update behavior reason by id
delete
Delete pbehavior reason by id
delete
Bulk delete pbehavior reasons
put
Bulk hide pbehavior reasons
put
Bulk unhide pbehavior reasons
pbehavior-timespans
1
post
Get all pbehavior timespans
pbehavior-types
9
delete
Bulk delete pbehavior types
put
Bulk hide pbehavior types
put
Bulk unhide pbehavior types
get
Find pbehavior types
post
Create pbehavior type
get
Get pbehavior type by id
put
Update behavior type by id
delete
Delete pbehavior type by id
get
Get next priority
pbehaviors
24
put
Bulk create and delete connector pbehaviors
post
Bulk create connector pbehaviors
delete
Bulk delete connector pbehaviors
put
Bulk update pbehaviors
post
Bulk create pbehaviors
delete
Bulk delete pbehaviors
put
Bulk disable pbehaviors
put
Bulk enable pbehaviors
post
Bulk create entity pbehaviors
delete
Bulk delete entity pbehaviors
get
Find pbehaviors by entity id
get
Find pbehaviors by entity id
put
Execute all pbehavior patterns
put
Execute pbehavior pattern
get
Find all pbehaviors
post
Create pbehavior
delete
Delete pbehavior by name
get
Get pbehavior by id
put
Update behavior by id
delete
Delete pbehavior by id
patch
Patch partial set of behavior attributes by id
get
Find entities by pbehavior id
post
Db export pbehaviors
get
Get pattern fields for pbehaviors
permissions
1
get
Find permissions
playlists
8
delete
Bulk delete playlists
put
Bulk enable playlists
put
Bulk disable playlists
get
Find all playlist
post
Create playlist
get
Get playlist by id
put
Update playlist by id
delete
Delete playlist by id
resolverules
9
delete
Bulk delete resolve rules
put
Bulk enable resolve rules
put
Bulk disable resolve rules
get
Find all resolve rule
post
Create resolve rule
get
Get resolve rule by id
put
Update resolve rule by id
delete
Delete resolve rule by id
get
Get pattern fields for resolve rules
roles
8
put
Bulk update role permissions
delete
Bulk delete roles
get
Get role templates
get
Find roles
post
Create role
get
Get role by id
put
Update role by id
delete
Delete role by id
saved-patterns
8
delete
Bulk delete patterns
post
Count alarm matches
post
Count entity matches
get
Find all saved patterns
post
Create saved pattern
get
Get saved pattern by id
put
Update saved pattern by id
delete
Delete saved pattern by id
scenarios
14
put
Bulk update scenarios
post
Bulk create scenarios
delete
Bulk delete scenarios
put
Bulk enable scenarios
put
Bulk disable scenarios
get
Find scenarios
post
Create scenario
get
Get scenario by id
put
Update scenario by id
delete
Delete scenario by id
post
Db export scenarios
get
Get available template variables for action scenarios
post
Validate action scenario templates
get
Get pattern fields for action scenarios
share-tokens
3
get
Find share tokens
post
Create share token
delete
Delete share token by id
state-settings
6
get
Find all state settings
post
Create state setting
get
Get state setting by id
put
Update state setting by id
delete
Delete state setting by id
get
Get pattern fields for state settings
tech-metrics
3
get
Get status of export tech metrics
post
Start export tech metrics
get
Get result of export tech metrics
tech-metrics-settings
2
get
Get tech metrics settings
put
Update tech metrics settings
template-validator
1
get
Get template env vars
tpldata
5
get
Find all template data
post
Create template data
get
Get template data by id
put
Update template data by id
delete
Delete template data by id
tpltest
5
get
Find all template test
post
Create template test
get
Get template test by id
put
Update template test by id
delete
Delete template test by id
userpreference
2
put
Update user preferences by widget id
get
Get user preferences by widget id
users
12
put
Bulk update users
post
Bulk create users
delete
Bulk delete users
patch
Bulk patch users
put
Bulk enable users
put
Bulk disable users
get
Find users
post
Create user
get
Get user by id
put
Update user by id
delete
Delete user by id
patch
Partial user update by id
viewgroups
5
get
Find view groups
post
Create view group
get
Get view group by id
put
Update view group by id
delete
Delete view group by id
views
8
post
Copy view
post
Export views
post
Import views
put
Update views positions
post
Create view
get
Get view by id
put
Update view by id
delete
Delete view by id
viewtabs
6
post
Copy view tab
put
Update view tabs positions
post
Create view tab
get
Get view tab by id
put
Update view tab by id
delete
Delete view tab by id
weather-services
2
get
Find all services
get
Find all entity by service id
widgetfilters
7
get
Find widget filters
post
Create widget filter
get
Get widget filter by id
put
Update widget filter by id
delete
Delete widget filter by id
put
Update widget filters positions
get
Get pattern fields for widget filters
widgets
6
post
Copy widget
put
Update widgets grid positions
post
Create widget
get
Get widget by id
put
Update widget by id
delete
Delete widget by id
widgettemplates
7
get
Find widget templates
post
Create widget template
get
Get widget template by id
put
Update widget template by id
delete
Delete widget template by id
get
Get available template variables for widgets
post
Validate widget templates
account
Get account
Get account.
get
/account/me
Response
OK
AccountUser
required
— unresolved $ref