Get published Service details

GET https://{controlplane_path}/api/1/rest/public/developer_hub/details?org_name={org_name}&service_slug={service_slug}&version_name={version_name}

Retrieve the published details for an APIM 3.0 Service version on the Developer Portal.

This API returns the published Service version details, including endpoints, servers, tags, and documentation. It does not require authentication unless the environment's Developer Portal settings require it.

Note: If the Developer Portal requires authentication (require_auth is true in the Portal site settings), the API returns an authorization error.

Prerequisites

None. This API does not require authentication by default. However, the environment's Developer Portal settings can require authentication.

Note: To get a response from this API, the Allow Access to APIM 3.0 Portal pages without login setting must be enabled on the API Management 3.0 settings page in Admin Manager. If disabled, all pages except the login page require users to log in.

Example

curl -X 'GET' \
  'https://elastic.snaplogic.com/api/1/rest/public/developer_hub/details?org_name=my-environment&service_slug=bookstore-api&version_name=1.0'

Query parameters


Key	Type	Description
`org_name`	string	Required. The name of the environment (Org).
`service_slug`	string	Required. The slug of the published Service.
`version_name`	string	Required. The name of the Service version.

Request header

None required. If the Developer Portal requires authentication, include an authorization header.

Request body

None.

Response


{
  "response_map": {
    "subscribable": true,
    "version_name": "1.0",
    "service_name": "BookStore API",
    "description": "Bookstore service for managing inventory",
    "tags": ["books", "inventory"],
    "servers": [
      {
        "name": "my-snaplex",
        "url": "https://elastic.snaplogic.com/api/1/rest/slsched/feed/..."
      }
    ],
    "documentation": {},
    "endpoints": [],
    "spec": {}
  },
  "http_status_code": 200
}


Key	Type	Description
`subscribable`	boolean	Whether the Service version accepts subscriptions.
`version_name`	string	The version identifier.
`service_name`	string	The name of the parent Service.
`description`	string	The Service version description.
`tags`	array	Tags or categories assigned to the Service version.
`servers`	array	Snaplex servers associated with the Service. Each entry contains `name` (Snaplex name) and `url` (Snaplex URL).
`documentation`	object	Documentation attached to the Service version.
`endpoints`	array	Endpoint definitions for the Service version.
`spec`	object	The OpenAPI specification for the Service version.

Error handling


HTTP status codes	Message	Resolution
401	Authorization required	The API returns this error when any query parameter is missing, the environment or Service doesn't exist, or the Developer Portal requires authentication. Verify the `org_name`, `service_slug`, and `version_name` values. If the Portal requires authentication, include an authorization header.