Kafka Messenger APIs
Overview
This API has been available since 1.26.0
The following APIs are provided to manage Kafka Messengers.
Operations
Create the Kafka Messenger
Request
Create a Kafka Messenger with a randomly generated Id.
POST /api/messenger
Create a Kafka Messenger with the provided unique Id.
POST /api/messenger/{messengerId}
The type in the request JSON is used to determine that you are creating the Kafka Messenger.
Request Parameters
- messengerId [UUID] Optional defaults to secure random UUID
-
The Id to use for the new Messenger. If not specified a secure random UUID will be generated.
Request Body
- messenger.data [Object] Optional
-
An object that can hold any information about the Messenger that should be persisted.
- messenger.debug [Boolean] Optional defaults to
false
-
If debug is enabled, an event log is created to assist in debugging messenger errors.
- messenger.defaultTopic [String] Required
-
The name of the Kafka topic to send messages.
- messenger.name [String] Required
-
The unique Messenger name.
- messenger.producer [Map<String, String>] Optional
-
String key value pairs to be used when building the Kafka Producer.
{
"messenger" : {
"data" : {
"foo" : "bar"
},
"debug": false,
"defaultTopic": "test-topic",
"name" : "Kafka Messenger",
"producer": {
"bootstrap.servers": "localhost:9092",
"max.block.ms": "5000",
"request.timeout.ms": "2000"
},
"type" : "Kafka"
}
}
Response
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
- messenger.data [Object]
-
An object that can hold any information about the Messenger that should be persisted.
- messenger.debug [Boolean]
-
If debug is enabled, an event log is created to assist in debugging messenger errors.
- messenger.defaultTopic [String]
-
The name of the Kafka topic to send messages.
- messenger.id [UUID]
-
The unique Id of the Messenger.
- messenger.insertInstant [Long]
-
The instant that the Messenger was added to the FusionAuth database.
- messenger.lastUpdateInstant [Long]
-
The instant that the Messenger was last updated in the FusionAuth database.
- messenger.name [String]
-
The unique Messenger name.
- messenger.producer [Map<String, String>]
-
String key value pairs to be used when building the Kafka Producer.
- messenger.transport [String]
-
The message transport protocol used to send a message. This value is currently read-only and set to
sms
. - messenger.type [String]
-
This field will always be
Kafka
.
{
"messenger": {
"data" : {
"foo" : "bar"
},
"debug": false,
"defaultTopic": "test-topic",
"id": "8b277ae3-7b76-4e1e-bb07-7320046355bc",
"insertInstant": 1562189072183,
"lastUpdateInstant": 1562189072183,
"name": "Kafka Messenger",
"producer": {
"bootstrap.servers": "localhost:9092",
"max.block.ms": "5000",
"request.timeout.ms": "2000"
},
"transport" : "sms",
"type": "Kafka"
}
}
Retrieve the Kafka Messenger
Request
Retrieve the Kafka Messenger by Id
GET /api/messenger/{messengerId}
Request Parameters
- messengerId [UUID] Required
-
The Id of the Messenger to retrieve.
Response
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you requested doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
- messenger.data [Object]
-
An object that can hold any information about the Messenger that should be persisted.
- messenger.debug [Boolean]
-
If debug is enabled, an event log is created to assist in debugging messenger errors.
- messenger.defaultTopic [String]
-
The name of the Kafka topic to send messages.
- messenger.id [UUID]
-
The unique Id of the Messenger.
- messenger.insertInstant [Long]
-
The instant that the Messenger was added to the FusionAuth database.
- messenger.lastUpdateInstant [Long]
-
The instant that the Messenger was last updated in the FusionAuth database.
- messenger.name [String]
-
The unique Messenger name.
- messenger.producer [Map<String, String>]
-
String key value pairs to be used when building the Kafka Producer.
- messenger.transport [String]
-
The message transport protocol used to send a message. This value is currently read-only and set to
sms
. - messenger.type [String]
-
This field will always be
Kafka
.
{
"messenger": {
"data" : {
"foo" : "bar"
},
"debug": false,
"defaultTopic": "test-topic",
"id": "8b277ae3-7b76-4e1e-bb07-7320046355bc",
"insertInstant": 1562189072183,
"lastUpdateInstant": 1562189072183,
"name": "Kafka Messenger",
"producer": {
"bootstrap.servers": "localhost:9092",
"max.block.ms": "5000",
"request.timeout.ms": "2000"
},
"transport" : "sms",
"type": "Kafka"
}
}
Update the Kafka Messenger
This API is used to update an existing Kafka Messenger.
You must specify the Id of the Kafka Messenger you are updating on the URI.
You must specify all of the properties of the Kafka Messenger when calling this API with the PUT
HTTP method. When used with PUT
, this API doesn’t merge the existing Kafka Messenger and your new data. It replaces the existing Kafka Messenger with your new data.
Utilize the PATCH
HTTP method to send specific changes to merge into an existing Kafka Messenger.
Request
Update the Kafka Messenger by Id
PUT /api/messenger/{messengerId}
PATCH /api/messenger/{messengerId}
Available since 1.12.0
When using the PATCH method, use the same request body documentation that is provided for the PUT request. The PATCH method will merge the provided request parameters into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A
null
value can be used to remove a value. Patching anArray
will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.
Request Parameters
- messengerId [UUID] Required
-
The Id of the Messenger to update.
Request Body
- messenger.data [Object] Optional
-
An object that can hold any information about the Messenger that should be persisted.
- messenger.debug [Boolean] Optional defaults to
false
-
If debug is enabled, an event log is created to assist in debugging messenger errors.
- messenger.defaultTopic [String] Required
-
The name of the Kafka topic to send messages.
- messenger.name [String] Required
-
The unique Messenger name.
- messenger.producer [Map<String, String>] Optional
-
String key value pairs to be used when building the Kafka Producer.
{
"messenger" : {
"data" : {
"foo" : "bar"
},
"debug": false,
"defaultTopic": "test-topic",
"name" : "Kafka Messenger",
"producer": {
"bootstrap.servers": "localhost:9092",
"max.block.ms": "5000",
"request.timeout.ms": "2000"
},
"type" : "Kafka"
}
}
Response
The response for this API contains the Kafka Messenger.
Code | Description |
---|---|
200 |
The request was successful. The response will contain a JSON body. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you are trying to update doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
Response Body
- messenger.data [Object]
-
An object that can hold any information about the Messenger that should be persisted.
- messenger.debug [Boolean]
-
If debug is enabled, an event log is created to assist in debugging messenger errors.
- messenger.defaultTopic [String]
-
The name of the Kafka topic to send messages.
- messenger.id [UUID]
-
The unique Id of the Messenger.
- messenger.insertInstant [Long]
-
The instant that the Messenger was added to the FusionAuth database.
- messenger.lastUpdateInstant [Long]
-
The instant that the Messenger was last updated in the FusionAuth database.
- messenger.name [String]
-
The unique Messenger name.
- messenger.producer [Map<String, String>]
-
String key value pairs to be used when building the Kafka Producer.
- messenger.transport [String]
-
The message transport protocol used to send a message. This value is currently read-only and set to
sms
. - messenger.type [String]
-
This field will always be
Kafka
.
{
"messenger": {
"data" : {
"foo" : "bar"
},
"debug": false,
"defaultTopic": "test-topic",
"id": "8b277ae3-7b76-4e1e-bb07-7320046355bc",
"insertInstant": 1562189072183,
"lastUpdateInstant": 1562189072183,
"name": "Kafka Messenger",
"producer": {
"bootstrap.servers": "localhost:9092",
"max.block.ms": "5000",
"request.timeout.ms": "2000"
},
"transport" : "sms",
"type": "Kafka"
}
}
Delete the Kafka Messenger
Request
Delete the Kafka Messenger by Id
DELETE /api/messenger/{messengerId}
- messengerId [UUID] Required
-
The Id of the Messenger to delete.
Response
This API does not return a JSON response body.
Code | Description |
---|---|
200 |
The request was successful. The response will be empty. |
400 |
The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
401 |
You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
404 |
The object you are trying to delete doesn’t exist. The response will be empty. |
500 |
There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |