Managing access to the Admin API

Edit online

The Event Endpoint Management Admin API provides a set of APIs that users with an IBM webMethods Hybrid Integration service role can use to access the features of Event Endpoint Management.

Important: To use the Event Endpoint Management Admin API, your user must have a service role in IBM webMethods Hybrid Integration:

Service
owner

, Service admin, or Service user.

The following features are available by using the Admin API:

Clusters (Create, Read, Update, Delete)
Source topics (Create, Read, Update, Delete)
Virtual topic lifecycle states (Publish, Unpublish, Archive)
Subscriptions (Create, Read, Update, Delete).
Note: In Event Endpoint Management June 2026 version, subscriptions created with the Admin API are converted to applications.
Gateways (Read gateway list)

Note: If you skipped the connection checks when you added your Kafka cluster, then after you create a topic you must wait for your gateways to complete connection tests with your cluster. Only after these checks complete successfully can you proceed to publish any virtual topics that you create for the source topic.

A dedicated Event Endpoint Management Admin API endpoint is provided for each organization upon provisioning of an Event Endpoint Management service. To make API requests to this endpoint, you require an api token.

API tokens

To use the Event Endpoint Management Admin API, you require an API token. You can create and manage tokens in the Profile page. The Profile page displays the current Event Endpoint Management organization that you are a member of, and a list of existing tokens in the Tokens table.

A maximum of 10 API tokens can be created per user. If you reach this limit, then you must delete an existing API token before you can create a new one.

API tokens are valid for a maximum of 365 days. Event Endpoint Management rejects API requests that use an expired token.

Creating a token

To create an API token, complete the following steps:

Log in to your Event Endpoint Management UI from a supported web browser.
Click your user avatar in the upper-right corner of the window, and then click Profile to open the Profile page.
Switch to the Access tokens tab.
Click Create token.
Provide a token description.
Specify the token duration in days (minimum: 1 day, maximum: 365 days).
Click Create.
A new token is generated.
- To view the token, click Show token within the Token field.
- To copy the token, click Copy token.
Note: The API token is displayed once and you cannot retrieve it later. For this reason, ensure that you copy and save the token.
Click Close.

The created token is added to the Tokens table.

Note: You can also create API tokens in the Multi-cloud Saas Platform (MCSP) user console. Tokens that are created in the MCSP console are visible in the Tokens table (sometimes after a short delay) when the page is displayed or refreshed. The 10 token limit applies whether they are created in the Profile page or the MCSP console.

Removing a token

Existing tokens can be deleted from the Tokens table on the Access tokens tab of the Profile page. Deleting a token is permanent and cannot be reversed.

To delete a token, complete the following steps:

Log in to your Event Endpoint Management UI from a supported web browser.
Click the user avatar at the upper-right, and then click Profile to open the Profile page.
Switch to the Access tokens tab.
Click Delete in the row of the token that you want to remove.
Confirm that you want to delete the token by entering the token description.
Click Delete.

Exporting topic data by using the Admin API

You can use the Event Endpoint Management Admin API to extract the following data for your topics.

id
name
description
clusterId
encoding
topic
contact
tags
sampleMessages

To retrieve and export topic data by using the Admin API, complete the following steps:

Follow the steps to create a token.
In the Event Endpoint Management UI header, click your user icon > Profile > Access tokens to locate your Admin API URL. For example:
```
https://<environment>.eem.eem.apps.<region>.events.ipaas.<domain>/admin
```
Open your preferred terminal and use the following code snippet to retrieve and export all of your topics:
```
curl -sS -X GET \
  'https://<ADMIN_API_URL>/eventsources' \
  -H "Authorization: Bearer <API_TOKEN>" \
  -H "Accept: application/json" \
  -o source_topics.json
```
where:
- ADMIN_API_URL is the URL retrieved in step 2.
- API_TOKEN is the token that you retrieved in step 1.

The response is saved to source_topics.json in your current directory.