Cloud APIs
...
BSN.Cloud Main APIs
Main API version 2020/10

Autoruns/Plugins Endpoints (2020/10)

8min
these endpoints allow users to manage autorun plugins on a network base url for these endpoints https //api bsn cloud/2020/10/rest/autoruns/plugins get / returns a list of autorun plugins on a network required scope token bsn api main autoruns plugins retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results sort string string optional an expression for sorting the search results the sort expression specifies the entry used for sorting and the ascending/descending (asc/desc) sorting order (e g " \[device] \[serial] asc ") marker string string optional a value specifying which page to retrieve this value is useful if the istruncated entry in the response body of the previous get call indicates that the number of autorun plugin instances exceeds the pagesize this parameter is only required if you need more elements in the paged list than the pagesize (100) pagesize int int optional the maximum number of autorun plugin instances that can be contained in the response body response success response body 200 200 returns a paged list entity (2020/10) docid\ joielmbbiwrnzeqzvpqqa of autorun plugin entity (2020/10) docid\ ieqwbco8v1g7z xwhyght instances on a network this will return not more than 100 entities along with the information necessary to return any other remaining pages failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error post / create a new autorun plugin on a network required scope token bsn api main autoruns plugins create request body the autorun plugin entity (2020/10) docid\ ieqwbco8v1g7z xwhyght response success response body 201 201 returns the autorun plugin entity (2020/10) docid\ ieqwbco8v1g7z xwhyght created and referenced by the uri (given by the location header field) in the response failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or the request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete / removes autorun plugins, specified by a filter, from a network this allows multiple autorun plugins to be deleted at once required scope token bsn api main autoruns plugins delete query string parameters filter string string required required an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results to find the autorun plugins to delete response body success 200 200 returns the number of affected autorun plugins as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /count/ returns the number of autorun plugins on the network required scope token bsn api main autoruns plugins retrieve query string parameters filter string string optional optional an filtering and sorting expressions in the main api docid 3l0afyd3xooe ytvfk2vs for filtering search results response body success 200 200 the autorun plugin count is returned as an integer value failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error get /{id\ int}/ returns the specified autorun plugin required scope token bsn api main autoruns plugins retrieve segment id int int a unique identifier for an autorun plugin instance response body success 200 200 returns the autorun plugin entity (2020/10) docid\ ieqwbco8v1g7z xwhyght failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 an autorun plugin with the specified id does not exist 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 5xx 5xx any 500 code is an internal server error put /{id\ int}/ update a specified autorun plugin required scope token bsn api main autoruns plugins update segment id int int a unique identifier for an autorun plugin instance request body the autorun plugin entity (2020/10) docid\ ieqwbco8v1g7z xwhyght response body success 204 204 the specified autorun plugin has been updated failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 either the request or request body is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource/autorun plugin changed since the time specified in the “if unmodified since” header value) 415 415 the server cannot accept the data representation that you sent (as specified in the "content type" header) 5xx 5xx any 500 code is an internal server error delete /{id\ int}/ remove the specified autorun plugin required scope token bsn api main autoruns plugins delete segment id int int a unique identifier for the autorun plugin response body success 204 204 the specified autorun plugin has been deleted failure 300 300 the requested representation could not be returned because it is ambiguous (there are multiple requested representations) 400 400 the request is malformed and therefore invalid 401 401 the access token is invalid or not specified 403 403 the supplied access token, though valid, doesn't provide access to this method 404 404 the server cannot find the requested resource 406 406 the server cannot return the data representation that you requested (as specified in the "accept" header) 412 412 precondition failed (the resource changed since the time specified in the “if unmodified since” header value) 5xx 5xx any 500 code is an internal server error