Get all or filtered syslog servers

post /public_api/v1/integrations/syslog/get

Get a complete or filtered list of syslog servers.

You must have View Alert Notification permissions to run this endpoint.

Request headers

Authorization

String

required

{api_key}

Example: authorization_example

x-xdr-auth-id

String

required

{api_key_id}

Example: xXdrAuthId_example

Body parameters

request_dataObject

A dictionary containing the API request fields. An empty dictionary returns all results.

filtersArray

Array of filter fields. Each JSON object must contain a field, operator, and value.

[

fieldObject (Enum)

String that identifies the syslog server field the filter is matching. Filters are based on the following case-sensitive keywords:

name
id
address
status

Allowed values:"name""id""address""status"

operatorObject (Enum)

String that identifies the comparison operator you want to use for this filter. Valid operator keywords and corresponding filter fields are: - eq - used with name, id, address, and status

Allowed values:"eq"

valueString

Value that the filter must match. The contents of this field will differ depending on the website field that you specified for this filter:

name - string

]

REQUEST BODY

{
  "request_data": {
    "filters": [
      {
        "field": "id",
        "operator": "eq",
        "value": 632
      }
    ]
  }
}

CURL

  curl -X 'POST'

        -H
        'Accept: application/json'
      
        -H
        'Content-Type: application/json'
      
          -H
          'Authorization: authorization_example'
          -H
          'x-xdr-auth-id: xXdrAuthId_example'
      
      'https://api-yourfqdn/public_api/v1/integrations/syslog/get'
    
      -d
      ''

Responses

Body

objects_countInteger

The number of syslog servers that are returned.

objectsArray

The syslog server details.

[

SYSLOG_INTEGRATION_IDInteger

SYSLOG_INTEGRATION_NAMEString

Syslog server integration name.

SYSLOG_INTEGRATION_ADDRESSString

IP address or fully qualified domain name (FQDN) of the syslog server.

SYSLOG_INTEGRATION_PORTInteger

The port number on which the syslog server listens for messages.

SYSLOG_INTEGRATION_PROTOCOLString

The communication protocol: - TCP: No validation is made on the connection with the syslog server. However, if an error occurred with the domain used to make the connection, the Test connection will fail. - UDP: No error checking, error correction, or acknowledgment. No validation is done for the connection or when sending data. - TLS: Cortex validates the syslog server certificate and uses the certificate signature and public key to encrypt the data sent over the connection.

FACILITYString

SYSLOG_INTEGRATION_STATUSString

SYSLOG_INTEGRATION_ERRORObject

SYSLOG_INTEGRATION_CERTIFICATE_NAMEObject

SYSLOG_INTEGRATION_IGNORE_CERTIFICATE_ERRORString

]

RESPONSE

{
  "objects_count": 0,
  "objects": [
    {
      "SYSLOG_INTEGRATION_ID": 0,
      "SYSLOG_INTEGRATION_NAME": "SYSLOG_INTEGRATION_NAME_example",
      "SYSLOG_INTEGRATION_ADDRESS": "SYSLOG_INTEGRATION_ADDRESS_example",
      "SYSLOG_INTEGRATION_PORT": 0,
      "SYSLOG_INTEGRATION_PROTOCOL": "SYSLOG_INTEGRATION_PROTOCOL_example",
      "FACILITY": "FACILITY_example",
      "SYSLOG_INTEGRATION_STATUS": "SYSLOG_INTEGRATION_STATUS_example",
      "SYSLOG_INTEGRATION_ERROR": {},
      "SYSLOG_INTEGRATION_CERTIFICATE_NAME": {},
      "SYSLOG_INTEGRATION_IGNORE_CERTIFICATE_ERROR": "SYSLOG_INTEGRATION_IGNORE_CERTIFICATE_ERROR_example"
    }
  ]
}

Bad Request

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Unauthorized

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Payment Required

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Forbidden

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}

Internal Server Error

Body

err_codeString

HTTP response code.

err_msgString

Error message.

Example:"{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}"

err_extraString

Additional information describing the error.

RESPONSE

{
  "err_code": "err_code_example",
  "err_msg": "{\"line\": 1, \"column\": 19, \"message\": \"no viable alternative at input '|alter2'\"}",
  "err_extra": "err_extra_example"
}