(Early Access) Returns the requested App Registration

Response body

object

data

object

required

registrationId

string

required

length between 2 and 64

Id attribute as supplied by the APi Client

source

string

required

length between 2 and 64

Id attribute as supplied by the APi Client

name

string

required

length between 0 and 128

applicationDomainId

string

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

sourceOwner

string

length between 0 and 128

brokerType

string

required

Defaults to solace

The type of the broker used for the event API product

kafka solace

accessRequests

array of objects

required

length between 0 and 999

accessRequests*

object

accessRequestId

string

required

length between 2 and 64

Id attribute as supplied by the APi Client

registrationId

string

required

length between 2 and 64

Id attribute as supplied by the APi Client

eventApiProductId

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

eventApiProductVersion

string

required

a version number in semver (Semantic Versioning) format

planId

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

state

string

required

PENDING_APPROVAL REJECTED REVOKED APPROVED ERROR LIVE

eventApiResourceInformation

array of objects

eventApiResourceInformation

object

name

string

required

length between 2 and 250

The name of the queue that is available for this access request

eventApiId

string

length between 2 and 128

The id of the eventApi the resource is provided for, only present if the Event API Product plan's policy is set to queueType single

accessType

string

required

Defaults to exclusive

access mode for the queue

exclusive non-exclusive

maxTtl

int64

required

0 to 9007199254740991

Defaults to 86400

retention policy for message on the queue, in seconds

maxMsgSpoolUsage

int64

required

0 to 9007199254740991

Defaults to 500

The maximum message spool usage allowed by the Queue, in megabytes (MB). A value of 0 only allows spooling of the last message received and disables quota checking

eventApiProductResourceInformation

object

filters

array of objects

required

length between 0 and 256

List of topic filters specific to this app registration

filters*

object

name

string

required

length between 0 and 128

values

array of strings

required

filter values

values*

apis

array of objects

required

length between 0 and 999

apis*

object

id

string

required

length between 2 and 64

id as automatically issued by APIs , alphanumeric characters only

description

string

length between 0 and 10000

version

string

required

length between 2 and 64

displayName

string

length between 0 and 128

name

string

required

length between 0 and 128

customAttributes

array of objects

required

length between 0 and 256

customAttributes*

object

name

string

required

length between 4 and 128

value

string

required

length between 0 and 10000

Valid Objects are Strings with characters

credentials

array of objects

required

length between 0 and 999

credentials*

object

expiresAt

int64

required

-1 to 9007199254740991

issuedAt

int64

required

-1 to 9007199254740991

secret

object

required

name

string

length between 0 and 128

webhooks

array of objects

required

length between 0 and 999

webhooks*

object

uri

string

required

length between 0 and 200

name

string

length between 0 and 128

gatewayMessagingServiceIds

array of strings

length between 0 and 255

messaging services that this webhook service is available on, if absent webhook will be used for all associated messaging services

gatewayMessagingServiceIds

method

string

required

Defaults to POST

POST PUT

mode

string

Defaults to parallel

parallel serial

authentication

object

tlsOptions

object

deprecated

TLS options required to support older PS+ brokers.

requestHeaders

array of objects

length between 0 and 50

requestHeaders

object

headerName

string

required

length between 1 and 50

headerValue

string

required

length between 1 and 1024

appendTopicToUrl

boolean

Inidicates if the message topic should be appended to the webhook url when the request is made by the messaging service.

attributes

array of objects

required

length between 0 and 256

Attributes managed by integrations and external clients.

attributes*

object

name

string

required

length between 4 and 128

value

string

required

length between 0 and 10000

Valid Objects are Strings with characters

gatewayMessagingServices

array of objects

required

length between 0 and 256

List of available gateway messaging services and the permissions granted to the application on each.

gatewayMessagingServices*

object

name

string

required

length between 0 and 128

displayName

string

length between 1 and 256

Friendly name of an object for display in UIs, Developer Portals. Can be changed after object creation

messagingServiceConnections

array of objects

required

length between 0 and 255

the protocols and con donnection information that are available to the app for gateway messaging service connections

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.

permissions

object

required

lists all the publish and subscribe topics an app has access to. Restrictions on topic elements are taken into account.

filters

array of objects

required

length between 0 and 256

List of topic filters specific to this app registration

filters*

object

name

string

required

length between 0 and 128

values

array of strings

required

filter values

values*

200the app registration

400Bad Request.

401Unauthorized.

403Forbidden.

404Not Found.

406Not Acceptable.

429Too many requests.

500Internal Server Error.

503Service Unavailable.

504Gateway Timeout.

defaultthe app registration