Skip to content

Latest commit

 

History

History
241 lines (135 loc) · 7.6 KB

EventHandlersApi.md

File metadata and controls

241 lines (135 loc) · 7.6 KB

\EventHandlersApi

All URIs are relative to http://localhost

Method HTTP request Description
enable_event_handler PATCH /v1/contexts/{context}/handlers/events/{eventHandlerId} Enables/disables the event handler
event_endpoint_types GET /v1/handlers/events/endpointTypes Returns a list of all endpoint types for events
get_event_handler GET /v1/contexts/{context}/handlers/events/{eventHandlerId} Returns the event handler
list_event_handlers GET /v1/contexts/{context}/handlers/events Returns a list of event handlers
list_event_handlers_of_all_contexts GET /v1/handlers/events Returns a list of event handlers of all contexts
register_event_handler POST /v1/contexts/{context}/handlers/events Registers a new event handler
replace_event_handler PUT /v1/contexts/{context}/handlers/events/{eventHandlerId} Created or replaces the event handler
unregister_event_handler DELETE /v1/contexts/{context}/handlers/events/{eventHandlerId} Unregisters the event handler

enable_event_handler

enable_event_handler(context, event_handler_id, enabled) Enables/disables the event handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
event_handler_id String Event handler id [required]
enabled bool true to enable the handler, false to disable the handler [required]

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

event_endpoint_types

Veccrate::models::EndpointType event_endpoint_types() Returns a list of all endpoint types for events

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::EndpointType

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_event_handler

crate::models::EventHandler get_event_handler(context, event_handler_id) Returns the event handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
event_handler_id String Event handler id [required]

Return type

crate::models::EventHandler

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_event_handlers

crate::models::ListOfEventHandlers list_event_handlers(context) Returns a list of event handlers

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]

Return type

crate::models::ListOfEventHandlers

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list_event_handlers_of_all_contexts

crate::models::ListOfEventHandlers list_event_handlers_of_all_contexts() Returns a list of event handlers of all contexts

Parameters

This endpoint does not need any parameter.

Return type

crate::models::ListOfEventHandlers

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

register_event_handler

crate::models::EventHandler register_event_handler(context, event_handler_registration) Registers a new event handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
event_handler_registration Option<EventHandlerRegistration>

Return type

crate::models::EventHandler

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

replace_event_handler

crate::models::EventHandler replace_event_handler(context, event_handler_id, event_handler_registration) Created or replaces the event handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
event_handler_id String Event handler id [required]
event_handler_registration Option<EventHandlerRegistration>

Return type

crate::models::EventHandler

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unregister_event_handler

unregister_event_handler(context, event_handler_id) Unregisters the event handler

Parameters

Name Type Description Required Notes
context String Context name [required] [default to default]
event_handler_id String Event handler id [required]

Return type

(empty response body)

Authorization

ApiKeyAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]