Solace DocsDeveloper HubSolace Community
API Reference

Get the AsyncAPI specification for an application version

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

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

Token Permissions: [ application:generate_async_api:* ]

Path Params
string
required

The ID of the application version.

Query Params
string
enum
Defaults to json

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

Allowed:
boolean
Defaults to false

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

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
enum
Defaults to include_attracted_events_only
deprecated

Determines whether bindings are applied to declared subscribed events or
published subscribed events in the event mesh or both.

Replacement: Use expand instead.

Reason: The change is to allow for increased flexibility of the API.

Removal Date: 2025-09-20 18:00:00.000.

Allowed:
string
deprecated

Applies bindings from attracted events that are published in this messaging service's modeled event mesh.

Replacement: Use contextId with contextType instead.

Reason: The change is to allow for increased flexibility of the API.

Removal Date: 2025-09-20 18:00:00.000.

string
enum

A comma separated list of sections of the asyncapi document to include.

Allowed:
string

Applies bindings from subscribed events that are published in this event broker or event mesh.

string
enum

The context of which events are attracted from.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 12 months 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 12 months ago