All URIs are relative to https://localhost/api/v5
Method | HTTP request | Description |
---|---|---|
getCommand | GET /cmd/{cmd} | Get a command |
listCommands | GET /cmd | List commands |
runCommands | POST /cmd | Execute a command |
Command getCommand(cmd, details, accept, pretty)
Get a command
Get detailed information about a command. Required permissions: - cmd.one
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.CommandApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
CommandApi apiInstance = new CommandApi();
String cmd = "cmd_example"; // String | The id of the command
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
Command result = apiInstance.getCommand(cmd, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CommandApi#getCommand");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
cmd | String | The id of the command | |
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
List<Command> listCommands(details, accept, pretty)
List commands
Gets a list of all the commands available on the server. Required permissions: - cmd.list
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.CommandApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
CommandApi apiInstance = new CommandApi();
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
List<Command> result = apiInstance.listCommands(details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CommandApi#listCommands");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml
List<ExecuteCommandResponse> runCommands(body, details, accept, pretty)
Execute a command
Execute a command on the server. (Almost the same as running it from the console). Pass an array of commands to execute them in succession, you can also just pass a list with only one command if that's all you want to execute. Returns a list with each response corresponding to a command. Required permissions: - cmd.run - cmd.run.[command]
// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.CommandApi;
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyHeader
ApiKeyAuth ApiKeyHeader = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyHeader");
ApiKeyHeader.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyHeader.setApiKeyPrefix("Token");
// Configure API key authorization: ApiKeyQuery
ApiKeyAuth ApiKeyQuery = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyQuery");
ApiKeyQuery.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyQuery.setApiKeyPrefix("Token");
CommandApi apiInstance = new CommandApi();
List<ExecuteCommandRequest> body = Arrays.asList(new ExecuteCommandRequest()); // List<ExecuteCommandRequest> |
Boolean details = true; // Boolean | Add to include additional details, omit or false otherwise
String accept = "accept_example"; // String | Override the 'Accept' request header (useful for debugging your requests)
Boolean pretty = true; // Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests)
try {
List<ExecuteCommandResponse> result = apiInstance.runCommands(body, details, accept, pretty);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling CommandApi#runCommands");
e.printStackTrace();
}
Name | Type | Description | Notes |
---|---|---|---|
body | List<ExecuteCommandRequest> | [optional] | |
details | Boolean | Add to include additional details, omit or false otherwise | [optional] |
accept | String | Override the 'Accept' request header (useful for debugging your requests) | [optional] [enum: json, xml] |
pretty | Boolean | Add to make the Web-API pretty print the response (useful for debugging your requests) | [optional] |
- Content-Type: application/json, application/xml
- Accept: application/json, application/xml