Flopsar Documentation
5.0
5.0
  • What is Flopsar?
  • Overview
    • Supported Platforms and Requirements
  • Administrator guide
    • Architecture Fundamentals
    • Agent
    • Server
    • Installation
      • Upgrade
    • Managing Users
    • Managing a License
    • Logging
  • User guide
    • Profiles
      • Instrumentation
    • Data Browser
    • Data Analysis
    • Metrics
    • Glossary
    • FAQ
  • Developer guide
    • Agent Extensions
    • Server API
Powered by GitBook
On this page
  1. Developer guide

Server API

Last updated 2 years ago

  • POSTAuthenticates a user to the server
  • GETRetrieves applications
  • POSTFinds symbols by a pattern
  • POSTRetrieves calls satisfying the specified conditions

Retrieves applications

get
Authorizations
Responses
200
A list of all applications
application/json
Responsestring[]
204
No applications found
500
Unexpected error
application/problem+json
get
GET /api/apps HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
[
  "text"
]

Authenticates a user to the server

post
Authorizations
Body
usernamestringRequired
passwordstring · passwordRequired
Responses
200
User authenticated successfully.
application/json
Responsestring
400
Invalid request data.
application/problem+json
401
Invalid password or the user is locked.
application/problem+json
500
Unexpected error
application/problem+json
post
POST /api/auth/login HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "username": "text",
  "password": "password"
}
text

Finds symbols by a pattern

post
Authorizations
Path parameters
kindstring · enumRequired

Symbol kind. It must be one of: cls, mth, thr or key.

Possible values:
Body
patternstringRequired
Responses
200
A list of matched symbols
application/json
Responsestring[]
204
No symbols found
400
Invalid request
application/problem+json
500
Unexpected error
application/problem+json
post
POST /api/data/symbols/{kind} HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "pattern": "text"
}
[
  "text"
]

Retrieves calls satisfying the specified conditions

post
Authorizations
Body
fromstring · date-timeRequired

The beginning of the time range

thrustring · date-timeRequired

The end of the time range

applicationstringOptional

Application name

threadstringOptional

Thread name

query_idstringOptional

Previous query id

Responses
200
A list of calls
application/json
204
No calls found
400
Invalid request
application/problem+json
500
Unexpected error
application/problem+json
post
POST /api/data/calls HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 167

{
  "from": "2025-05-09T04:08:56.709Z",
  "thru": "2025-05-09T04:08:56.709Z",
  "application": "text",
  "thread": "text",
  "arguments": {
    "value": "text",
    "kind": "text"
  },
  "query_id": "text"
}
[
  {
    "cid": "text",
    "app": "text",
    "clazz": "text",
    "method": "text",
    "thread": "text",
    "duration": {
      "secs": 1,
      "nanos": 1
    },
    "cpu_time": {
      "secs": 1,
      "nanos": 1
    },
    "tstamp": "2025-05-09T04:08:56.709Z",
    "count": 1,
    "exc_class": "text",
    "exc_trace": "text",
    "parameters": [
      {
        "key": "text",
        "value": "text"
      }
    ]
  }
]