Skip to content

Latest commit

 

History

History
135 lines (75 loc) · 3.87 KB

CallbacksApi.md

File metadata and controls

135 lines (75 loc) · 3.87 KB
Raw

\CallbacksApi

All URIs are relative to http://localhost

Method HTTP request Description
get_callback_by_key_callbacks_key_delete DELETE /callbacks/{key} Get Callback By Key
get_callback_by_key_callbacks_key_get GET /callbacks/{key} Get Callback By Key
list_callbacks_callbacks_get GET /callbacks List Callbacks
register_callback_callbacks_post POST /callbacks Register Callback

get_callback_by_key_callbacks_key_delete

get_callback_by_key_callbacks_key_delete(key, authorization) Get Callback By Key

unregisters a callback identified by its key (if such callback is indeed registered).

Parameters

Name Type Description Required Notes
key String [required]
authorization Option<String>

Return type

(empty response body)

Authorization

No authorization required

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_callback_by_key_callbacks_key_get

models::CallbackEntry get_callback_by_key_callbacks_key_get(key, authorization) Get Callback By Key

get a callback by its key (if such callback is indeed registered).

Parameters

Name Type Description Required Notes
key String [required]
authorization Option<String>

Return type

models::CallbackEntry

Authorization

No authorization required

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_callbacks_callbacks_get

Vecmodels::CallbackEntry list_callbacks_callbacks_get(authorization) List Callbacks

list all the callbacks currently registered by OPAL client.

Parameters

Name Type Description Required Notes
authorization Option<String>

Return type

Vecmodels::CallbackEntry

Authorization

No authorization required

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_callback_callbacks_post

models::CallbackEntry register_callback_callbacks_post(callback_entry, authorization) Register Callback

register a new callback by OPAL client, to be called on OPA state updates.

Parameters

Name Type Description Required Notes
callback_entry CallbackEntry [required]
authorization Option<String>

Return type

models::CallbackEntry

Authorization

No authorization required

HTTP request headers

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

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