Skip to content

Latest commit

 

History

History
268 lines (186 loc) · 11.4 KB

CommandsApi.md

File metadata and controls

268 lines (186 loc) · 11.4 KB

\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(ctx, id, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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. [default to ]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
skip int32 The offset into the records to return. [default to 0]
xOrgId string [default to ]

Return type

Commandfilereturn

Authorization

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]

CommandsDelete

CommandsDelete(ctx, id, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
id string
contentType string [default to application/json]
accept string [default to application/json]
xOrgId string [default to ]

Return type

(empty response body)

Authorization

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]

CommandsGet

Command CommandsGet(ctx, id, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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. [default to ]
filter string A filter to apply to the query.
xOrgId string [default to ]

Return type

Command

Authorization

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]

CommandsList

Commandslist CommandsList(ctx, contentType, accept, optional) 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}'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
skip int32 The offset into the records to return. [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. [default to ]
limit int32 The number of records to return at once. Limited to 100. [default to 10]
sort string Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. [default to ]
filter string A filter to apply to the query.
xOrgId string [default to ]

Return type

Commandslist

Authorization

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]

CommandsPost

Command CommandsPost(ctx, contentType, accept, optional) 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\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
contentType string [default to application/json]
accept string [default to application/json]
body Command
xOrgId string [default to ]

Return type

Command

Authorization

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]

CommandsPut

Command CommandsPut(ctx, id, contentType, accept, optional) 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\" }'

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
id string
contentType string [default to application/json]
accept string [default to application/json]
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

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

Return type

Command

Authorization

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]