Timeplus API

Timeplus API as documented publicly: 26 operations. Contract generated from the documentation by API Evangelist (2026-11-16); not the provider's own document.

GitHub OpenAPI

Operations 26

GET / GET / #
GET /2.4 GET /2.4 #
GET /2.5 GET /2.5 #
GET /2.7 GET /2.7 #
GET /2.8 GET /2.8 #
GET /3.0 GET /3.0 #
GET /apps List installed apps #
POST /apps/install Install from a file or URL #
DELETE /apps/{appId} Delete an app #
GET /apps/{appId} Get an app #
GET /apps/{appId}/config Read configuration #
GET /apps/{appId}/events List lifecycle events #
POST /apps/{appId}/upgrade Upgrade an app #
POST /connectors POST /connectors #
POST /default/api/v1beta2/apps/install POST /default/api/v1beta2/apps/install #
GET /events.csv GET /events.csv #
GET /jq GET /jq #
GET /methodologies/killer/web-readiness GET /methodologies/killer/web-readiness #
GET /oss GET /oss #
POST /proton/v1/ingest/streams/foo POST /proton/v1/ingest/streams/foo #
POST /proton/v1/query POST /proton/v1/query #
GET /sp-demo GET /sp-demo #
POST /tenant/api/v1beta2/queries Query API with Server-sent Events (SSE) #
GET /timeplus-io/proton-java-driver GET /timeplus-io/proton-java-driver #
GET /timeplusd/info GET /timeplusd/info #
POST /ws123456/api/v1beta2/streams/foo/ingest POST /ws123456/api/v1beta2/streams/foo/ingest #

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/timeplus:timeplus-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

timeplus-openapi-generated.yml Raw ↑
openapi: 3.1.0
info:
  title: Timeplus API
  version: '2026-11-16'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-16: 26 operation(s) read from 19 public documentation page(s) (each
    operation names its page in x-source). This is not the provider''s published contract; Timeplus has published no machine-readable contract
    that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 18
    documentation: 8
    pages-with-code: 17
    pages-read: 19
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-16'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://docs.timeplus.com/ingest-api
  - https://docs.timeplus.com/proton-ingest-api
  - https://docs.timeplus.com/quickstart
  - https://docs.timeplus.com/proton
  - https://docs.timeplus.com/timeplusd-client
  - https://docs.timeplus.com/query-api
  - https://docs.timeplus.com/redpanda-connect
  - https://docs.timeplus.com/app-framework
  - https://docs.timeplus.com/bare-metal-install
  - https://docs.timeplus.com/enterprise-v2.4
  - https://docs.timeplus.com/pulsar-sink
  - https://docs.timeplus.com/enterprise-v2.5
  - https://docs.timeplus.com/enterprise-v2.7
  - https://docs.timeplus.com/app-framework-build
  - https://docs.timeplus.com/agentguard-installation
  - https://docs.timeplus.com/k8s-helm
  - https://docs.timeplus.com/tutorial-sql-etl-mysql-to-ch
  - https://docs.timeplus.com/enterprise-v3.0
  - https://docs.timeplus.com/enterprise-v2.8
servers:
- url: https://install.timeplus.com
paths:
  /:
    get:
      operationId: get
      tags:
      - Api
      summary: GET /
      x-source: https://docs.timeplus.com/quickstart
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com | sh \n This script will download the latest package (based on your operating system and CPU\
          \ architecture) to the current folder, uncompress the package and start the Timeplus Enterprise server. You can also download the package\
          \ manually from here , uncompress it and start the server via timeplus/bin/timeplus start . \n Step 2: Setup the user account ​ \n Access\
          \ the "
  /2.4:
    get:
      operationId: get_2_4
      tags:
      - '2'
      summary: GET /2.4
      x-source: https://docs.timeplus.com/enterprise-v2.4
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/2.4 | sh Downloads \n For Kubernetes users: helm install timeplus/timeplus-enterprise --version\
          \ v3.0.12 .. \n For Docker users (not for production): docker run -p 8000:8000 docker.timeplus.com/timeplus/timeplus-enterprise:2.4.29\
          \ \n Component versions: \n timeplusd 2.3.37 \n timeplus_appserver 1.4.44 \n timeplus_web 1.4.33 \n timeplus_connector 1.5.5 \n timeplus\
          \ cli 1.0.19"
  /2.5:
    get:
      operationId: get_2_5
      tags:
      - '2'
      summary: GET /2.5
      x-source: https://docs.timeplus.com/enterprise-v2.5
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/2.5 | sh Downloads \n For Kubernetes users: helm install timeplus/timeplus-enterprise --version\
          \ v4.0.13 .. \n For Docker users (not for production): docker run -p 8000:8000 docker.timeplus.com/timeplus/timeplus-enterprise:2.5.14\
          \ \n Component versions: \n timeplusd 2.4.31 \n timeplus_web 2.0.6 \n timeplus_appserver 2.0.9 \n timeplus_connector 2.0.3 \n timeplus\
          \ cli 1.2.8 \n "
  /2.7:
    get:
      operationId: get_2_7
      tags:
      - '2'
      summary: GET /2.7
      x-source: https://docs.timeplus.com/enterprise-v2.7
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/2.7 | sh Downloads \n For Kubernetes users: helm install timeplus/timeplus-enterprise --version\
          \ v6.0.18 .. \n For Docker users (not recommended for production): docker run -p 8000:8000 docker.timeplus.com/timeplus/timeplus-enterprise:2.7.9\
          \ \n Component versions: \n timeplusd 2.7.48 \n timeplus_web 2.2.12 \n timeplus_appserver 2.2.13 \n timeplus_connector 2.2.8 \n timeplus"
  /2.8:
    get:
      operationId: get_2_8
      tags:
      - '2'
      summary: GET /2.8
      x-source: https://docs.timeplus.com/bare-metal-install
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/2.8 | sh \n Replace 2.8 with the desired version number. \n Manual Install ​ \n You can also\
          \ download packages manually with the following links: \n Linux ( Intel/AMD chip , ARM chip ) \n MacOS ( Intel chip , Apple Silicon\
          \ chip ) \n Windows (Please install via Docker ) \n After you download the package, put it in a desired folder, uncompress the file,\
          \ and you can run Tim"
  /3.0:
    get:
      operationId: get_3_0
      tags:
      - '3'
      summary: GET /3.0
      x-source: https://docs.timeplus.com/enterprise-v3.0
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/3.0 | sh Downloads \n For Docker users (not recommended for production): docker run -p 8000:8000\
          \ docker.timeplus.com/timeplus/timeplus-enterprise:3.0.2 \n For Kubernetes users: helm install timeplus/timeplus-enterprise --version\
          \ v10.0.9 \n Component versions: \n timeplusd 3.0.2 \n timeplus_appserver 3.0.21 \n timeplus_connector 3.0.0 \n timeplus cli 3.0.0 \n\
          \ timeplus byoc"
  /apps:
    get:
      operationId: get_apps
      tags:
      - Apps
      summary: List installed apps
      x-source: https://docs.timeplus.com/app-framework
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /apps/install:
    post:
      operationId: post_apps_install
      tags:
      - Apps
      summary: Install from a file or URL
      x-source: https://docs.timeplus.com/app-framework
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAppsInstallRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /apps/{appId}:
    delete:
      operationId: delete_apps_appId
      tags:
      - Apps
      summary: Delete an app
      x-source: https://docs.timeplus.com/app-framework
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      - name: preserve_data
        in: query
        required: false
        schema:
          type: boolean
        description: If true, keep the app's streams and external tables
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
    get:
      operationId: get_apps_appId
      tags:
      - Apps
      summary: Get an app
      x-source: https://docs.timeplus.com/app-framework
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /apps/{appId}/config:
    get:
      operationId: get_apps_appId_config
      tags:
      - Apps
      summary: Read configuration
      x-source: https://docs.timeplus.com/app-framework
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /apps/{appId}/events:
    get:
      operationId: get_apps_appId_events
      tags:
      - Apps
      summary: List lifecycle events
      x-source: https://docs.timeplus.com/app-framework
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /apps/{appId}/upgrade:
    post:
      operationId: post_apps_appId_upgrade
      tags:
      - Apps
      summary: Upgrade an app
      x-source: https://docs.timeplus.com/app-framework
      parameters:
      - name: appId
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostAppsAppidUpgradeRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /connectors:
    post:
      operationId: post_connectors
      tags:
      - Connectors
      summary: POST /connectors
      x-source: https://docs.timeplus.com/tutorial-sql-etl-mysql-to-ch
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostConnectorsRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl --request POST \ --url http://localhost:8083/connectors \ --header ''Content-Type: application/json'' \ --data ''{ "name":
          "inventory-connector", "config": { "connector.class": "io.debezium.connector.mysql.MySqlConnector", "tasks.max": "1", "database.hostname":
          "mysql", "database.port": "3306", "database.user": "debezium", "database.password": "dbz", "database.server.id": "184054", "topic.prefix'
  /default/api/v1beta2/apps/install:
    post:
      operationId: post_default_api_v1beta2_apps_install
      tags:
      - Default
      summary: POST /default/api/v1beta2/apps/install
      x-source: https://docs.timeplus.com/app-framework
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostDefaultApiV1Beta2AppsInstallRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -X POST http://localhost:8000/default/api/v1beta2/apps/install \\ -F \"file=@market-data.tpapp\" \\ -F 'config[product_ids]=[\"\
          BTC-USD\",\"ETH-USD\"]' # Install from a URL curl -X POST http://localhost:8000/default/api/v1beta2/apps/install \\ -H \"Content-Type:\
          \ application/json\" \\ -d '{\"url\": \"https://github.com/timeplus-io/apps/releases/latest/download/cep.tpapp\"}' \n See the REST API\
          \ reference for req"
  /events.csv:
    get:
      operationId: get_events_csv
      tags:
      - Events
      summary: GET /events.csv
      x-source: https://docs.timeplus.com/timeplusd-client
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl -sS https://example.com/events.csv \ | timeplusd client -q "INSERT INTO events FORMAT CSVWithNames" # server-to-server
          copy — Native is the fastest binary format timeplusd client -h src -q "SELECT * FROM events FORMAT Native" \ | timeplusd client -h dst
          -q "INSERT INTO events FORMAT Native" # tolerate up to 10 malformed rows (or use --input_format_allow_errors_ratio=R) timeplusd client
          --inpu'
  /jq:
    get:
      operationId: get_jq
      tags:
      - Jq
      summary: GET /jq
      x-source: https://docs.timeplus.com/k8s-helm
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -sS https://webi.sh/jq | sh; \\ to install jq \n For AWS CLI, you can just follow https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html\
          \ . Instead of using sudo ./aws/install to install, you can run ./aws/install -i /usr/local/aws-cli -b /usr/local/bin to install it\
          \ to a local folder. \n Configuration Guide ​ \n You may want to customize the configurations of Timeplus Appse"
  /methodologies/killer/web-readiness:
    get:
      operationId: get_methodologies_killer_web_readiness
      tags:
      - Methodologies
      summary: GET /methodologies/killer/web-readiness
      x-source: https://docs.timeplus.com/pulsar-sink
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl / library compatibility issues in the Pulsar client on macOS ARM.\nTo use Pulsar external streams from macOS, please run\
          \ Timeplus in a Linux container instead, for example: docker run -d --pull always \\ -p 8123:8123 -p 8463:8463 \\ --name proton \\ d.timeplus.com/timeplus-io/proton:latest\
          \ Pulsar external streams are supported when Timeplus runs on Linux (bare metal, VM, or container). \n Create P"
  /oss:
    get:
      operationId: get_oss
      tags:
      - Oss
      summary: GET /oss
      x-source: https://docs.timeplus.com/proton
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/oss | sh \n Once the proton binary is available, you can run Timeplus Proton in different\
          \ modes: \n Local Mode. You run proton local to start it for fast processing on local and remote files using SQL without having to install\
          \ a full server \n Config-less Mode. You run proton server to start the server and put the config/logs/data in the current folder proton-data\
          \ . "
  /proton/v1/ingest/streams/foo:
    post:
      operationId: post_proton_v1_ingest_streams_foo
      tags:
      - Proton
      summary: POST /proton/v1/ingest/streams/foo
      x-source: https://docs.timeplus.com/proton-ingest-api
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostProtonV1IngestStreamsFooRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Python Java const http = require ( "http" ) ; const options = { hostname : "localhost" , path : "/proton/v1/ingest/streams/foo"
          , method : "POST" } ; const data = ` { "columns": ["id","name"], "data": [ [1,"hello"], [2,"world"] ] } ` ; const request = http . request
          ( options , ( resp ) => { } ) ; request . on ( "error" , ( error ) => { console . error ( error ) ; } ) ; request . write ( data'
  /proton/v1/query:
    post:
      operationId: post_proton_v1_query
      tags:
      - Proton
      summary: POST /proton/v1/query
      x-source: https://docs.timeplus.com/agentguard-installation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostProtonV1QueryRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl -s -u \"proton:\" -X POST http://localhost:3218/proton/v1/query \\ -H 'Content-Type: application/json' \\ -d '{\"query\"\
          :\"SELECT hook_name, agent_type, agent_id, event_time FROM table(ag.agentguard_hook_events) ORDER BY event_time DESC LIMIT 10\"}' \n\
          \ You should see rows with agent_type set to claudecode , openclaw or hermes . \n Check events are being normalized ​ \n SELECT agent_type\
          \ , event_type , c"
  /sp-demo:
    get:
      operationId: get_sp_demo
      tags:
      - Sp Demo
      summary: GET /sp-demo
      x-source: https://docs.timeplus.com/bare-metal-install
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl https://install.timeplus.com/sp-demo | sh \n For Windows users, you can download the package with Docker Compose file and\
          \ bootstrap scripts here . \n Access the Timeplus demo kit web console at https://localhost:8000 . \n This stack demonstrates how to\
          \ run streaming ETL, getting data from Kafka API, applying filter or aggregation, then sending to another Kafka topic or ClickHouse\
          \ tables. For mor"
  /tenant/api/v1beta2/queries:
    post:
      operationId: post_tenant_api_v1beta2_queries
      tags:
      - Tenant
      summary: Query API with Server-sent Events (SSE)
      x-source: https://docs.timeplus.com/query-api
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTenantApiV1Beta2QueriesResponse'
      x-evidence:
        kind: documentation
  /timeplus-io/proton-java-driver:
    get:
      operationId: get_timeplus_io_proton_java_driver
      tags:
      - Timeplus Io
      summary: GET /timeplus-io/proton-java-driver
      x-source: https://docs.timeplus.com/proton
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl localhost:3218/proton/info \n If the command returns build information, Proton has been successfully deployed \U0001F389\
          . \n \U0001F50E Usage ​ \n SQL is the main interface. You can start a new terminal window with proton client to start the SQL shell.\
          \ \n info You can also integrate Timeplus Proton with Python/Java/Go SDK, REST API, or BI plugins. Please check Integration . \n In\
          \ the proton client , you can write S"
  /timeplusd/info:
    get:
      operationId: get_timeplusd_info
      tags:
      - Timeplusd
      summary: GET /timeplusd/info
      x-source: https://docs.timeplus.com/k8s-helm
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: curl http://timeplus.local/timeplusd/info - curl http://timeplus.local/timeplusd/v1/ddl/streams ingress.timeplusd.httpSnapshotPath
          string "/snapshot" * update the httpSnapshotPath to be / and use different domain for appserver and timeplusd ingress prometheus_metrics.enabled
          bool false prometheus_metrics.remote_write_endpoint string "http://timeplus-prometheus:80" prometheus_metrics.vector.image s
  /ws123456/api/v1beta2/streams/foo/ingest:
    post:
      operationId: post_ws123456_api_v1beta2_streams_foo_ingest
      tags:
      - Ws123456
      summary: POST /ws123456/api/v1beta2/streams/foo/ingest
      x-source: https://docs.timeplus.com/ingest-api
      parameters:
      - name: format
        in: query
        required: false
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostWs123456ApiV1Beta2StreamsFooIngestRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl Python Java const https = require ( "https" ) ; const options = { hostname : "host" , path : "/ws123456/api/v1beta2/streams/foo/ingest?format=streaming"
          , method : "POST" , headers : { "Content-Type" : "application/x-ndjson" , "X-Api-Key" : "<your_api_key>" , } , } ; const data = ` {"key1":
          "value11", "key2": "value12"} {"key1": "value21", "key2": "value22"} ` ; const request = https . reques'
components:
  schemas:
    PostAppsInstallRequest:
      type: object
      properties:
        file:
          type: string
          description: Multipart file containing a .tpapp package
        url:
          type: string
          description: URL to a .tpapp package
        config:
          type: object
          description: Configuration values for the app
    PostAppsAppidUpgradeRequest:
      type: object
      properties:
        url:
          type: string
          description: URL to a .tpapp package for upgrade
        config:
          type: object
          description: Configuration values for the upgrade
    PostConnectorsRequest:
      type: object
      properties:
        name:
          type: string
        config:
          type: object
          properties:
            connector.class:
              type: string
            tasks.max:
              type: string
            database.hostname:
              type: string
            database.port:
              type: string
            database.user:
              type: string
            database.password:
              type: string
            database.server.id:
              type: string
            topic.prefix:
              type: string
            database.include.list:
              type: string
            schema.history.internal.kafka.bootstrap.servers:
              type: string
            schema.history.internal.kafka.topic:
              type: string
    PostDefaultApiV1Beta2AppsInstallRequest:
      type: object
      properties:
        url:
          type: string
    PostProtonV1IngestStreamsFooRequest:
      type: object
      properties:
        columns:
          type: array
          items:
            type: string
        data:
          type: array
          items:
            type: array
            items:
              type: integer
    PostProtonV1QueryRequest:
      type: object
      properties:
        query:
          type: string
    PostTenantApiV1Beta2QueriesResponse:
      type: object
      properties:
        event:
          type: string
          description: Type of SSE event, e.g., "query", "metric", or omitted for query results
        data:
          type: object
          description: Payload of the event; for "query" it contains query metadata, for "metric" it contains query statistics, and for result
            events it is an array of rows
    PostWs123456ApiV1Beta2StreamsFooIngestRequest:
      type: object
      properties:
        key1:
          type: string
        key2:
          type: string
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-Api-Key
security:
- apiKey: []
tags:
- name: '2'
- name: '3'
- name: Api
- name: Apps
- name: Connectors
- name: Default
- name: Events
- name: Jq
- name: Methodologies
- name: Oss
- name: Proton
- name: Sp Demo
- name: Tenant
- name: Timeplus Io
- name: Timeplusd
- name: Ws123456