Connectors
HTTP REST API sink
Send records from a SQIP topic to an HTTPS API
Use the HTTP REST API sink when every record from a SQIP topic should be sent to an HTTPS endpoint using POST or PUT.
Before you begin
Ask the API owner for:
- The HTTPS endpoint URL.
- Whether to use
POSTorPUT. - The authentication method and credentials.
- The largest request the API accepts and its recommended concurrency.
Warning
The receiving API may see the same record more than once after a retry. Whenever possible, use an endpoint that safely recognizes repeated requests.
Install the connector
Select the connector
In Connectors, find HTTP REST API Sink and select Select and install.
Choose the input
Enter an installation name, select the tenant, cluster, and namespace, and choose the input topic whose records will be sent to the API.
Configure the endpoint
Enter the endpoint and request settings from the table below.
Add authentication
Select the API's authentication type and enter credentials only in SQIP's credential section.
Install and verify
Select Install connector, wait for Running, and send a test record to the input topic. Confirm that it arrives at the API.
Configuration fields
| Field | What to enter | Example | Required |
|---|---|---|---|
| URL | The complete HTTPS endpoint that receives records | https://events.example.com/v1/orders | Yes |
| HTTP Method | POST to create or submit records; PUT when the endpoint expects replacement or upsert behavior | POST | No; defaults to POST |
| Auth Type | NONE, BEARER, BASIC, or API_KEY | BEARER | No; defaults to NONE |
| Auth Header Name | The header used for API_KEY authentication | X-API-Key | Only for API_KEY |
| Connect Timeout Ms | How long SQIP waits to establish a connection | 5000 | No |
| Request Timeout Ms | Maximum time allowed for one API request | 10000 | No |
| Max Request Bytes | Largest topic record that may be sent, in bytes | 1048576 (1 MiB) | No |
| Max In Flight | Maximum requests SQIP may send at the same time | 32 | No |
| Forward Pulsar Metadata | Select Yes only when the receiving API needs SQIP message details | No | No |
| Parallelism | Number of connector instances | 1 | Yes; allowed range 1–16 |
Authentication choices
| Auth Type | When to use it | Credential input |
|---|---|---|
NONE | The endpoint requires no login | None |
BEARER | The endpoint expects an access token | Token |
BASIC | The endpoint expects a username and password | Username and password |
API_KEY | The endpoint expects a key in a named header | API key and Auth Header Name |
Enter only the credential fields required by the selected authentication type. Alternatively, expand Use an existing secret reference instead and enter the approved secret name. Do not use both approaches.
Public test example
This endpoint accepts test POST requests without credentials and returns a simulated response.
| Field | Input |
|---|---|
| URL | https://jsonplaceholder.typicode.com/posts |
| HTTP Method | POST |
| Auth Type | NONE |
| Auth Header Name | X-API-Key |
| Connect Timeout Ms | 5000 |
| Request Timeout Ms | 10000 |
| Max Request Bytes | 1048576 |
| Max In Flight | 32 |
| Forward Pulsar Metadata | No |
Warning
The public test endpoint does not permanently store records. Use it only to confirm that the connector can send a request.
If installation fails
- Confirm that the URL starts with
https://and does not contain credentials. - Confirm that the API supports the selected
POSTorPUTmethod. - Confirm that the authentication type and credential match the API requirements.
- Lower Max In Flight if the API reports rate-limit or overload errors.
- Increase Max Request Bytes only if valid topic records exceed the current limit.