Skip to content

Latest commit

 

History

History
121 lines (62 loc) · 3.04 KB

CommandApi.md

File metadata and controls

121 lines (62 loc) · 3.04 KB

\CommandApi

All URIs are relative to http://localhost:7878

Method HTTP request Description
create_command POST /api/v3/command
delete_command DELETE /api/v3/command/{id}
get_command_by_id GET /api/v3/command/{id}
list_command GET /api/v3/command

create_command

models::CommandResource create_command(command_resource)

Parameters

Name Type Description Required Notes
command_resource Option<CommandResource>

Return type

models::CommandResource

Authorization

apikey, X-Api-Key

HTTP request headers

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

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

delete_command

delete_command(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

(empty response body)

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

get_command_by_id

models::CommandResource get_command_by_id(id)

Parameters

Name Type Description Required Notes
id i32 [required]

Return type

models::CommandResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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

list_command

Vecmodels::CommandResource list_command()

Parameters

This endpoint does not need any parameter.

Return type

Vecmodels::CommandResource

Authorization

apikey, X-Api-Key

HTTP request headers

  • Content-Type: Not defined
  • Accept: text/plain, application/json, text/json

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