Get published Service versions
GET https://{controlplane_path}/api/1/rest/public/developer_hub/services/versions/published?org_name={org_name}
Important: This API applies to APIM 3.0, not Classic APIM.
Returns the published Service versions available on the Developer Portal, optionally filtered by category.
Prerequisites
This API is accessible without authentication when the Allow access to APIM 3.0 Portal pages without login setting is enabled on the API Management 3.0 settings page in Admin Manager. When this setting is disabled, this API is not available.
Example
curl -X 'GET' \
'https://elastic.snaplogic.com/api/1/rest/public/developer_hub/services/versions/published?org_name=my-environment'
With category filtering:
curl -X 'GET' \
'https://elastic.snaplogic.com/api/1/rest/public/developer_hub/services/versions/published?org_name=my-environment&categories=books&categories=inventory'
Query parameters
| Key | Type | Description |
|---|---|---|
org_name |
string | Required. The name of the environment (Org). |
categories |
array | Optional. One or more category names to filter the results
(for example,
categories=books&categories=inventory). |
Request header
None.
Request body
None.
Response
{
"response_map": {
"entries": [
{
"version_name": "1.0",
"version_snid": "abc123def456",
"service_name": "BookStore API",
"tags": ["books", "inventory"],
"description": "Bookstore service for managing inventory",
"documentation": {}
}
]
},
"http_status_code": 200
}
| Key | Type | Description |
|---|---|---|
entries |
array | The list of published Service versions. |
version_name |
string | The Service version identifier. |
version_snid |
string | The unique snode ID for the Service version. |
service_name |
string | The name of the parent Service. |
tags |
array | Tags assigned to the Service version. |
description |
string | The Service version description. |
documentation |
object | The documentation attached to the Service version. |
Error handling
| HTTP status codes | Message | Resolution |
|---|---|---|
| 401 | Authorization required | The Allow access to APIM 3.0 Portal pages without login setting is disabled. Enable this setting in Admin Manager to use this API. |
| 404 | Not Found | Verify that org_name is correct and the environment
exists. |