Skip to content

Managing Hub APIs

InfoConnect Hub manages the lifecycle of Program Call APIs, Data APIs and RPA APIs. You can activate and deactivate an API without changing or removing its definition, and you can generate OpenAPI 3.0 specifications for integration, documentation and client generation. The specifications can also feed API gateways, documentation platforms, AI agents and SDK generators.

This page describes the following tasks:

Activating and deactivating Functional APIs

Deactivation prevents an API from being executed and keeps its configuration. This works for Program Calls, Data APIs and RPA Calls. No one can execute a deactivated API, including administrators, until an administrator reactivates it. You can reactivate an API at any time.

API states

Each API has one of the following runtime states:

State Description
ACTIVE The API is available for execution through its functional endpoint
INACTIVE The API definition is preserved, but execution is disabled. Every execution attempt returns 404 Not Found
FAILED The last execution failed, for example because of an IBM i or SQL error. The error message is stored with the API. The API can still be called, and the next successful execution sets it back to ACTIVE. You can also activate it manually

Newly registered Program Call APIs, Data APIs and RPA APIs are ACTIVE by default.

Activation and deactivation endpoints

API type Action Endpoint
Program Call, Data API Activate GET /api/{apiDefinitionName}/activate
Program Call, Data API Deactivate GET /api/{apiDefinitionName}/deactivate
RPA Call Activate GET /rpa/admin/rpa-calls/{rpaDefinitionName}/activate
RPA Call Deactivate GET /rpa/admin/rpa-calls/{rpaDefinitionName}/deactivate

After activation:

  • The API status changes to ACTIVE.
  • The functional endpoint becomes available.
  • API consumers can execute the API again.

After deactivation:

  • The API status changes to INACTIVE.
  • The API definition remains stored in the Hub.
  • The functional endpoint becomes unavailable.
  • Every execution attempt returns 404 Not Found.

Example responses

Activating a Program Call or Data API:

{
  "message": "customer-api activated successfully."
}

Deactivating a Program Call or Data API:

{
  "message": "customer-api deactivated successfully."
}

Activating an RPA Call:

{
  "message": "customer-rpa activated successfully."
}

Deactivating an RPA Call:

{
  "message": "customer-rpa deactivated successfully."
}

Deleting a connection

Deleting an IBM i connection also deletes everything that is defined on top of that connection.

DELETE /admin/connections/{connectionName}

When you delete a connection, the Hub also deletes all objects that use the connection name:

  • Data Flows (DQ pollers), both outbound and inbound
  • Program Call APIs
  • Data APIs

RPA Calls are not deleted together with a Screen Automation connection.

Warning

The deletion cannot be undone. Before you remove a Native connection, check the number of APIs and Data Flows that use it on the connection page in the web UI.

Example response:

{
  "message": "Connection: 'DemoConnection' deleted."
}

Generating OpenAPI specifications

The Hub generates OpenAPI 3.0 specifications for registered Program Call APIs, Data APIs and RPA APIs. The documents are generated from the API definitions stored in the Hub, so they always reflect the current configuration. Changes to an API are included in every specification generated afterwards.

You can generate a specification for a single API definition or for all registered definitions of that type (Program Call, Data API or RPA Call). Each endpoint returns JSON or YAML, as shown in Response formats.

Generating a specification for a single API

API type Format Endpoint
Program Call YAML GET /program/openapi/{callDefinitionName}/yaml
Program Call JSON GET /program/openapi/{callDefinitionName}/json
Data API YAML GET /data-apis/openapi/{callDefinitionName}/yaml
Data API JSON GET /data-apis/openapi/{callDefinitionName}/json
RPA Call YAML GET /rpa/admin/openapi/{programDefinitionName}/yaml
RPA Call JSON GET /rpa/admin/openapi/{programDefinitionName}/json

A successful request returns an OpenAPI 3.0 specification of the selected API with:

  • the supported HTTP methods
  • the endpoint path
  • the request parameters
  • the request body schema
  • the response schema

Generating a specification for all APIs

The following endpoints return one consolidated OpenAPI specification that combines every registered API definition of the selected type.

API type Format Endpoint
Program Call YAML GET /program/openapi/all/yaml
Program Call JSON GET /program/openapi/all/json
Data API YAML GET /data-apis/openapi/all/yaml
Data API JSON GET /data-apis/openapi/all/json
RPA Call YAML GET /rpa/admin/openapi/all/yaml
RPA Call JSON GET /rpa/admin/openapi/all/json

Response formats

Format Content type Description
JSON application/json OpenAPI 3.0 document in JSON format
YAML application/x-yaml Human-readable OpenAPI 3.0 document in YAML format

Error handling

If the requested API definition does not exist or the specification cannot be generated, the service returns 400 Bad Request with a message that describes the failure. Example:

{
  "error": "There was an error while generating JSON: <reason>"
}