Solace DocsDeveloper HubSolace Community
API Reference

Get the AsyncAPI Specification for an Event API Version

get
https://api.solace.cloud/api/v2/architecture/eventApiVersions//asyncApi

Use this API to get the AsyncAPI specification for an event API version annotated with Event Portal metadata.
Deprecation Date: 2025-01-20
Removal Date: 2026-01-20
Reason: Replaced by /eventApiVersions/{eventApiVersionId}/exports/asyncAPI

Token Permissions: [ event_api:generate_async_api:* ]

Path Params
string
required

The ID of the event API version.

Query Params
boolean
Defaults to false

Include versions in each AsyncAPI object's name when only one version is present

string
enum
Defaults to json

The format in which to get the AsyncAPI specification. Possible values are yaml and json.

Allowed:
string
enum
Defaults to all

The event portal database keys to include for each AsyncAPI object.

Allowed:
string
enum
Defaults to 2.5.0

The version of AsyncAPI to use.

Allowed:
string

The ID of the event API Product Version to use for generating bindings.

string

The ID of the plan to use for generating bindings.

gatewayMessagingServiceIds
array of strings

The list IDs of gateway messaging services for generating bindings.

gatewayMessagingServiceIds
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated about 1 year ago

Language
Credentials
Bearer
JWT
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain
Updated about 1 year ago