---
updatedAt: 2026-07-28T13:52:16.000Z
---
# (Beta) Get a List of Event API Product Versions
Use this API to get a list of Event API Product versions that match the given parameters.
Token Permissions: [ event_designer:access ]
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "Event Portal - Designer",
"description": "REST API Concepts\n\nSolace Event Portal provides REST APIs that you can use to manage your data in Solace Cloud. \nThe REST APIs allow you to model your event-driven architectures from your own client applications.\n\nThe following document describes the public REST APIs available for use in Event Portal 2.0. Objects created in this \nversion will not be available in Event Portal 1.0. APIs that display (Beta) in their summary are provided as-is and \nare subject to change or removal. They may not be of the quality expected for generally available APIs and have no \nguaranteed forward compatibility with the generally available version of the API.\n\n",
"version": "2.13.2"
},
"servers": [
{
"url": "https://api.solace.cloud",
"description": "Solace PubSub+ Cloud US EAST Region"
},
{
"url": "https://api.solacecloud.com.au",
"description": "Solace PubSub+ Cloud AU Region"
},
{
"url": "https://api.solacecloud.eu",
"description": "Solace PubSub+ Cloud EU Region"
},
{
"url": "https://api.solacecloud.sg",
"description": "Solace PubSub+ Cloud SG Region"
}
],
"security": [
{
"APIToken": []
}
],
"tags": [
{
"name": "Event API Products"
}
],
"paths": {
"/api/v2/architecture/eventApiProductVersions": {
"get": {
"tags": [
"Event API Products"
],
"summary": "(Beta) Get a List of Event API Product Versions",
"description": "Use this API to get a list of Event API Product versions that match the given parameters.
Token Permissions: [ event_designer:access ]",
"operationId": "getEventApiProductVersions",
"parameters": [
{
"name": "pageSize",
"in": "query",
"description": "The number of results to return in one page of results.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 20,
"maximum": 100,
"minimum": 1
}
},
{
"name": "pageNumber",
"in": "query",
"description": "The page number to get results from based on the page size.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 1,
"minimum": 1
}
},
{
"name": "eventApiProductIds",
"in": "query",
"description": "Match only Event API Product versions of these Event API Product IDs, separated by commas.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
{
"name": "ids",
"in": "query",
"description": "Match Event API Product versions with the given IDs, separated by commas.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
}
},
{
"name": "include",
"in": "query",
"description": "A list of additional entities to include in the response.",
"required": false,
"schema": {
"type": "string"
},
"example": "parent"
},
{
"name": "stateId",
"in": "query",
"description": "Match Event API Product versions with the given state ID.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "messagingServiceId",
"in": "query",
"description": "Match Event API Product versions with the given messagingServiceId.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "clientAppId",
"in": "query",
"description": "Match Event API Product versions with the given clientAppId.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "shared",
"in": "query",
"description": "Match Event API Product versions with the parent objects shared setting.",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "latest",
"in": "query",
"description": "Only return the latest version of Event API Products.",
"required": false,
"schema": {
"type": "boolean"
}
},
{
"name": "customAttributes",
"in": "query",
"description": "Returns the entities that match the custom attribute filter.
To filter by custom attribute name and value, use the format: `customAttributes===`.
To filter by custom attribute name, use the format: `customAttributes=`.
The filter supports the `AND` operator for multiple custom attribute definitions (not multiple values for a given definition). Use `;` (`semicolon`) to separate multiple queries with `AND` operation.
Note: the filter supports custom attribute values containing only the characters `[a-zA-Z0-9_\\-\\. ]`.",
"required": false,
"schema": {
"type": "string"
},
"example": "color==red"
}
],
"responses": {
"200": {
"description": "Get a list of Event API Product versions.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventApiProductVersionsResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"405": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"501": {
"description": "Not Implemented",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"CustomAttribute": {
"type": "object",
"properties": {
"customAttributeDefinitionId": {
"type": "string",
"example": "acb2j5k3mly"
},
"customAttributeDefinitionName": {
"type": "string",
"example": "color",
"pattern": "a-zA-Z0-9_\\-\\."
},
"value": {
"type": "string",
"example": "red",
"pattern": "a-zA-Z0-9_\\-\\."
},
"stringValues": {
"type": "string",
"example": "red",
"pattern": "a-zA-Z0-9_\\-\\."
}
}
},
"ErrorResponse": {
"type": "object",
"discriminator": {
"propertyName": "errorType"
},
"properties": {
"message": {
"type": "string",
"description": "A user-friendly message that describes the error.",
"example": "An error occurred."
},
"errorId": {
"type": "string",
"description": "The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.",
"example": "123e4567-e89b-12d3-a456-426655440000"
},
"meta": {
"type": "object",
"additionalProperties": {},
"example": "'object': { 'field': 'description' }"
},
"validationDetails": {
"type": "object",
"additionalProperties": {
"type": "array",
"items": {
"type": "string"
}
},
"description": "When applicable, these are the details of issues with the fields provided for the REST call.",
"example": "'name': ['Not unique']"
},
"errorType": {
"type": "string",
"writeOnly": true
}
}
},
"EventApiProductRegistration": {
"type": "object",
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"applicationDomainId": {
"type": "string",
"example": 12345678
},
"registrationId": {
"type": "string",
"example": 12345678
},
"accessRequestId": {
"type": "string",
"example": 12345678
},
"eventApiProductVersionId": {
"type": "string",
"example": 12345678
},
"planId": {
"type": "string",
"example": 12345678
},
"state": {
"type": "string",
"enum": [
"Pending Approval",
"Rejected",
"Revoked",
"Approved",
"Error",
"Live"
]
},
"type": {
"type": "string",
"default": "eventApiProductRegistration",
"description": "The type of payload",
"readOnly": true
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
},
"required": [
"accessRequestId",
"applicationDomainId",
"eventApiProductVersionId",
"planId",
"registrationId"
]
},
"EventApiProductVersion": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"id": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"eventApiProductId": {
"type": "string",
"example": "acb2j5k3mly"
},
"description": {
"type": "string",
"example": "Event API product created by Solace Cloud documentation",
"maxLength": 10000
},
"version": {
"type": "string",
"example": "1.0.0"
},
"summary": {
"type": "string",
"example": "Summary string value of event API product version"
},
"customAttributes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomAttribute"
}
},
"displayName": {
"type": "string",
"example": "Event API product version display name",
"maxLength": 40
},
"eventApiVersionIds": {
"type": "array",
"description": "List of IDs of associated event API versions",
"items": {
"type": "string"
}
},
"stateId": {
"type": "string",
"example": 1
},
"eventApiProductRegistrations": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApiProductRegistration"
}
},
"plans": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Plan"
}
},
"solaceMessagingServices": {
"type": "array",
"description": "Solace Messaging Services",
"items": {
"$ref": "#/components/schemas/SolaceMessagingService"
}
},
"filters": {
"type": "array",
"description": "List of filters that contains eventVersionId name and variables",
"items": {
"$ref": "#/components/schemas/Filter"
}
},
"approvalType": {
"type": "string",
"default": "automatic",
"description": "Approval type",
"enum": [
"automatic",
"manual"
]
},
"publishState": {
"type": "string",
"default": "unset",
"description": "Publish state",
"enum": [
"unset",
"published"
]
},
"publishedTime": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"endOfLifeDate": {
"type": "string",
"example": "2021-12-31T20:30:57.920Z"
},
"type": {
"type": "string",
"description": "The type of payload",
"readOnly": true
}
},
"required": [
"eventApiProductId"
]
},
"EventApiProductVersionsResponse": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EventApiProductVersion"
}
},
"meta": {
"$ref": "#/components/schemas/meta"
}
}
},
"Filter": {
"type": "object",
"properties": {
"eventVersionId": {
"type": "string",
"example": 123456
},
"topicFilters": {
"type": "array",
"description": "List of variable that contains address node name and filters",
"items": {
"$ref": "#/components/schemas/TopicFilter"
}
},
"id": {
"type": "string"
},
"type": {
"type": "string",
"default": "filter",
"description": "The type of payload",
"readOnly": true
}
}
},
"InvalidNonStateReference": {
"type": "object",
"properties": {
"entityId": {
"type": "string"
},
"entityType": {
"type": "string"
}
}
},
"InvalidStateReference": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorResponse"
},
{
"type": "object",
"properties": {
"targetStateId": {
"type": "string"
},
"inboundInvalidNonStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidNonStateReference"
}
},
"inboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"outboundInvalidStateReferences": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InvalidStateReference"
}
},
"errorType": {
"type": "string"
}
}
}
]
},
"Pagination": {
"type": "object",
"properties": {
"pageNumber": {
"type": "integer",
"format": "int32"
},
"count": {
"type": "integer",
"format": "int32"
},
"pageSize": {
"type": "integer",
"format": "int32"
},
"nextPage": {
"type": "integer",
"format": "int32"
},
"totalPages": {
"type": "integer",
"format": "int32"
}
}
},
"Plan": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "ID value of the object",
"example": 123456,
"readOnly": true
},
"name": {
"type": "string",
"description": "Title of the object",
"example": "Gold"
},
"solaceClassOfServicePolicy": {
"$ref": "#/components/schemas/SolaceClassOfServicePolicy",
"description": "Solace class of service policy"
},
"type": {
"type": "string",
"default": "plan",
"description": "The type of this payload",
"readOnly": true
}
}
},
"SolaceClassOfServicePolicy": {
"type": "object",
"properties": {
"messageDeliveryMode": {
"type": "string",
"default": "direct",
"description": "The mode that will be used for message delivery (ex: `guaranteed` uses a queue)",
"enum": [
"direct",
"guaranteed"
]
},
"accessType": {
"type": "string",
"enum": [
"exclusive",
"non-exclusive"
]
},
"maximumTimeToLive": {
"type": "integer",
"format": "int32",
"description": "Duration in seconds of how long a message can live in a queue",
"example": 1500
},
"queueType": {
"type": "string",
"default": "combined",
"description": "The arrangement of queues on a broker used for message delivery (ex: `single` uses one queue per event API version in this event API product)",
"enum": [
"single",
"combined"
]
},
"maxMsgSpoolUsage": {
"type": "integer",
"format": "int32",
"description": "Total number of MBs available for the queue to use",
"example": 5
},
"id": {
"type": "string",
"description": "ID value of the object",
"example": 123456,
"readOnly": true
},
"type": {
"type": "string",
"default": "solaceClassOfServicePolicy",
"description": "The type of payload",
"readOnly": true
}
}
},
"SolaceMessagingService": {
"type": "object",
"properties": {
"solaceCloudMessagingServiceId": {
"type": "string",
"example": "service123"
},
"id": {
"type": "string",
"description": "ID value of the object",
"example": 123456,
"readOnly": true
},
"messagingServiceId": {
"type": "string",
"description": "ID of the Event Portal messaging service",
"example": 456789,
"readOnly": true
},
"messagingServiceName": {
"type": "string",
"description": "Name of the Event Portal messaging service",
"example": "Messaging Service",
"readOnly": true
},
"supportedProtocols": {
"type": "array",
"description": "Values for allowed supported protocols",
"items": {
"type": "string"
}
},
"environmentId": {
"type": "string",
"example": "xyz23mwec2g",
"readOnly": true
},
"environmentName": {
"type": "string",
"deprecated": true,
"description": "*Deprecation Date: 2025-01-17
Removal Date: 2026-01-17
Reason: Environment name should be fetched from Platform APIs.*
",
"example": "Production",
"readOnly": true
},
"eventMeshId": {
"type": "string",
"example": "xyz23mwec2y",
"readOnly": true
},
"eventMeshName": {
"type": "string",
"example": "US East Mesh",
"readOnly": true
},
"type": {
"type": "string",
"default": "solaceManagedMessagingService",
"description": "The type of payload",
"readOnly": true
}
}
},
"TopicFilter": {
"type": "object",
"additionalProperties": true,
"properties": {
"createdTime": {
"type": "string",
"description": "The time the entity was created",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"updatedTime": {
"type": "string",
"description": "The time the entity was last updated",
"example": "2021-12-31T20:30:57.920Z",
"readOnly": true
},
"createdBy": {
"type": "string",
"description": "The user who created the entity",
"example": 12345678,
"readOnly": true
},
"changedBy": {
"type": "string",
"description": "The user who last updated the entity",
"example": 12345678,
"readOnly": true
},
"name": {
"type": "string",
"description": "name of address node",
"example": "name"
},
"filterValue": {
"type": "string",
"description": "Different filter values separated by comma",
"example": " Tes?, TEST*FILTER, SAmPle"
},
"eventVersionIds": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true
},
"type": {
"type": "string",
"default": "topicFilter",
"description": "The type of payload",
"readOnly": true
}
},
"required": [
"eventVersionIds"
]
},
"meta": {
"type": "object",
"properties": {
"pagination": {
"$ref": "#/components/schemas/Pagination"
}
}
}
},
"securitySchemes": {
"APIToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
},
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true
}
}
```