Bonitasoft

Bonitasoft License API

Handle the license information. This requires a platform session. Log in using the platform login service. This Web REST API is available in **Enterprise editions only**, since version 7.11.

GitHub OpenAPI

Operations 2

GET /API/platform/license Get the platform License #
GET /API/system/license/unusedid Get the current server license #

Documentation

📖
APIReference
https://api-documentation.ofelia.com/latest/
📖
Documentation
https://documentation.ofelia.com/bonita/latest/api/api-index

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bonitasoft/refs/heads/main/openapi/bonitasoft-license-api-openapi.yml

Other Resources

🔗
Postman
https://api-documentation.ofelia.com/latest/postman.json
🔗
SourceCode
https://github.com/bonitasoft/bonita-openapi

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/bonitasoft-license-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

bonitasoft-license-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  license:
    name: GPL-v2.0
    url: http://www.gnu.org/licenses/gpl-2.0.txt
  version: 1.0.9
  title: Bonita License API
  description: 'Download OpenAPI specification

    Download Postman collection


    The REST API lets you access the data with HTTP requests; it is useful when implementing rich web forms / pages for a good user experience.'
  x-logo:
    url: images/ofelia-logo.svg
    backgroundColor: '#19465f'
    altText: Bonita API
    href: /
servers:
- url: http://localhost:8080/bonita
  description: Sample url for a local development server.
security:
- bonita_auth: []
  bonita_token: []
- bearer_auth: []
tags:
- name: License
  x-displayName: License
  description: 'Handle the license information. This requires a platform session. Log in using the platform login service.

    This Web REST API is available in **Enterprise editions only**, since version 7.11.'
paths:
  /API/platform/license:
    get:
      tags:
      - License
      summary: Get the platform License
      deprecated: true
      description: 'Returns the current platform License.

        This requires a platform session. Log in using the platform login service.

        Warning: Since Bonita 10.2 (2024.3), this API is deprecated: use the API `GET /system/information` instead.'
      operationId: getPlatformLicense
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformLicense'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        5XX:
          $ref: '#/components/responses/ServerError'
  /API/system/license/unusedid:
    get:
      tags:
      - License
      summary: Get the current server license
      description: 'Returns license information for the current server. Requires to be logged in as a technical administrator.

        The same information can be retrieved as a user having simply the Admin profile through the API `GET /system/information`.'
      operationId: getLicense
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/License'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        5XX:
          $ref: '#/components/responses/ServerError'
components:
  responses:
    Unauthorized:
      description: Authorization information is missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Unauthorized
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Bad request
    NotFound:
      description: The resource for the specified ID was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Resource not found.
    Forbidden:
      description: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: Forbidden, The request contained valid data and was understood by the server, but the server is refusing action.
    ServerError:
      description: Unexpected error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            message: An unexpected error occured.
  schemas:
    Error:
      type: object
      additionalProperties: true
      properties:
        message:
          type: string
          description: The error message
        exception:
          type: string
          description: The exception type
        explanations:
          description: Further details on the error
          type: array
          items:
            type: string
    License:
      type: object
      description: Bonita license
      properties:
        owner:
          description: Owner of the license
          type: string
        edition:
          description: name of the Bonita edition enabled by the license (Community,...)
          type: string
        nb_cpu_cores:
          description: number of CPUs
          type: string
        expirationDate:
          description: 'License expiration date with format: `yyyy-MM-dd HH:mm:ss.SSS`'
          type: integer
          format: int64
    PlatformLicense:
      type: object
      description: ''
      properties:
        licenseStartDate:
          description: date with format `yyyy-MM-dd` - first day (included) of license file validity
          type: string
        duration:
          description: number of days for license file validity
          type: string
        licenseExpirationDate:
          description: date with format `yyyy-MM-dd` - last day (included) of license file validity
          type: string
        numberOfCPUCores:
          description: number of CPUs
          type: string
        edition:
          description: name of the Bonita edition enabled by the license
          type: string
        licenseMode:
          description: available mode enabled by the license
          type: string
        requestKey:
          description: 'request key to use to generate a new license on the customer portal

            If you have a subscription that specifies case-counter licensing, additional fields are present:

            '
          type: string
        subscriptionStartPeriod:
          description: date with format `yyyy-MM-dd` - first day (included) of current period for number of process instances provisioned
          type: string
        subscriptionEndPeriod:
          description: date with format `yyyy-MM-dd` - last day (included) of current period for number of process instances provisioned
          type: string
        caseCounterLimit:
          description: number of process instances provisioned for period between `subscriptionStartPeriod` and `subscriptionEndPeriod`
          type: integer
          format: int64
        caseCounter:
          description: number of consumed process instances for period between `subscriptionStartPeriod` and `subscriptionEndPeriod`
          type: integer
          format: int64
  securitySchemes:
    bonita_auth:
      name: JSESSIONID
      description: 'To call the REST API, you must first log on with a user registered in the Engine database. Please refer to the __[Login API](#operation/login)__ operations section.

        '
      type: apiKey
      in: cookie
    bonita_token:
      name: X-Bonita-API-Token
      description: 'To call the REST API, you must first log on with a user registered in the Engine database. Please refer to the __[Login API](#operation/login)__ operations section.

        '
      type: apiKey
      in: header
    bearer_auth:
      description: '![edition](https://img.shields.io/badge/edition-entreprise-blue)


        When Bonita runtime is configured for SSO with openID Connect it is possible To call the REST API directly with a Bearer Authorization header containing the access token.

        '
      type: http
      scheme: bearer
x-tagGroups:
- name: Authentication
  tags:
  - Authentication
  - PlatformAuthentication
- name: Application
  tags:
  - Application
  - ApplicationMenu
  - ApplicationPage
  - FormMapping
- name: BDM
  tags:
  - BDM
  - BusinessDataQuery
  - Business Data Operations
  - BDMAccessControl
  - DataRetention
- name: BPM
  tags:
  - Activity
  - ArchivedActivity
  - HumanTask
  - ManualTask
  - Task
  - UserTask
  - ArchivedHumanTask
  - ArchivedManualTask
  - ArchivedTask
  - ArchivedUserTask
  - ActivityVariable
  - ArchivedActivityVariable
  - ProcessInstanceVariable
  - ArchivedProcessInstanceVariable
  - ProcessInstanceDocument
  - ArchivedProcessInstanceDocument
  - Actor
  - ActorMember
  - ProcessInstance
  - ArchivedProcessInstance
  - ProcessInstanceInfo
  - ProcessInstanceComment
  - ArchivedProcessInstanceComment
  - Process
  - Diagram
  - ProcessInfo
  - ProcessParameter
  - ProcessResolutionProblem
  - ProcessSupervisor
  - ProcessConnectorDependency
  - ConnectorFailure
  - ConnectorInstance
  - ArchivedConnectorInstance
  - FlowNode
  - ArchivedFlowNode
  - Failure
  - ArchivedFailure
  - TimerEventTrigger
  - Message
  - Signal
  - Delegation
- name: Custom user info
  tags:
  - CustomUserDefinition
  - CustomUserValue
  - CustomUser
- name: Identity
  tags:
  - ProfessionalContactData
  - Group
  - Membership
  - Role
  - User
  - Authentication
- name: Platform
  tags:
  - PlatformAuthentication
  - Platform
  - License
  - Information
- name: Portal
  tags:
  - Page
  - Profile
  - ProfileEntry
  - ProfileMember
  - Theme
  - Upload
- name: System
  tags:
  - I18nlocale
  - I18ntranslation
  - Log
  - Session
  - Maintenance
- name: Other
  tags:
  - RestAPIextensions
- name: Upload
  tags:
  - FormFileUpload