Input Sources

Use these endpoints to perform configuration steps on a company's input sources.

For additional information, review the Input Sources page.

Get an Input Source

Request

Endpoint: /api/get/source/CompID/SrcID

Parameters: none

Response

A JSON object with these fields:

•SrcID

•Name

•IsInactive - true|false

•LocID - for ports, paths hosted by a system client at a location

•Type - 0=path, 1=port, 2=IMAP email

•Source - path, port number, or IMAP email address

•Targets - array of targets, each target format "LocID:DevID"

•AllowFrom - array of ip addresses/CIDR for port type, email address or domain for email type

•Notes

•Wildcard  - array of wildcards for file types allowed by source

•IMAPServer

•IMAPPassword

•IMAPSubjectAuth - email subjects must contain this text

•IMAPMinTLS - 1.0|1.1|1.2|1.3

or

Error: message

Put an Input Source

Request

Endpoint: /api/put/source/CompID/SrcID

Parameters:

•Name

•IsInactive - 0=false, 1=true

•LocID - empty string for server-based, or a location ID for a path or port hosted by a system client

•Type - 0=path, 1=port, 2=IMAP email

•Source - path, port number, or IMAP email address

•Targets - semicolon-delimited list of output devices, each LocID:DevID, typically a single value

•AllowFrom - array of ip addresses/CIDR for port type, email address or domain for email type

•Notes

•Wildcard  - array of wildcards for file types allowed by source

•IMAPServer

•IMAPPassword

•IMAPSubjectAuth - email subjects must contain this text

•IMAPMinTLS - 1.0|1.1|1.2|1.3

Notes:

Targets for email sources are usually not specified, as email data can be used to determine targets

Response

A JSON object representing the new record, or Error: message.

Delete an Input Source

Request

Endpoint: /api/delete/source/CompID/SrcID

Parameters: none

Response

An empty response or Error: message

List Input Sources

Request

EndPoint: /api/list/sources/CompID

Parameters:

•csv|tsv - override response format to one of these, set to any value or simply present

Response

A JSON object containing objects for each input source in the company

or

A comma-separated-values or tab-separated-values list if csv or tsv parameters are supplied.

or

Error: message