Cloud Agent API (v1)

Download OpenAPI specification:Download

Extracts

Schedules a security extract to run. Returns the task ID which references that extract.

Request Body schema:
systemId
required
integer <int32>
referenceId
string [ 0 .. 500 ] characters
callbackUrl
string [ 0 .. 200 ] characters
createdBy
required
string [ 0 .. 255 ] characters
jobRequestId
integer <int32>
customerId
string <uuid>
name
string
rulebookId
integer <int32>
useLiveExtract
boolean
taskId
integer <int32>
serializedConnectionInfo
string
resultFilePath
string

Responses

Request samples

Content type
{
  • "systemId": 0,
  • "referenceId": "string",
  • "callbackUrl": "string",
  • "createdBy": "string",
  • "jobRequestId": 0,
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "name": "string",
  • "rulebookId": 0,
  • "useLiveExtract": true,
  • "taskId": 0,
  • "serializedConnectionInfo": "string",
  • "resultFilePath": "string"
}

Response samples

Content type
0

Schedules a security extract for a repeated run. Returns the task ID which references that extract.

Request Body schema:
referenceId
string [ 0 .. 500 ] characters

Responses

Request samples

Content type
{
  • "referenceId": "string"
}

Response samples

Content type