HTTP Endpoints

An HTTP endpoint holds the web server settings that the Syslog Watcher Server uses to send HTTP requests: address, request type, headers, and authentication. You set them up once and select the endpoint by name in the Send HTTP Requests feature, which adds the resource path and body for each message.

HTTP Endpoints page: the Ticketing API endpoint expanded with its settings and the Send Test Request and Delete links; two more endpoints collapsed
The HTTP Endpoints page of Server Configuration

Add an Endpoint

  1. In the Server section of the main toolbar, click Server Server → Server Configuration Server Configuration…​

  2. Select the HTTP Endpoints page.

  3. Click Add HTTP Endpoint.

  4. Fill in the endpoint settings.

  5. Click Apply.

HTTP Endpoint

The Ticketing API endpoint with its settings and the Send Test Request and Delete links
An HTTP endpoint
Name

Name shown in the feature. Required.
User agent

User-Agent header sent with each request.
Target server

Address with protocol and optional port, for example https://api.example.com or http://10.0.0.5:8080. Required. Use https:// for TLS.
Request type

POST or PUT.
Request headers

Optional headers, one per line, for example an API key: Authorization: Bearer %API_TOKEN%. Use secret strings (%EXAMPLE%) for private values.
Content-type

Content-Type of the body: choose text/plain, application/json, multipart/form-data, or application/x-www-form-urlencoded, or type another type. Required.
Authentication

None or Basic. With Basic, Username and Password are required; use a secret string for the password.

Send a Test Request

  1. Click Send Test Request on the endpoint.

  2. Enter a Resource path (for example /api/send-message) and a Request body.

  3. Click Send Request.

The window shows the Status code and the body of the web server’s response, or the error.

The request is sent from the Syslog Watcher Server computer.

Use a body in the same format as the feature template, for example a small JSON object.

Delete an Endpoint

Click Delete on the endpoint, confirm, and click Apply.

Features that use the endpoint stop sending until another endpoint is selected.

Related Topics