Scripts API

Note

The Scripts API is used to implement Socotra plugins. See the Plugins topic for information about how to use this API.

Endpoint Index

Action	Endpoint
Deploy scripts	POST /scripts/upload
Query scripting logs	POST /scripts/queryLogs

Details

Deploy scripts

POST /scripts/upload

Request:

Name	Position	Type	Required
file	formdata	file	required
tenantLocator	query	string	optional

Response: void

This endpoint takes a zip file with a heirarchical file structure containing folders and javascript files. This is the same structure that can be included in the /scripts folder in a full configuration file.

This operation replaces the entire script set, so be sure to include all files in the payload even if they are unchanged.

Query scripting logs

POST /scripts/queryLogs

Request:

Name	Position	Type	Required
query	body	QueryRequest	required
tenantLocator	query	string	optional

Response: QueryResponse

QueryRequest

optional
maxTimestamp timestamp
minTimestamp timestamp
limit integer
oldestComeFirst boolean
position string
requestId string
searchPhrase string

QueryResponse

required
logEvents [QueryResponseLineItem]
nextPosition string

QueryResponseLineItem

required
timestamp timestamp
message string
requestId string