OutSystems

OutSystems Private gateways API

Activate, deactivate, and manage private gateways.

GitHub OpenAPI

Operations 4

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /environments/{environmentKey}/private-gateway/activation Activate a stage's private gateway · Activates a private gateway #
Ask an LLM
“How do I turn on the Private Gateway for a stage?”
“What permission is needed to activate a private gateway?”
Tell an agent
Activate the private gateway in stage {environmentKey}.
Enable Private Gateway for environment {environmentKey}.
POST /environments/{environmentKey}/private-gateway/deactivation Deactivate a stage's private gateway · Deactivates a private gateway #
Ask an LLM
“Can I switch off the Private Gateway for a stage?”
“How do I disable private network connectivity for an environment?”
Tell an agent destructive · confirm first
Deactivate the private gateway in stage {environmentKey}.
Disable Private Gateway for environment {environmentKey}.
GET /environments/{environmentKey}/private-gateway Get a stage's private gateway status · Gets the private gateway status #
Ask an LLM
“Is the Private Gateway active in my stage?”
“Where can I check private gateway status for an environment?”
Tell an agent
Get the private gateway status of stage {environmentKey}.
Check whether Private Gateway is on in {environmentKey}.
POST /environments/{environmentKey}/private-gateway/key-rotation Rotate a private gateway key · Rotates the private gateway key #
Ask an LLM
“How do I rotate the key used by my Private Gateway?”
“Can I generate a fresh private gateway key for a stage?”
Tell an agent
Rotate the private gateway key in stage {environmentKey}.
Issue a new Private Gateway key for environment {environmentKey}.

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/openapi/outsystems-private-gateways-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-secure-gateway-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/outsystems/refs/heads/main/json-schema/outsystems-secure-gateway-token-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/outsystems:outsystems-private-gateways-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

outsystems-private-gateways-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Environment Configurations Private gateways API
  description: REST endpoints for managing environment (stage) configurations in ODC. Covers custom domains, IP filters, and Private Gateways, enabling you to automate the same configurations available in ODC Portal.
  version: v1
servers:
- url: https://ODC_PORTAL_DOMAIN/api/environment-configurations/v1
  description: Replace ODC_PORTAL_DOMAIN with the domain of your organization.
- url: https://{odc-portal-domain}/api/environment-configurations/v1
  description: Replace {odc-portal-domain} with the domain of your organization.
  variables:
    '{odc-portal-domain}':
      default: '{odc-portal-domain}'
      description: The domain of your organization
security:
- bearerAuth: []
tags:
- name: Private gateways
  description: Activate, deactivate, and manage private gateways.
paths:
  /environments/{environmentKey}/private-gateway/activation:
    post:
      tags:
      - Private gateways
      summary: Activates a private gateway
      description: 'Activates a private gateway.


        API Client needs the **Configuration management > Manage private gateways** permission for the target environment (stage).'
      operationId: PrivateGateway_Activation
      parameters:
      - name: environmentKey
        in: path
        description: The environment's key.
        required: true
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureGatewayToken'
      x-os-permissions: API Client needs the **Configuration management > Manage private gateways** permission for the target environment (stage).
  /environments/{environmentKey}/private-gateway/deactivation:
    post:
      tags:
      - Private gateways
      summary: Deactivates a private gateway
      description: 'Deactivates a private gateway.


        API Client needs the **Configuration management > Manage private gateways** permission for the target environment (stage).'
      operationId: PrivateGateway_Deactivation
      parameters:
      - name: environmentKey
        in: path
        description: The environment's key.
        required: true
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '202':
          description: Accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureGatewayToken'
      x-os-permissions: API Client needs the **Configuration management > Manage private gateways** permission for the target environment (stage).
  /environments/{environmentKey}/private-gateway:
    get:
      tags:
      - Private gateways
      summary: Gets the private gateway status
      description: 'Gets the private gateway status.


        API Client needs the **Configuration management > View configurations** permission for the target environment (stage).'
      operationId: PrivateGateway_Get
      parameters:
      - name: environmentKey
        in: path
        description: The environment's key.
        required: true
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureGateway'
      x-os-permissions: API Client needs the **Configuration management > View configurations** permission for the target environment (stage).
  /environments/{environmentKey}/private-gateway/key-rotation:
    post:
      tags:
      - Private gateways
      summary: Rotates the private gateway key
      description: 'Rotates the private gateway key.


        API Client needs the **Configuration management > Manage private gateways** permission for the target environment (stage).'
      operationId: PrivateGateway_KeyRotation
      parameters:
      - name: environmentKey
        in: path
        description: The environment's key.
        required: true
        schema:
          type: string
      responses:
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '429':
          description: Too Many Requests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SecureGatewayToken'
      x-os-permissions: API Client needs the **Configuration management > Manage private gateways** permission for the target environment (stage).
components:
  schemas:
    ProblemDetails:
      type: object
      properties:
        type:
          type:
          - string
          - 'null'
          description: A URI reference that identifies the problem type.
        title:
          type:
          - string
          - 'null'
          description: A short, human-readable summary of the problem.
        status:
          type:
          - integer
          - 'null'
          description: The HTTP status code applicable to the problem.
          format: int32
        detail:
          type:
          - string
          - 'null'
          description: A human-readable explanation of the error.
        instance:
          type:
          - string
          - 'null'
          description: A URI that identifies the specific occurrence of the problem.
        traceId:
          type: string
          description: This field helps OutSystems support track and investigate specific error occurrences. Providing this identifier when reporting an issue allows for more precise and faster troubleshooting.
        errorCode:
          type: string
          description: This error code serves the purpose to communicate with OutSystems Support and help diagnose errors.
      description: A standardized error response as per RFC 7807 (Problem Details for HTTP APIs).
    SecureGateway:
      type: object
      properties:
        serverActive:
          type: boolean
          description: Indicates if the private gateway service is active.
        serverHealth:
          allOf:
          - $ref: '#/components/schemas/ServerHealth'
          description: Indicates the health status of the private gateway.
        isDeactivating:
          type: boolean
          description: Indicates if the private gateway is in the process of deactivating.
        url:
          type:
          - string
          - 'null'
          description: The url value to connect to the private gateway.
      additionalProperties: false
    SecureGatewayToken:
      type: object
      properties:
        authToken:
          type:
          - string
          - 'null'
          description: The authentication token for the private gateway.
      additionalProperties: false
    ServerHealth:
      enum:
      - Healthy
      - Unhealthy
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      description: Enter your bearer token in the format 'Bearer {token}'
      scheme: bearer
      bearerFormat: JWT