117
Views
6
Comments
Show all REST api
Question

I want to see all REST APIs present in environment.

Example: If there are 10 application(each app have 5 modules). i want to see all REST APIs present in all modules.

2025-01-14 14-18-30
Luan Cu

Hello @Shreedhar Hagedal,

Unfortunately, I am not aware of any approach that can achieve your expectations, you can try to find out on Forge if there is any plugin that can help you.

Additionally, I think that's too sticky to achieve because in an environment that can have a brunch of applications thus it can have too many APIs, may I know what your reason behind this or the use case that will be needed with these requirements?

UserImage.jpg
Shreedhar Hagedal

Thank you. In the project, we are currently using APIs from external source, but we need to centralize them into a single point. However, we are unsure where all the APIs are located, as there is no documentation available.

UserImage.jpg
Antonio Barazarte

Hello!

A good practice is creating a module for each project, with all the integrations inside.

So you can find and manage the APIs easily.


In ServiceCenter in the integration part, you can find where the APIs are consumed.

But not where they are.

2024-02-16 11-58-28
Sheikh Mohd Fahad

Hello @Shreedhar Hagedal,

To see all REST APIs present in an OutSystems environment, you can use the Service Center or an automated approach via the LifeTime API or OutSystems Metadata Entities.

1. Using Service Center

You can manually check all REST APIs for the environment:

  1. Log in to Service Center of your environment.
  2. Navigate to Monitoring > Integrations > Exposed REST APIs.
  3. This will display a list of all REST APIs exposed by the applications and modules in the environment.

2. Automated Approach Using OutSystems Metadata Entities

OutSystems stores metadata about exposed and consumed REST APIs in its internal system entities. You can create a module to query this data:

  1. Create a new module and add an aggregate on the REST_Expose system table.
  2. The REST_Expose entity contains details about all exposed REST APIs, such as:
    • Name: Name of the REST API.
    • ModuleId: The module where the REST API is defined.
    • Description: Description of the API.
    • URL: Base URL of the API.
  3. You can join this entity with Espace to get the application name.

3. Using LifeTime API

If you want to get this information programmatically:

  1. Use the OutSystems LifeTime API, which provides metadata about applications and modules.
  2. Create a script or integration to retrieve information about all modules and their REST APIs.

Output Example

You can create a screen or export to a CSV to show the following fields:

  • Application Name
  • Module Name
  • REST API Name
  • Endpoint URL
2024-09-12 02-43-38
Deepsagar Dubey

Hello @Shreedhar Hagedal 

Try to use API Management Console component, The API Management Console is a powerful and user-friendly OutSystems Forge component designed to simplify the management of APIs within your OutSystems applications. It provides a centralized dashboard for developers and administrators to efficiently manage Rest API configurations,

I hope this'll help you.

Thanks
Deep

2025-07-22 10-30-27
Mandar Deshpande

Forge components like Discovery or Architecture Dashboard can also help to explore module dependencies and APIs here. 

Discovery → shows architecture and API usages. 

Architecture Dashboard → governance view, includes API exposure/consumption.

Community GuidelinesBe kind and respectful, give credit to the original source of content, and search for duplicates before posting.