Companies

Use these endpoints to perform configuration steps on companies.  Authentication with a site API key is required to use these.

For additional information, review the site Companies page.

Get a Company

Request

Endpoint: /api/get/company/CompID

Parameters: none

Response

A JSON object with these fields:

•CompID

•Name

•IsInactive - true|false

•EmailTo - notify address

•EmailFrom - notify from address

•EmailServer - sending (SMTP) mail server

•EmailLogin - sending account login

•EmailPassword - sending account password

•EmailOAuth - sending Oauth registration settings

•EmailMinTLS - sending minimum TLS level (1.0, 1.1, 1.2, 1.3)

•SGKey - SendGrid API key for the SendGrid mail service - overrides SMTP if present

•Notes

•Locations - an object whose keys are location IDs with each location's object value, locations include output device objects

•Sources - an object whose keys are input source IDs with each source's object value

•ExternalURL

•SSLCertFile

•SSLKeyFile

•SMTPEnable - true|false enable receiving of emails with attachments

•SMTPAllowFrom - if SMTPEnable is true, semicolon delimited list allowed From addresses or domain names

•SMTPSubjectAuth - if SMTPEnable is true, semicolon delimited list of allowed Subject content

•SMTPWildCard - if SMTPEnable is true, semicolon delimited list of wildcards to match valid attachments

•APIKey - company's auto-generated API key for use with company-specific API authentication

•MaxDevices - maximum number of output devices

•PortRange - low-high port range for auto-assigned network input source

•AgeHist - days input source files are retained for analysis

or

Error: message

Put a Company

Request

Endpoint: /api/put/company/CompID

Parameters:

•Name

•IsInactive - true|false

•EmailTo - notify address

•EmailFrom - notify from address

•EmailServer - sending (SMTP) mail server

•EmailLogin - sending account login

•EmailPassword - sending account password

•EmailMinTLS - sending minimum TLS level (1.0, 1.1, 1.2, 1.3)

•SGKey - SendGrid API key for the SendGrid mail service - overrides SMTP if present

•Notes

•ExternalURL

•SSLCertFile

•SSLKeyFile

•SMTPEnable - true|false enable receiving of emails with attachments

•SMTPAllowFrom - if SMTPEnable is true, semicolon delimited list allowed From addresses or domain names

•SMTPSubjectAuth - if SMTPEnable is true, semicolon delimited list of allowed Subject content

•SMTPWildCard - if SMTPEnable is true, semicolon delimited list of wildcards to match valid attachments

•APIKey - company's auto-generated API key for use with company-specific API authentication

•MaxDevices - maximum number of output devices

•PortRange - low-high port range for auto-assigned network input source

•AgeHist - days input source files are retained for analysis

Response

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

Delete a Company

Request

Endpoint: /api/delete/company/CompID

Parameters: none

Response

An empty response or Error: message

List Companies

Request

EndPoint: /api/list/companies

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 company

or

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

or

Error: message