Event Portal - API Management

Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
Registrations
Gateways
Reference - Managed configuration on PS+ Brokers

Event Portal - API Management

Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
Registrations
Gateways
Reference - Managed configuration on PS+ Brokers

(Early Access) Returns the specified Gateway Broker Service

get https://apim-production-api.solace.cloud/api/v2/apim/gateways/{messagingServiceId}

Returns the specified Gateway Messaging Service

URL Expired

The URL for this request expired after 30 days.

Path Params

messagingServiceId

string

required

length between 4 and 188

the id of a Gateway Messaging Service

Responses

Response body

object

data

object

required

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

solaceCloudMessagingServiceId

string

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

brokerType

string

required

Defaults to solace

The type of the broker used for the event API product

kafka solace

name

string

required

length between 0 and 128

messagingServiceConnections

array of objects

required

length between 0 and 128

messagingServiceConnections*

object

name

string

required

length between 0 and 128

url

string

required

length between 2 and 1024

The url of the connection object.

protocol

string

required

smfc smf smfs amqp amqps http https jms mqttws mqtt secure-mqtt secure-mqttws smfws smfwss

protocolVersion

string

required

length between 0 and 16

The protocolVersion of the connection object.

bindings

object

Has additional fields

messagingServiceAuthentications

array of objects

length between 0 and 128

messagingServiceAuthentications

object

name

string

required

length between 0 and 128

authenticationType

string

required

length between 2 and 32

The type of the authentication object.

authenticationDetails

object

required

A JSON map containing a map of extra details for the authentication.

messagingServiceCredentials

array of objects

required

length between 1 and 128

messagingServiceCredentials*

object

name

string

required

length between 2 and 128

The name of the credentials object.

credentials

object

required

A JSON map containing the credentials information.

environmentName

string

required

length between 0 and 128

eventMeshName

string

required

length between 0 and 128

meta

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

message

string

required

length between 4 and 256

errorId

string

required

length between 2 and 64

meta

object

validationDetails

object

Response body

object

data

object

required

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

solaceCloudMessagingServiceId

string

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

brokerType

string

required

Defaults to solace

The type of the broker used for the event API product

kafka solace

name

string

required

length between 0 and 128

messagingServiceConnections

array of objects

required

length between 0 and 128

messagingServiceConnections*

object

name

string

required

length between 0 and 128

url

string

required

length between 2 and 1024

The url of the connection object.

protocol

string

required

smfc smf smfs amqp amqps http https jms mqttws mqtt secure-mqtt secure-mqttws smfws smfwss

protocolVersion

string

required

length between 0 and 16

The protocolVersion of the connection object.

bindings

object

Has additional fields

messagingServiceAuthentications

array of objects

length between 0 and 128

messagingServiceAuthentications

object

name

string

required

length between 0 and 128

authenticationType

string

required

length between 2 and 32

The type of the authentication object.

authenticationDetails

object

required

A JSON map containing a map of extra details for the authentication.

messagingServiceCredentials

array of objects

required

length between 1 and 128

messagingServiceCredentials*

object

name

string

required

length between 2 and 128

The name of the credentials object.

credentials

object

required

A JSON map containing the credentials information.

environmentName

string

required

length between 0 and 128

eventMeshName

string

required

length between 0 and 128

meta

object

Updated about 1 year ago

(Early Access) Set the authentication mode for the Event Broker Gateways

(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Broker

Did this page help you?

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://apim-production-api.solace.cloud/api/v2/apim/gateways/messagingServiceId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated about 1 year ago

(Early Access) Set the authentication mode for the Event Broker Gateways

(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Broker

Did this page help you?

Event Portal - API Management
Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
(Early Access) Returns the Async APi specification associated with the Event API Product and Planget
(Early Access) Returns a list of the APIs associated with the Event API Product and Planget
(Early Access) Returns the requested plan of the Event API Productget
(Early Access) Returns a list of plans of the Event API Productget
(Early Access) Deletes the specified attribute from the Event API Productdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the Event API Productget
(Early Access) Adds an attribute to the Event API Productpost
(Early Access) Returns attributes of the Event API Productget
(Early Access) Returns the version of an Event API Productget
(Early Access) Returns a list of versions of an Event API Product.get
(Early Access) Returns the requested Event API Productget
(Early Access) Returns a list of published Event API Productsget
Registrations
(Early Access) Returns the config state of an application registrationget
(Early Access) Deletes the specified webhook registration from the App Registration (Coming Soon)delete
(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)patch
(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)get
(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)post
(Early Access) Returns a list of webhook registrations (Coming Soon)get
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Returns the Async API specification associated with the Access Request.get
(Early Access) Returns a list of all Event APIs associated with the Access Requestget
(Early Access) Deletes the specified Access Request form the App Registrationdelete
(Early Access) Updates the Access Request associated with the Application Registrationpatch
(Early Access) Returns the requested Access Request associated with the specified App Registrationget
(Early Access) Creates a new Access Request.post
(Early Access) Returns a list of Access Requests associated with the App Registrationget
(Early Access) Deletes the credentials with the specified Consumer Key from the App Registrationdelete
(Early Access) Updates the credentials with the specified Consumer Keypatch
(Early Access) Returns the Credentials with the specified Consumer Keyget
(Early Access) Requests new credentials for the App Registrationpost
(Early Access) Returns a list of all Credentials issued for the App Registrationget
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Deletes the specified attribute from the App Registrationdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the App Registrationget
(Early Access) Adds an attribute to the App Registrationpost
(Early Access) Returns attributes of the App Registrationget
(Early Access) Returns the Async API specification associated with the App Registration.get
(Early Access) Returns a list of all Event APIs associated with the App Registrationget
(Early Access) Deletes the specified App Registrationdelete
(Early Access) Updates the specified App Registrationpatch
(Early Access) Returns the requested App Registrationget
(Early Access) Creates a new App Registrationpost
(Early Access) Returns a list of Application Registrationsget
Gateways
(Early Access) Returns the status of the Gateway Broker Serviceget
(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Brokerpatch
(Early Access) Returns the specified Gateway Broker Serviceget
(Early Access) Set the authentication mode for the Event Broker Gatewayspost
(Early Access) Returns a list of all available Gateway Event Brokersget
Reference - Managed configuration on PS+ Brokers

Event Portal - API Management
Getting Started with Event Portal's APIM/DevPortal API
API Walkthrough
Filtering with `where` RSQL queries
Paging
Application Registration Credentials Management
Event API Products
(Early Access) Returns the Async APi specification associated with the Event API Product and Planget
(Early Access) Returns a list of the APIs associated with the Event API Product and Planget
(Early Access) Returns the requested plan of the Event API Productget
(Early Access) Returns a list of plans of the Event API Productget
(Early Access) Deletes the specified attribute from the Event API Productdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the Event API Productget
(Early Access) Adds an attribute to the Event API Productpost
(Early Access) Returns attributes of the Event API Productget
(Early Access) Returns the version of an Event API Productget
(Early Access) Returns a list of versions of an Event API Product.get
(Early Access) Returns the requested Event API Productget
(Early Access) Returns a list of published Event API Productsget
Registrations
(Early Access) Returns the config state of an application registrationget
(Early Access) Deletes the specified webhook registration from the App Registration (Coming Soon)delete
(Early Access) Updates the specified webhook registration on the App Registration (Coming Soon)patch
(Early Access) Returns the specified webhook registration from the App Registration (Coming Soon)get
(Early Access) Creates a new webhook registration on the App Registration (Coming Soon)post
(Early Access) Returns a list of webhook registrations (Coming Soon)get
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Returns the Async API specification associated with the Access Request.get
(Early Access) Returns a list of all Event APIs associated with the Access Requestget
(Early Access) Deletes the specified Access Request form the App Registrationdelete
(Early Access) Updates the Access Request associated with the Application Registrationpatch
(Early Access) Returns the requested Access Request associated with the specified App Registrationget
(Early Access) Creates a new Access Request.post
(Early Access) Returns a list of Access Requests associated with the App Registrationget
(Early Access) Deletes the credentials with the specified Consumer Key from the App Registrationdelete
(Early Access) Updates the credentials with the specified Consumer Keypatch
(Early Access) Returns the Credentials with the specified Consumer Keyget
(Early Access) Requests new credentials for the App Registrationpost
(Early Access) Returns a list of all Credentials issued for the App Registrationget
(Early Access) Deletes the specified filter from the App Registrationdelete
(Early Access) Updates the specified filter's valuepatch
(Early Access) Returns the requested filter of the App Registrationget
(Early Access) Adds a topic filter to the App Registrationpost
(Early Access) Returns filters of the App Registrationget
(Early Access) Deletes the specified attribute from the App Registrationdelete
(Early Access) Updates the specified attribute's valuepatch
(Early Access) Returns the requested attribute of the App Registrationget
(Early Access) Adds an attribute to the App Registrationpost
(Early Access) Returns attributes of the App Registrationget
(Early Access) Returns the Async API specification associated with the App Registration.get
(Early Access) Returns a list of all Event APIs associated with the App Registrationget
(Early Access) Deletes the specified App Registrationdelete
(Early Access) Updates the specified App Registrationpatch
(Early Access) Returns the requested App Registrationget
(Early Access) Creates a new App Registrationpost
(Early Access) Returns a list of Application Registrationsget
Gateways
(Early Access) Returns the status of the Gateway Broker Serviceget
(Early Access) Sets or updates the SEMPv2 secret used to connect to the Gateway Brokerpatch
(Early Access) Returns the specified Gateway Broker Serviceget
(Early Access) Set the authentication mode for the Event Broker Gatewayspost
(Early Access) Returns a list of all available Gateway Event Brokersget
Reference - Managed configuration on PS+ Brokers

200a Broker Service gateway

400Bad Request.

401Unauthorized.

403Forbidden.

404Not Found.

406Not Acceptable.

429Too many requests.

500Internal Server Error.

503Service Unavailable.

504Gateway Timeout.

defaulta Broker Service service gateway