FINOS

FINOS System API

The System API from FINOS — 7 operation(s) for system.

Documentation GitHub OpenAPI

Operations 7

GET /v3/health Checks health status #

GET /v3/health/extended Checks health status of services and users #

GET /v1/admin/system/features/list Get the full set of Symphony features available for this pod

GET /v1/admin/system/protocols/list Get a list of all URI protocols supported by the company (pod)

GET /v2/system/protocols Get a list of URI protocols supported by the company (pod)

POST /v1/admin/system/protocols Add an entry to URI protocols supported by the company (pod)

DELETE /v1/admin/system/protocols/{scheme} Remove an entry from URI protocols supported by the company (pod)

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/finos-system-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

openapi: 3.2.0
info:
  title: Finos System API
  version: '1.0'
  description: 'Operations tagged System across 2 of this provider''s published API definitions: finos-symphony-agent-api-openapi.yml, finos-symphony-pod-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: youragentURL.symphony.com/agent
- url: https://yourpodURL.symphony.com/pod
tags:
- name: System
paths:
  /v3/health:
    get:
      tags:
      - System
      summary: Checks health status
      description: '_Available on Agent 2.57.0 and above._


        Returns the connectivity status of your Agent server. If your Agent server is started and running, the status value will be `UP`

        '
      operationId: v3Health
      responses:
        200:
          description: Agent application is alive.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3Health'
              example:
                status: UP
    servers:
    - url: youragentURL.symphony.com/agent
  /v3/health/extended:
    get:
      tags:
      - System
      summary: Checks health status of services and users
      description: '_Available on Agent 2.57.0 and above._


        Returns the connectivity status of the Agent services (**pod**, **key manager** and **datafeed**) as well as users

        connectivity (**agentservice** and **ceservice**).


        The global status will be set to `DOWN` if at least one of the sub-status is also `DOWN`.

        '
      operationId: v3ExtendedHealth
      responses:
        200:
          description: Agent is healthy, all components are `UP`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3Health'
              example:
                services:
                  pod:
                    status: UP
                    version: 24.1.1-411-36efd5b
                  key_manager:
                    status: UP
                    version: 24.1.1-411-36efd5b
                  datafeed:
                    status: UP
                    version: 2.11.6
                status: UP
                users:
                  agentservice:
                    authType: RSA
                    status: UP
                  ceservice:
                    authType: RSA
                    status: UP
                version: 24.3.2-778
        503:
          description: Agent is unhealthy, some components are `DOWN`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V3Health'
              example:
                services:
                  pod:
                    status: UP
                    version: 24.1.1-411-36efd5b
                  key_manager:
                    status: DOWN
                    version: 24.1.1-411-36efd5b
                  datafeed:
                    status: UP
                    version: 2.11.6
                status: UP
                users:
                  agentservice:
                    authType: RSA
                    status: UP
                  ceservice:
                    authType: RSA
                    status: UP
                version: 24.3.2-778
    servers:
    - url: youragentURL.symphony.com/agent
  /v1/admin/system/features/list:
    get:
      summary: Get the full set of Symphony features available for this pod
      parameters:
      - name: sessionToken
        description: Session authentication token.
        in: header
        required: true
        schema:
          type: string
      tags:
      - System
      responses:
        '200':
          description: The list of valid feature entitlement names.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringList'
              example:
              - postReadEnabled
              - canCreatePublicRoom
              - canJoinMultiLateralRoom
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 400
                message: // Client error, see response body for further details.
        '401':
          description: 'Unauthorized: Invalid session token.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 401
                message: Invalid session
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 403
                message: The user lacks the required entitlement to perform this operation
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 500
                message: // Server error, see response body for further details.
    servers:
    - url: https://yourpodURL.symphony.com/pod
  /v1/admin/system/protocols/list:
    get:
      summary: Get a list of all URI protocols supported by the company (pod)
      parameters:
      - name: sessionToken
        description: Session authentication token.
        in: header
        required: true
        schema:
          type: string
      tags:
      - System
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringList'
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 400
                message: // Client error, see response body for further details.
        '401':
          description: 'Unauthorized: Invalid session token.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 401
                message: Invalid session
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 403
                message: The user lacks the required entitlement to perform this operation
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 500
                message: // Server error, see response body for further details.
    servers:
    - url: https://yourpodURL.symphony.com/pod
  /v2/system/protocols:
    get:
      summary: Get a list of URI protocols supported by the company (pod)
      parameters:
      - name: sessionToken
        description: Session authentication token.
        in: header
        required: true
        schema:
          type: string
      - name: skip
        description: Number of items to skip. Default is 0.
        in: query
        required: false
        schema:
          type: integer
      - name: limit
        description: Maximum number of items to return. Default is 100 and not to exceed 1000.
        in: query
        required: false
        schema:
          type: integer
      tags:
      - System
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StringList'
              example:
              - ftp
              - mailto
              - skype
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 400
                message: // Client error, see response body for further details.
        '401':
          description: 'Unauthorized: Invalid session token.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 401
                message: Invalid session
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 403
                message: The user lacks the required entitlement to perform this operation
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 500
                message: // Server error, see response body for further details.
    servers:
    - url: https://yourpodURL.symphony.com/pod
  /v1/admin/system/protocols:
    post:
      summary: Add an entry to URI protocols supported by the company (pod)
      parameters:
      - name: sessionToken
        description: Session authentication token.
        in: header
        required: true
        schema:
          type: string
      tags:
      - System
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Protocol'
              example:
                scheme: skype
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 400
                message: // Client error, see response body for further details.
        '401':
          description: 'Unauthorized: Invalid session token.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 401
                message: Invalid session
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 403
                message: The user lacks the required entitlement to perform this operation
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 500
                message: // Server error, see response body for further details.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Protocol'
        description: the protocol to add
        required: true
    servers:
    - url: https://yourpodURL.symphony.com/pod
  /v1/admin/system/protocols/{scheme}:
    delete:
      summary: Remove an entry from URI protocols supported by the company (pod)
      parameters:
      - name: sessionToken
        description: Session authentication token.
        in: header
        required: true
        schema:
          type: string
      - name: scheme
        required: true
        description: the scheme to remove from the protocols list
        in: path
        schema:
          type: string
      tags:
      - System
      responses:
        '204':
          description: 204 response
        '400':
          description: Client error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 400
                message: // Client error, see response body for further details.
        '401':
          description: 'Unauthorized: Invalid session token.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 401
                message: Invalid session
        '403':
          description: 'Forbidden: Caller lacks necessary entitlement.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 403
                message: The user lacks the required entitlement to perform this operation
        '500':
          description: Server error, see response body for further details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                code: 500
                message: // Server error, see response body for further details.
    servers:
    - url: https://yourpodURL.symphony.com/pod
components:
  schemas:
    V3HealthStatus:
      type: string
      description: Application health status.
      enum:
      - UP
      - DOWN
    V3HealthAuthType:
      type: string
      description: Type of authentication
      enum:
      - RSA
      - CERT
    V3HealthComponent:
      type: object
      properties:
        authType:
          $ref: '#/components/schemas/V3HealthAuthType'
        message:
          type: string
          description: An error message, if the component status is DOWN
        status:
          $ref: '#/components/schemas/V3HealthStatus'
        version:
          type: string
          description: Optional component version
    V3Health:
      type: object
      properties:
        services:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/V3HealthComponent'
        status:
          $ref: '#/components/schemas/V3HealthStatus'
        users:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/V3HealthComponent'
        version:
          type: string
          description: Required Agent verison
    Protocol:
      type: object
      required:
      - scheme
      properties:
        scheme:
          type: string
          description: 'URI protocol scheme (example: http, https, ftp)'
          example: skype
    Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
          example: 401
        message:
          type: string
          example: Invalid session
    StringList:
      type: array
      items:
        type: string
      example:
      - ftp
      - mailto
      - fdsup
      - skype
x-refined-from:
- finos-symphony-agent-api-openapi.yml
- finos-symphony-pod-api-openapi.yml