HomeGuidesAPI Reference
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
API Reference

Update some fields of an OnGuard Custom Script

Update some fields of an OnGuard Custom Script

Path Params
string
required

Numeric ID of OnGuard Custom Script

Body Params
string

Name of Custom Script

string

Description of Custom Script

attributes
object

Attributes of Custom Script, allowed attributes - Path,Command,SHA256,ExecutionLevel,WaitTime,PassResults,SuccessMsg,FailureMsg,ProgressMsg,Description,DownloadURL,ValidateURLCert,ScriptExecutionTimeOut,SignerName (e.g. {"Path": "/home/aruba/scripts","SHA256": "cfd6...f7ca","ExecutionLevel": "User","Command": "runscript.sh","SignerName": "signer"})

string
enum

Output Format of Custom Script, applicable only for health collection scripts

Allowed:
output_details
object

Output Details of Custom Script, applicable only for health collection scripts (e.g. {"ExitCode":"Integer", "OutVar1":"Boolean", "OutVar2":"String"})

string
enum

Rule Evaluation Algorithm for rules of Custom Script, applicable only for health collection scripts

Allowed:
rules
object

List of Rules for Custom Script, applicable only for health collection scripts (e.g. [{"match_type":"OR","health_status":"Healthy","condition":[{"type":"Script","name":"ExitCode","oper":"EQUALS","value":"0"}]}])

Responses

Language
Response
Choose an example:
application/json