• auth
  • postChange Password
  • postAuthenticate
  • getFetch current profile
• backup
  • getBackup Authentication Database
  • getBackup Configuration
  • getBackup Logs Database
  • postRestore Authentication Database
  • postRestore Configuration
  • postRestore Logs Database
• forwarders
  • getList Forwarders
  • getGet Forwarder
  • putSave Forwarder
  • delDelete Forwarder
• pipelines
  • getList Pipelines
  • getGet Pipeline
  • putSave Pipeline
  • delDelete Pipeline
  • postIngest Log
• acls
  • getList Roles
  • putSave Role
  • delDelete Role
  • postCreate Token
  • getList Tokens
  • delDelete Token
  • getList Users
  • putSave User
  • delDelete User
• streams
  • getList Streams
  • getGet Stream Configuration
  • putConfigure Stream
  • delPurge Stream
  • getList Stream Fields
  • getQuery Stream
  • getWatch Logs
• tests
  • postTest Forwarder
  • postTest Transformer
• transformers
  • getList Transformers
  • getGet Transformer
  • putSave Transformer
  • delDelete Transformer

API docs by Redocly

Flowg API

auth

Change Password

Change Password of current user

Authorizations:

jwtAuthpatAuth

Request Body schema: application/json

new_password	string
old_password	string

Responses

https://link-society.github.io/api/v1/auth/change-password

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Authenticate

Create new Session cookie

Request Body schema: application/json

password	string
username	string

Responses

https://link-society.github.io/api/v1/auth/login

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401

Content type

application/json

{

• "success": true,
• "token": "string"

}

Fetch current profile

Fetch the profile of the currently authenticated user

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/auth/whoami

Response samples

• 200
• 401
• 500

Content type

application/json

{

• "permissions": {

  • "can_edit_acls": true,
  • "can_edit_forwarders": true,
  • "can_edit_pipelines": true,
  • "can_edit_streams": true,
  • "can_edit_transformers": true,
  • "can_send_logs": true,
  • "can_view_acls": true,
  • "can_view_forwarders": true,
  • "can_view_pipelines": true,
  • "can_view_streams": true,
  • "can_view_transformers": true

  },
• "success": true,
• "user": {

  • "name": "string",
  • "roles": [

    • "string"

    ]

  }

}

backup

Backup Authentication Database

Download a full snapshot of the authentication database.

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/backup/auth

Response samples

• 401
• 403
• 500

Content type

application/json

{

• "code": 0,
• "context": {

  • "property1": null,
  • "property2": null

  },
• "error": "string",
• "status": "string"

}

Backup Configuration

Download a full snapshot of the configuration database.

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/backup/config

Response samples

• 401
• 403
• 500

Content type

application/json

{

• "code": 0,
• "context": {

  • "property1": null,
  • "property2": null

  },
• "error": "string",
• "status": "string"

}

Backup Logs Database

Download a full snapshot of the logs database.

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/backup/logs

Response samples

• 401
• 403
• 500

Content type

application/json

{

• "code": 0,
• "context": {

  • "property1": null,
  • "property2": null

  },
• "error": "string",
• "status": "string"

}

Restore Authentication Database

Upload a full snapshot of the authentication database.

Authorizations:

jwtAuthpatAuth

Request Body schema: multipart/form-data

backup

string <binary> <application/octet-stream> (MultipartFile)

Responses

https://link-society.github.io/api/v1/restore/auth

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Restore Configuration

Upload a full snapshot of the configuration database.

Authorizations:

jwtAuthpatAuth

Request Body schema: multipart/form-data

backup

string <binary> <application/octet-stream> (MultipartFile)

Responses

https://link-society.github.io/api/v1/restore/config

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Restore Logs Database

Upload a full snapshot of the logs database.

Authorizations:

jwtAuthpatAuth

Request Body schema: multipart/form-data

backup

string <binary> <application/octet-stream> (MultipartFile)

Responses

https://link-society.github.io/api/v1/restore/logs

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

forwarders

List Forwarders

List forwarders

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/forwarders

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "forwarders": [

  • "string"

  ],
• "success": true

}

Get Forwarder

Get forwarder

Authorizations:

jwtAuthpatAuth

path Parameters

forwarder required

string non-empty

Responses

https://link-society.github.io/api/v1/forwarders/{forwarder}

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "forwarder": {

  • "config": {

    • "headers": {

      • "property1": "string",
      • "property2": "string"

      },
    • "type": "http",
    • "url": "string"

    },
  • "version": 2

  },
• "success": true

}

Save Forwarder

Save forwarder

Authorizations:

jwtAuthpatAuth

path Parameters

forwarder required

string non-empty

Request Body schema: application/json

	object (ModelsForwarderV2)
object or object or object (ModelsForwarderConfigV2) version integer Default: 2

Responses

https://link-society.github.io/api/v1/forwarders/{forwarder}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Delete Forwarder

Delete forwarder

Authorizations:

jwtAuthpatAuth

path Parameters

forwarder required

string non-empty

Responses

https://link-society.github.io/api/v1/forwarders/{forwarder}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

pipelines

List Pipelines

List pipelines

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/pipelines

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "pipelines": [

  • "string"

  ],
• "success": true

}

Get Pipeline

Get pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline required

string non-empty

Responses

https://link-society.github.io/api/v1/pipelines/{pipeline}

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "flow": {

  • "edges": [

    • {

      • "id": "string",
      • "source": "string",
      • "sourceHandle": "string",
      • "target": "string"

      }

    ],
  • "nodes": [

    • {

      • "data": {

        • "property1": "string",
        • "property2": "string"

        },
      • "id": "string",
      • "position": {

        • "x": 0.1,
        • "y": 0.1

        },
      • "type": "string"

      }

    ],
  • "version": 2

  },
• "success": true

}

Save Pipeline

Save pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline required

string non-empty

Request Body schema: application/json

	object (ModelsFlowGraphV2)
Array of objects or null (ModelsFlowEdgeV2) Array of objects or null (ModelsFlowNodeV2) version integer Default: 2

Responses

https://link-society.github.io/api/v1/pipelines/{pipeline}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Delete Pipeline

Delete pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline required

string non-empty

Responses

https://link-society.github.io/api/v1/pipelines/{pipeline}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Ingest Log

Run log record through a pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline required

string non-empty

Request Body schema: application/json

	object or null
property name* additional property string

Responses

https://link-society.github.io/api/v1/pipelines/{pipeline}/logs

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

acls

List Roles

List known roles

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/roles

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "roles": [

  • {

    • "name": "string",
    • "scopes": [

      • "string"

      ]

    }

  ],
• "success": true

}

Save Role

Save Role

Authorizations:

jwtAuthpatAuth

path Parameters

role required

string non-empty

Request Body schema: application/json

scopes

Array of strings or null

Responses

https://link-society.github.io/api/v1/roles/{role}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Delete Role

Delete Role

Authorizations:

jwtAuthpatAuth

path Parameters

role required

string non-empty

Responses

https://link-society.github.io/api/v1/roles/{role}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Create Token

Create a new Personal Access Token for the current user

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/token

Response samples

• 200
• 401
• 404
• 500

Content type

application/json

{

• "success": true,
• "token": "string",
• "token_uuid": "string"

}

List Tokens

List Personal Access Token UUIDs for the current user

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/tokens

Response samples

• 200
• 401
• 500

Content type

application/json

{

• "success": true,
• "token_uuids": [

  • "string"

  ]

}

Delete Token

Delete Personal Access Token UUIDs for the current user

Authorizations:

jwtAuthpatAuth

path Parameters

token-uuid required

string <uuid>

Responses

https://link-society.github.io/api/v1/tokens/{token-uuid}

Response samples

• 200
• 401
• 500

Content type

application/json

{

• "success": true

}

List Users

List known users

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/users

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true,
• "users": [

  • {

    • "name": "string",
    • "roles": [

      • "string"

      ]

    }

  ]

}

Save User

Save User

Authorizations:

jwtAuthpatAuth

path Parameters

user required

string non-empty

Request Body schema: application/json

password	string
roles	Array of strings or null

Responses

https://link-society.github.io/api/v1/users/{user}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Delete User

Delete User

Authorizations:

jwtAuthpatAuth

path Parameters

user required

string non-empty

Responses

https://link-society.github.io/api/v1/users/{user}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

streams

List Streams

List known stream

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/streams

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "streams": {

  • "property1": {

    • "indexed_fields": [

      • "string"

      ],
    • "size": 0,
    • "ttl": 0

    },
  • "property2": {

    • "indexed_fields": [

      • "string"

      ],
    • "size": 0,
    • "ttl": 0

    }

  },
• "success": true

}

Get Stream Configuration

Get or Create Stream configuration

Authorizations:

jwtAuthpatAuth

path Parameters

stream required

string non-empty

Responses

https://link-society.github.io/api/v1/streams/{stream}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "config": {

  • "indexed_fields": [

    • "string"

    ],
  • "size": 0,
  • "ttl": 0

  },
• "success": true

}

Configure Stream

Configure Stream retention and indexes

Authorizations:

jwtAuthpatAuth

path Parameters

stream required

string non-empty

Request Body schema: application/json

	object (ModelsStreamConfig)
indexed_fields Array of strings or null size integer <int64> Maximum size in MB, 0 to disable ttl integer <int64> TTL in seconds, 0 to disable

Responses

https://link-society.github.io/api/v1/streams/{stream}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Purge Stream

Remove all logs (and indexes) related to a stream

Authorizations:

jwtAuthpatAuth

path Parameters

stream required

string non-empty

Responses

https://link-society.github.io/api/v1/streams/{stream}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

List Stream Fields

List known fields for a stream

Authorizations:

jwtAuthpatAuth

path Parameters

stream required

string non-empty

Responses

https://link-society.github.io/api/v1/streams/{stream}/fields

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "fields": [

  • "string"

  ],
• "success": true

}

Query Stream

Query logs from a stream

Authorizations:

jwtAuthpatAuth

path Parameters

stream required

string non-empty

query Parameters

from required	string <date-time>
to required	string <date-time>
filter	null or string

Responses

https://link-society.github.io/api/v1/streams/{stream}/logs

Response samples

• 200
• 400
• 401
• 403
• 500

Content type

application/json

{

• "records": [

  • {

    • "fields": {

      • "property1": "string",
      • "property2": "string"

      },
    • "timestamp": "2019-08-24T14:15:22Z"

    }

  ],
• "success": true

}

Watch Logs

Server-Sent Events endpoint to watch logs in real time.

Authorizations:

jwtAuthpatAuth

path Parameters

stream required

string non-empty

query Parameters

filter

null or string

Responses

https://link-society.github.io/api/v1/streams/{stream}/logs/watch

Response samples

• 401
• 403
• 500

Content type

application/json

{

• "code": 0,
• "context": {

  • "property1": null,
  • "property2": null

  },
• "error": "string",
• "status": "string"

}

tests

Test Forwarder

Test forwarder

Authorizations:

jwtAuthpatAuth

path Parameters

forwarder required

string non-empty

Request Body schema: application/json

	object or null
property name* additional property string

Responses

https://link-society.github.io/api/v1/test/forwarders/{forwarder}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 404
• 500

Content type

application/json

{

• "success": true

}

Test Transformer

Test Transformer

Authorizations:

jwtAuthpatAuth

Request Body schema: application/json

code	string
	object or null

Responses

https://link-society.github.io/api/v1/test/transformer

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "record": {

  • "property1": "string",
  • "property2": "string"

  },
• "success": true

}

transformers

List Transformers

List Transformers

Authorizations:

jwtAuthpatAuth

Responses

https://link-society.github.io/api/v1/transformers

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true,
• "transformers": [

  • "string"

  ]

}

Get Transformer

Get Transformer

Authorizations:

jwtAuthpatAuth

path Parameters

transformer required

string non-empty

Responses

https://link-society.github.io/api/v1/transformers/{transformer}

Response samples

• 200
• 401
• 403
• 404

Content type

application/json

{

• "script": "string",
• "success": true

}

Save Transformer

Save Transformer

Authorizations:

jwtAuthpatAuth

path Parameters

transformer required

string non-empty

Request Body schema: application/json

script

string

Responses

https://link-society.github.io/api/v1/transformers/{transformer}

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}

Delete Transformer

Delete Transformer

Authorizations:

jwtAuthpatAuth

path Parameters

transformer required

string non-empty

Responses

https://link-society.github.io/api/v1/transformers/{transformer}

Response samples

• 200
• 401
• 403
• 500

Content type

application/json

{

• "success": true

}