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}

Important: This API applies to APIM 3.0, not Classic APIM.

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. Authentication requirements depend on the Developer Portal login settings:

If the Developer Portal does not require login, this API is openly accessible without authentication.
If the Developer Portal requires login, requests must include Basic authentication credentials (email address and password). Requests without valid credentials return a 401 response.

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/details?org_name=my-environment&service_slug=bookstore-api&version_name=1.0'

Note: If the Developer Portal requires login, add the Authorization header: -H 'Authorization: Basic {base64_encoded email:password}'

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 Service version identifier.

Request header

If the Developer Portal requires login:

Authorization: Basic {base64_encoded email:password}

Otherwise, no request header is required.

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 Service 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	The 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 a query parameter is missing, the environment or Service doesn't exist, or the Developer Portal requires login and valid credentials were not provided. The API uses a uniform error response for all cases. Verify the `org_name`, `service_slug`, and `version_name` values. If the Portal requires login, include Basic authentication credentials.