Skip to content

Latest commit

 

History

History
203 lines (151 loc) · 8.65 KB

CommandResultsApi.md

File metadata and controls

203 lines (151 loc) · 8.65 KB

jcapiv1.CommandResultsApi

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

Method HTTP request Description
command_results_delete DELETE /commandresults/{id} Delete a Command result
command_results_get GET /commandresults/{id} List an individual Command result
command_results_list GET /commandresults List all Command Results

command_results_delete

Commandresult command_results_delete(id, content_type, accept, x_org_id=x_org_id)

Delete a Command result

This endpoint deletes a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \ -H 'Accept: application/json' \ -H 'Content-Type: application/json' \ -H 'x-api-key: {API_KEY}' ````

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.CommandResultsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
x_org_id = '' # str |  (optional) (default to )

try:
    # Delete a Command result
    api_response = api_instance.command_results_delete(id, content_type, accept, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandResultsApi->command_results_delete: %s\n" % e)

Parameters

Name Type Description Notes
id str
content_type str [default to application/json]
accept str [default to application/json]
x_org_id str [optional] [default to ]

Return type

Commandresult

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]

command_results_get

Commandresult command_results_get(id, content_type, accept, fields=fields, filter=filter, x_org_id=x_org_id)

List an individual Command result

This endpoint returns a specific command result. #### Sample Request curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandResultID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}'

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.CommandResultsApi(jcapiv1.ApiClient(configuration))
id = 'id_example' # str | 
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | 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 = 'filter_example' # str | A filter to apply to the query. (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # List an individual Command result
    api_response = api_instance.command_results_get(id, content_type, accept, fields=fields, filter=filter, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandResultsApi->command_results_get: %s\n" % e)

Parameters

Name Type Description Notes
id str
content_type str [default to application/json]
accept str [default to application/json]
fields str 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 str A filter to apply to the query. [optional]
x_org_id str [optional] [default to ]

Return type

Commandresult

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]

command_results_list

Commandresultslist command_results_list(content_type, accept, fields=fields, limit=limit, skip=skip, sort=sort, filter=filter, x_org_id=x_org_id)

List all Command Results

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

Example

from __future__ import print_function
import time
import jcapiv1
from jcapiv1.rest import ApiException
from pprint import pprint

# Configure API key authorization: x-api-key
configuration = jcapiv1.Configuration()
configuration.api_key['x-api-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['x-api-key'] = 'Bearer'

# create an instance of the API class
api_instance = jcapiv1.CommandResultsApi(jcapiv1.ApiClient(configuration))
content_type = 'application/json' # str |  (default to application/json)
accept = 'application/json' # str |  (default to application/json)
fields = '' # str | 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 = 10 # int | The number of records to return at once. Limited to 100. (optional) (default to 10)
skip = 0 # int | The offset into the records to return. (optional) (default to 0)
sort = '' # str | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.  (optional) (default to )
filter = 'filter_example' # str | A filter to apply to the query. (optional)
x_org_id = '' # str |  (optional) (default to )

try:
    # List all Command Results
    api_response = api_instance.command_results_list(content_type, accept, fields=fields, limit=limit, skip=skip, sort=sort, filter=filter, x_org_id=x_org_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling CommandResultsApi->command_results_list: %s\n" % e)

Parameters

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

Return type

Commandresultslist

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]