CommandsApi

All URIs are relative to https://console.jumpcloud.com/api

Method	HTTP request	Description
commandFileGet	GET /files/command/{id}	Get a Command File
commandsDelete	DELETE /commands/{id}	Delete a Command
commandsGet	GET /commands/{id}	List an individual Command
commandsList	GET /commands	List All Commands
commandsPost	POST /commands	Create A Command
commandsPut	PUT /commands/{id}	Update a Command

commandFileGet

Commandfilereturn commandFileGet(id, contentType, accept, fields, limit, skip, xOrgId)

Get a Command File

This endpoint returns the uploaded file(s) associated with a specific command. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/files/command/{commandID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// 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.CommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

CommandsApi apiInstance = new CommandsApi();
String id = "id_example"; // String | 
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
String fields = ""; // String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
Integer skip = 0; // Integer | The offset into the records to return.
String xOrgId = ""; // String | 
try {
    Commandfilereturn result = apiInstance.commandFileGet(id, contentType, accept, fields, limit, skip, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CommandsApi#commandFileGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
contentType	String		[default to application/json]
accept	String		[default to application/json]
fields	String	Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.	[optional] [default to ]
limit	Integer	The number of records to return at once. Limited to 100.	[optional] [default to 10]
skip	Integer	The offset into the records to return.	[optional] [default to 0]
xOrgId	String		[optional] [default to ]

Return type

Commandfilereturn

Authorization

x-api-key

HTTP request headers

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

commandsDelete

commandsDelete(id, contentType, accept, xOrgId)

Delete a Command

This endpoint deletes a specific command based on the Command ID. #### Sample Request ``` curl -X DELETE https://console.jumpcloud.com/api/commands/{CommandID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// 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.CommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

CommandsApi apiInstance = new CommandsApi();
String id = "id_example"; // String | 
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
String xOrgId = ""; // String | 
try {
    apiInstance.commandsDelete(id, contentType, accept, xOrgId);
} catch (ApiException e) {
    System.err.println("Exception when calling CommandsApi#commandsDelete");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
id	String
contentType	String	[default to application/json]
accept	String	[default to application/json]
xOrgId	String	[optional] [default to ]

Return type

null (empty response body)

Authorization

x-api-key

HTTP request headers

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

commandsGet

Command commandsGet(id, contentType, accept, fields, filter, xOrgId)

List an individual Command

This endpoint returns a specific command based on the command ID. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/{CommandID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// 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.CommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

CommandsApi apiInstance = new CommandsApi();
String id = "id_example"; // String | 
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
String fields = ""; // String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. 
String filter = "filter_example"; // String | A filter to apply to the query.
String xOrgId = ""; // String | 
try {
    Command result = apiInstance.commandsGet(id, contentType, accept, fields, filter, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CommandsApi#commandsGet");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
id	String
contentType	String		[default to application/json]
accept	String		[default to application/json]
fields	String	Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.	[optional] [default to ]
filter	String	A filter to apply to the query.	[optional]
xOrgId	String		[optional] [default to ]

Return type

Command

Authorization

x-api-key

HTTP request headers

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

commandsList

Commandslist commandsList(contentType, accept, skip, fields, limit, sort, filter, xOrgId)

List All Commands

This endpoint returns all commands. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commands/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ```

Example

// 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.CommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

CommandsApi apiInstance = new CommandsApi();
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Integer skip = 0; // Integer | The offset into the records to return.
String fields = ""; // String | Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned. 
Integer limit = 10; // Integer | The number of records to return at once. Limited to 100.
String sort = ""; // String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. 
String filter = "filter_example"; // String | A filter to apply to the query.
String xOrgId = ""; // String | 
try {
    Commandslist result = apiInstance.commandsList(contentType, accept, skip, fields, limit, sort, filter, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CommandsApi#commandsList");
    e.printStackTrace();
}

Parameters

Name	Type	Description	Notes
contentType	String		[default to application/json]
accept	String		[default to application/json]
skip	Integer	The offset into the records to return.	[optional] [default to 0]
fields	String	Use a space seperated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.	[optional] [default to ]
limit	Integer	The number of records to return at once. Limited to 100.	[optional] [default to 10]
sort	String	Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.	[optional] [default to ]
filter	String	A filter to apply to the query.	[optional]
xOrgId	String		[optional] [default to ]

Return type

Commandslist

Authorization

x-api-key

HTTP request headers

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

commandsPost

Command commandsPost(contentType, accept, body, xOrgId)

Create A Command

This endpoint allows you to create a new command. #### Sample Request ``` curl -X POST https://console.jumpcloud.com/api/commands/ \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name":"Test API Command", "command":"String", "user":"{UserID}", "schedule":"", "timeout":"100" }' ```

Example

// 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.CommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

CommandsApi apiInstance = new CommandsApi();
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Command body = new Command(); // Command | 
String xOrgId = ""; // String | 
try {
    Command result = apiInstance.commandsPost(contentType, accept, body, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CommandsApi#commandsPost");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
contentType	String	[default to application/json]
accept	String	[default to application/json]
body	Command	[optional]
xOrgId	String	[optional] [default to ]

Return type

Command

Authorization

x-api-key

HTTP request headers

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

commandsPut

Command commandsPut(id, contentType, accept, body, xOrgId)

Update a Command

This endpoint Updates a command based on the command ID and returns the modified command record. #### Sample Request ``` curl -X PUT https://console.jumpcloud.com/api/commands/{CommandID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' \ -d '{ "name":"Test API Command", "command":"String", "user":"{UserID}", "schedule":"", "timeout":"100" }' ```

Example

// 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.CommandsApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: x-api-key
ApiKeyAuth x-api-key = (ApiKeyAuth) defaultClient.getAuthentication("x-api-key");
x-api-key.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//x-api-key.setApiKeyPrefix("Token");

CommandsApi apiInstance = new CommandsApi();
String id = "id_example"; // String | 
String contentType = "application/json"; // String | 
String accept = "application/json"; // String | 
Command body = new Command(); // Command | 
String xOrgId = ""; // String | 
try {
    Command result = apiInstance.commandsPut(id, contentType, accept, body, xOrgId);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling CommandsApi#commandsPut");
    e.printStackTrace();
}

Parameters

Name	Type	Notes
id	String
contentType	String	[default to application/json]
accept	String	[default to application/json]
body	Command	[optional]
xOrgId	String	[optional] [default to ]

Return type

Command

Authorization

x-api-key

HTTP request headers

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

Files

CommandsApi.md

Latest commit

History

CommandsApi.md

File metadata and controls

CommandsApi

commandFileGet

Example

Parameters

Return type

Authorization

HTTP request headers

commandsDelete

Example

Parameters

Return type

Authorization

HTTP request headers

commandsGet

Example

Parameters

Return type

Authorization

HTTP request headers

commandsList

Example

Parameters

Return type

Authorization

HTTP request headers

commandsPost

Example

Parameters

Return type

Authorization

HTTP request headers

commandsPut

Example

Parameters

Return type

Authorization

HTTP request headers