- Support
- Integrations
- API Gateway
API Gateway
Oracle Cloud integration · 18 node(s).
00Overview
Stand up and run Oracle Cloud API Gateways straight from a flow — create public or private gateways on a subnet, publish APIs on them under a path prefix, and version the OpenAPI specifications your API resources hold. List, fetch, rename and delete gateways, APIs and deployments, and move any of them between compartments when you reorganise. Because these resources are created asynchronously, a flow can kick one off and then poll until it is active before wiring in the next step.
Every field below is exactly what you see in the Flomation editor. Fields marked ● live picker let you choose from a list pulled live from your account — no IDs to look up.
01Connecting API Gateway
- Choose how the node signs in using the Authentication dropdown. Connect Oracle Cloud uses a saved Oracle Cloud connection — pick it in the Oracle Cloud connection field and the signing details are supplied for you. API signing key (advanced) lets you paste the raw key fields on the node instead.
- In the OCI Console, open the Profile menu (top-right avatar) → your user name to reach User Settings, then under Resources choose API Keys → Add API Key. Generate a new key pair and download the private key (PEM), or upload your own public key.
- After the key is added, OCI shows a Configuration File Preview — copy the Tenancy OCID (
ocid1.tenancy…), User OCID (ocid1.user…), Key Fingerprint and Region (e.g.uk-london-1) from it into the matching node fields. - Set the Compartment OCID to the compartment your gateways, APIs and deployments live in (Console → Identity → Compartments) — it is required on every action.
- Store the downloaded private key as a Flomation environment secret (e.g.
apigateway_secret) and pick it in the node's Private Key (PEM) field; if the key is encrypted, add its Private Key Passphrase as a secret too.
| Field | Type | Details | |
|---|---|---|---|
| Authentication | string | Connect Oracle Cloud, API signing key (advanced) | |
| Oracle Cloud connection | credential | Pick a connected Oracle Cloud account | |
| Region | string | e.g. uk-london-1 | |
| Private Key (PEM) | secret | The API signing private key — full PEM, incl. BEGIN/END lines | |
| Private Key Passphrase | secret | Only if the key is encrypted (optional) | |
| Tenancy OCID | string | ocid1.tenancy.oc1..aaaa… | |
| User OCID | string | ocid1.user.oc1..aaaa… | |
| Key Fingerprint | string | aa:bb:cc:… fingerprint of the uploaded API key |
Pick an Environment on your flow (Flow Settings → Environment) so the secret resolves. Secret fields never show the value — they reference ${secrets.your_secret}.
02Api
OCI API Gateway: Change API Compartment
oracle/apigateway/api_change_compartment · Action
Move an API Gateway API into a different compartment — the API keeps its OCID, only its compartment placement changes.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| API OCID | string | Required | ocid1.apigatewayapi.oc1..aaaa… (the API to move) |
| Destination Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (where to move the API) |
Returns: tool_result, id, destination_compartment_id, success, error
OCI API Gateway: Create API
oracle/apigateway/api_create · Action
Create an API resource holding an OpenAPI specification. Returns the API in a CREATING state plus a work-request id — poll Get API until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Display Name | string | A name for the API (optional) | |
| Specification Content | text | The API specification (OpenAPI) as raw JSON or YAML (optional) |
Returns: tool_result, api, id, lifecycle_state, work_request_id, success, error
OCI API Gateway: Delete API
oracle/apigateway/api_delete · Action
Delete an API resource by its OCID — returns a work-request id that tracks the delete to completion.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| API OCID | string | Required | ocid1.apigatewayapi.oc1..aaaa… of the API to delete |
Returns: tool_result, id, work_request_id, success, error
OCI API Gateway: Get API
oracle/apigateway/api_get · Action
Fetch a single API Gateway API resource by its OCID — its specification type, lifecycle state and details.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| API OCID | string | Required | ocid1.apigatewayapi.oc1..aaaa… |
Returns: tool_result, api, id, lifecycle_state, success, error
OCI API Gateway: List APIs
oracle/apigateway/api_list · Action
List the API resources in a compartment. Optionally filter by exact display name or lifecycle state, and cap the page size. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Display Name Filter | string | Only APIs with this exact name (optional) | |
| Lifecycle State | string | Only APIs in this state (optional) — choices: Creating, Active, Updating, Deleting, Deleted, Failed | |
| Page Size | string | Max items per page (optional) |
Returns: tool_result, apis, count, truncated, success, error
OCI API Gateway: Update API
oracle/apigateway/api_update · Action
Partially update an API resource — change only the display name or specification content you supply; blank fields are left unchanged. Asynchronous: returns a work-request id — poll Get API until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| API OCID | string | Required | ocid1.apigatewayapi.oc1..aaaa… — the API to update |
| Display Name | string | New name (leave blank to keep unchanged) | |
| Specification Content | text | API specification in JSON or YAML (leave blank to keep unchanged) |
Returns: tool_result, id, work_request_id, success, error
03Deployment
OCI API Gateway: Change Deployment Compartment
oracle/apigateway/deployment_change_compartment · Action
Move an API Gateway deployment into a different compartment — the deployment keeps its OCID, only its compartment placement changes.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Deployment OCID | string | Required | ocid1.apideployment.oc1..aaaa… (the deployment to move) |
| Destination Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (where to move the deployment) |
Returns: tool_result, id, destination_compartment_id, success, error
OCI API Gateway: Create Deployment
oracle/apigateway/deployment_create · Action
Publish an API on a gateway under a path prefix, with its routes defined by an API specification. Returns a work-request id — poll Get Deployment until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Gateway OCID | string | Required | ocid1.apigateway.oc1..aaaa… — the gateway to deploy on |
| Path Prefix | string | Required | e.g. /v1 — the path all routes deploy under |
| API Specification (JSON) | text | Required | {"routes":[{"path":"/hello","methods":["GET"],"backend":{"type":"STOCK_RESPONSE_BACKEND","status":200,"body":"Hello"}}]} |
| Display Name | string | A name for the deployment (optional) |
Returns: tool_result, deployment, id, lifecycle_state, endpoint, work_request_id, success, error
OCI API Gateway: Delete Deployment
oracle/apigateway/deployment_delete · Action
Delete an API Gateway deployment by its OCID — it unpublishes the API from the gateway. Returns a work-request id to track the delete.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Deployment OCID | string | Required | ocid1.apideployment.oc1..aaaa… of the deployment to delete |
Returns: tool_result, id, work_request_id, success, error
OCI API Gateway: Get Deployment
oracle/apigateway/deployment_get · Action
Fetch a single API Gateway deployment by its OCID — its gateway, path prefix, endpoint and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Deployment OCID | string | Required | ocid1.apideployment.oc1..aaaa… |
Returns: tool_result, deployment, id, lifecycle_state, endpoint, success, error
OCI API Gateway: List Deployments
oracle/apigateway/deployment_list · Action
List the API deployments in a compartment. Optionally filter by gateway OCID or exact display name. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Gateway OCID Filter | string | Only deployments on this gateway (optional) | |
| Display Name Filter | string | Only deployments with this exact display name (optional) | |
| Page Size | string | Max results per page (optional) |
Returns: tool_result, deployments, count, truncated, success, error
OCI API Gateway: Update Deployment
oracle/apigateway/deployment_update · Action
Partially update an API Gateway deployment — change only the display name and/or API specification (JSON) you supply; blank fields are left unchanged. Returns a work-request id; poll Get Deployment until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Deployment OCID | string | Required | ocid1.apideployment.oc1..aaaa… — the deployment to update |
| Display Name | string | New name (leave blank to keep unchanged) | |
| API Specification (JSON) | text | {"routes":[…]} — the deployment specification (leave blank to keep unchanged) |
Returns: tool_result, id, work_request_id, success, error
04Gateway
OCI API Gateway: Change Gateway Compartment
oracle/apigateway/gateway_change_compartment · Action
Move an API Gateway gateway into a different compartment — the gateway keeps its OCID, only its compartment placement changes.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Gateway OCID | string | Required | ocid1.apigateway.oc1..aaaa… (the gateway to move) |
| Destination Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (where to move the gateway) |
Returns: tool_result, id, destination_compartment_id, success, error
OCI API Gateway: Create Gateway
oracle/apigateway/gateway_create · Action
Create an API Gateway on a subnet. Choose a PUBLIC (internet-facing) or PRIVATE endpoint type. Returns the gateway in a CREATING state plus a work-request id — poll Get Gateway until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Endpoint Type | string | Required | Public (internet-facing) or private — choices: Public (internet-facing), Private (subnet-only) |
| Subnet OCID | string | Required | ocid1.subnet.oc1..aaaa… — the subnet the gateway sits on |
| Display Name | string | A name for the gateway (optional) |
Returns: tool_result, gateway, id, lifecycle_state, work_request_id, success, error
OCI API Gateway: Delete Gateway
oracle/apigateway/gateway_delete · Action
Delete an API Gateway by its OCID — it moves to DELETING and returns a work-request id to track the removal.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Gateway OCID | string | Required | ocid1.apigateway.oc1..aaaa… of the gateway to delete |
Returns: tool_result, id, work_request_id, success, error
OCI API Gateway: Get Gateway
oracle/apigateway/gateway_get · Action
Fetch a single API Gateway by its OCID — its endpoint type, subnet, hostname and lifecycle state.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Gateway OCID | string | Required | ocid1.apigateway.oc1..aaaa… |
Returns: tool_result, gateway, id, lifecycle_state, success, error
OCI API Gateway: List Gateways
oracle/apigateway/gateway_list · Action
List the API gateways in a compartment. Optionally filter by exact display name or lifecycle state, and cap the per-page size. Walks pagination up to a safe cap.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… (use the tenancy OCID for the root) |
| Display Name Filter | string | Only gateways with this exact name (optional) | |
| Lifecycle State | string | Only gateways in this state (optional) — choices: Creating, Active, Updating, Deleting, Deleted, Failed | |
| Page Size | string | Max items per page (optional) |
Returns: tool_result, gateways, count, truncated, success, error
OCI API Gateway: Update Gateway
oracle/apigateway/gateway_update · Action
Partially update an API Gateway — change only the display name you supply; a blank field is left unchanged. Returns a work-request id; poll Get Gateway until ACTIVE.
| Field | Type | Details | |
|---|---|---|---|
| Compartment OCID | string | Required | ocid1.compartment.oc1..aaaa… |
| Gateway OCID | string | Required | ocid1.apigateway.oc1..aaaa… — the gateway to update |
| Display Name | string | New name (leave blank to keep unchanged) |
Returns: tool_result, id, work_request_id, success, error
05Notes & Limitations
Behaviours and constraints worth knowing before you build with these nodes.
- Creating and updating gateways, APIs and deployments happens asynchronously: each call returns a work-request id and hands the new resource back in a CREATING or UPDATING state, so poll the matching Get action until its lifecycle state reads ACTIVE before you deploy or use it.
- A deployment's API Specification is Oracle's own routes-and-backends format that defines the routes, methods and backends a gateway serves, and it is a different document from the OpenAPI description you place in an API resource's Specification Content — the two fields are not interchangeable.
- Compartment OCID is required on every action, including Get, Delete and Change Compartment, even though those already identify the resource by its OCID.
- A gateway that still has deployments cannot be deleted — remove its deployments first, then delete the gateway.
- Gateways, APIs and deployments are regional, so the connection's Region must match the region the resource actually lives in, otherwise the action reports it as not found.
- The Display Name Filter on the list actions matches the display name exactly, so a partial or approximate name will not return the resource.