Skip to main content

AutoretrieveApi

All URIs are relative to **

MethodHTTP requestDescription
adminAutoretrieveInitPostPOST /admin/autoretrieve/initRegister autoretrieve server
adminAutoretrieveListGetGET /admin/autoretrieve/listList autoretrieve servers
autoretrieveHeartbeatPostPOST /autoretrieve/heartbeatMarks autoretrieve server as up

adminAutoretrieveInitPost

Register autoretrieve server

This endpoint registers a new autoretrieve server

Example

 adminAutoretrieveInitPost

Parameters

NameTypeDescriptionNotes
addressesstringAutoretrieve's comma-separated list of addresses
pubKeystringAutoretrieve's public key

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

adminAutoretrieveListGet

List autoretrieve servers

This endpoint lists all registered autoretrieve servers

Example

 adminAutoretrieveListGet

Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

autoretrieveHeartbeatPost

Marks autoretrieve server as up

This endpoint updates the lastConnection field for autoretrieve

Example

 autoretrieveHeartbeatPost token:value

Parameters

NameTypeDescriptionNotes
tokenstringAutoretrieve's auth token

Return type

(empty response body)

Authorization

bearerAuth

HTTP request headers

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

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