ForgeRock Routes API

openapi: 3.2.0
info:
  title: ForgeRock Identity Gateway Routes API
  description: REST API for ForgeRock Identity Gateway (IG) providing route management, monitoring, and administration. IG acts as a reverse proxy that enforces security and access control for web applications, APIs, and microservices, integrating them with the ForgeRock Identity Platform.
  version: 7.3.0
  contact:
    name: ForgeRock
    url: https://www.forgerock.com
  license:
    name: Proprietary
    url: https://www.forgerock.com/terms
  x-provider: forgerock
  x-api: identity-gateway
servers:
- url: https://{deployment}/ig
  description: ForgeRock Identity Gateway server
  variables:
    deployment:
      default: ig.example.com
      description: The IG deployment hostname
security:
- bearerAuth: []
tags:
- name: Routes
  description: Manage IG route configurations
paths:
  /openig/api/system/objects/router-handler/routes:
    get:
      operationId: listRoutes
      summary: ForgeRock List routes
      description: List all routes currently loaded in the IG router, including their names, conditions, and status.
      tags:
      - Routes
      parameters:
      - name: _queryFilter
        in: query
        description: CREST query filter for routes
        schema:
          type: string
      responses:
        '200':
          description: List of routes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RouteList'
    post:
      operationId: createRoute
      summary: ForgeRock Create a route
      description: Deploy a new route configuration to the IG router. The route is immediately active upon creation.
      tags:
      - Routes
      requestBody:
        required: true
        description: The route configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
      responses:
        '201':
          description: Route created and deployed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '400':
          description: Invalid route configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /openig/api/system/objects/router-handler/routes/{routeId}:
    get:
      operationId: getRoute
      summary: ForgeRock Get a route
      description: Retrieve a specific route configuration by its identifier.
      tags:
      - Routes
      parameters:
      - name: routeId
        in: path
        required: true
        description: The route identifier
        schema:
          type: string
      responses:
        '200':
          description: The route configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '404':
          description: Route not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    put:
      operationId: updateRoute
      summary: ForgeRock Update a route
      description: Replace a route configuration. The updated route is immediately active.
      tags:
      - Routes
      parameters:
      - name: routeId
        in: path
        required: true
        description: The route identifier
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Route'
      responses:
        '200':
          description: Route updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '404':
          description: Route not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
    delete:
      operationId: deleteRoute
      summary: ForgeRock Delete a route
      description: Remove a route from the IG router. The route is immediately deactivated.
      tags:
      - Routes
      parameters:
      - name: routeId
        in: path
        required: true
        description: The route identifier
        schema:
          type: string
      responses:
        '200':
          description: Route deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Route'
        '404':
          description: Route not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    Route:
      type: object
      description: An IG route configuration
      properties:
        _id:
          type: string
          description: Route identifier (derived from route name)
        name:
          type: string
          description: Human-readable route name
        condition:
          type: string
          description: Expression that determines when this route handles a request (e.g., "${find(request.uri.path, '/myapp')}")
        handler:
          description: The handler that processes requests matching this route
          oneOf:
          - type: string
            description: Reference to a named handler
          - type: object
            description: Inline handler configuration
            properties:
              type:
                type: string
                description: Handler type name
              config:
                type: object
                description: Handler configuration
        baseURI:
          type: string
          format: uri
          description: Base URI for the protected application
        heap:
          type: array
          description: Heap objects declared for this route
          items:
            type: object
            properties:
              name:
                type: string
              type:
                type: string
              config:
                type: object
        auditService:
          type: object
          description: Audit service configuration for this route
    ErrorResponse:
      type: object
      description: Standard error response
      properties:
        code:
          type: integer
        reason:
          type: string
        message:
          type: string
    RouteList:
      type: object
      properties:
        result:
          type: array
          items:
            $ref: '#/components/schemas/Route'
        resultCount:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Access token for administrative operations