Scripts API

Note

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

Deploy scripts

POST /scripts/upload

• Request:

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

• Response:void

Query scripting logs

POST /scripts/queryLogs

• Request:

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

• Response:QueryResponse

QueryRequest

{
  // Optional
  "limit" : integer
  "maxTimestamp" : integer
  "minTimestamp" : integer
  "oldestComeFirst" : boolean
  "position" : string
  "requestId" : string
  "searchPhrase" : string
}

QueryResponse

{
  // Required
  "logEvents" : [LogEvent]
  "nextPosition" : string
}

LogEvent

{
  // Required
  "message" : string
  "requestId" : string
  "timestamp" : integer
}