Flowg API (v0.64.1)

auth

List Auth Providers

List available auth providers

Responses

Response samples

200
403
500

Content type

application/json

{"auth_providers": [{"display_name": "string",
"name": "string"
}
],
"success": true
}

Get Auth Provider

Authorizations:

jwtAuthpatAuth

path Parameters

auth_provider

required

string non-empty

Responses

Response samples

200
401
403
404

Content type

application/json

{"auth_provider": {"config": {"client_id": "string",
"client_secret": "string",
"issuer": "http://example.com",
"type": "oidc"
},
"display_name": "string",
"name": "string"
},
"success": true
}

Save Auth Provider

Save auth provider

Authorizations:

jwtAuthpatAuth

path Parameters

auth_provider

required

string non-empty

Request Body schema: application/json

required

object (ModelsAuthProvider)

name required	string
display_name required	string
required	object or object (ModelsAuthProviderConfig)

Responses

Request samples

Payload

Content type

application/json

{"auth_provider": {"config": {"client_id": "string",
"client_secret": "string",
"issuer": "http://example.com",
"type": "oidc"
},
"display_name": "string",
"name": "string"
}
}

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Delete Auth Provider

Authorizations:

jwtAuthpatAuth

path Parameters

auth_provider

required

string non-empty

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Change Password

Change Password of current user

Authorizations:

jwtAuthpatAuth

Request Body schema: application/json

old_password required	string non-empty
new_password required	string non-empty

Responses

Request samples

Payload

Content type

application/json

{"new_password": "string",
"old_password": "string"
}

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Authenticate

Create new Session cookie

Request Body schema: application/json

username required	string
password required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"username": "string"
}

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

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_read_auth_providers": true,
"can_read_system_configuration": 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,
"can_write_auth_providers": true,
"can_write_system_configuration": true
},
"success": true,
"user": {"name": "string",
"roles": ["string"
]
}
}

backup

Backup Authentication Database

Download a full snapshot of the authentication database.

Authorizations:

jwtAuthpatAuth

Responses

Response samples

401
403
500
501

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

Response samples

401
403
500
501

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

Response samples

401
403
500
501

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

Response samples

200
401
403
500
501

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

Response samples

200
401
403
500
501

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

Response samples

200
401
403
500
501

Content type

application/json

{"success": true
}

forwarders

List Forwarders

List forwarders

Authorizations:

jwtAuthpatAuth

Responses

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

Response samples

200
401
403
404
500

Content type

application/json

{"forwarder": {"config": {"body": "string",
"headers": {"property1": "string",
"property2": "string"
},
"proxy": "string",
"type": "http",
"url": "http://example.com"
},
"version": 2
},
"success": true
}

Save Forwarder

Save forwarder

Authorizations:

jwtAuthpatAuth

path Parameters

forwarder

required

string non-empty

Request Body schema: application/json

required

object (ModelsForwarderV2)

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

Responses

Request samples

Payload

Content type

application/json

{"forwarder": {"config": {"type": "http",
"url": "http://example.com"
}
}
}

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

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

pipelines

List Pipelines

List pipelines

Authorizations:

jwtAuthpatAuth

Responses

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

Response samples

200
401
403
404
500

Content type

application/json

{"flow": {"edges": [{"id": "string",
"source": "string",
"sourceHandle": "",
"target": "string"
}
],
"hasLayout": false,
"nodes": [{"data": {"property1": "string",
"property2": "string"
},
"id": "string",
"position": {"x": 0.1,
"y": 0.1
},
"type": "source"
}
],
"version": 2,
"version.minor": 1
},
"success": true
}

Save Pipeline

Save pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline

required

string non-empty

Request Body schema: application/json

required

object (ModelsFlowGraphV2)

required	Array of objects or null (ModelsFlowNodeV2)
required	Array of objects or null (ModelsFlowEdgeV2)
hasLayout	boolean Default: false
version	integer Default: 2
version.minor	integer Default: 1

Responses

Request samples

Payload

Content type

application/json

{"flow": {"edges": [{"id": "string",
"source": "string",
"target": "string"
}
],
"nodes": [{"data": {"property1": "string",
"property2": "string"
},
"id": "string",
"position": {"x": 0.1,
"y": 0.1
},
"type": "source"
}
]
}
}

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

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Ingest OpenTelemetry logs

Run OpenTelemetry logs through a pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline

required

string non-empty

header Parameters

Content-Encoding

string

Value: "gzip"

Request Body schema:
application/json

OpenTelemetry Export Logs Service Request

Array of objects (V1ResourceLogs)

Array

	object (V1Resource)
schema_url	string
	Array of objects (V1ScopeLogs)

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
401
403
404
500

Content type

application/json

{"processed_count": 0,
"success": true
}

Ingest Structured Logs

Run structured logs through a pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline

required

string non-empty

Request Body schema: application/json

required

Array of objects or null

Array

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"records": [{"property1": "string",
"property2": "string"
}
]
}

Response samples

200
401
403
404
500

Content type

application/json

{"processed_count": 0,
"success": true
}

Ingest Textual Logs

Run textual logs through a pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline

required

string non-empty

Request Body schema: text/plain

string

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"processed_count": 0,
"success": true
}

Scrap Pipeline Metrics

Prometheus Exporter for the pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline

required

string non-empty

Responses

Response samples

401
403
404
500

Content type

application/json

{"code": 0,
"context": {"property1": null,
"property2": null
},
"error": "string",
"status": "string"
}

acls

List Roles

List known roles

Authorizations:

jwtAuthpatAuth

Responses

Response samples

200
401
403
500

Content type

application/json

{"roles": [{"name": "string",
"scopes": ["read_pipelines"
]
}
],
"success": true
}

Get Role

Authorizations:

jwtAuthpatAuth

path Parameters

role

required

string non-empty

Responses

Response samples

200
401
403
404

Content type

application/json

{"role": {"name": "string",
"scopes": ["read_pipelines"
]
},
"success": true
}

Save Role

Authorizations:

jwtAuthpatAuth

path Parameters

role

required

string non-empty

Request Body schema: application/json

scopes

required

Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{"scopes": ["string"
]
}

Response samples

200
400
401
403
500

Content type

application/json

{"success": true
}

Delete Role

Authorizations:

jwtAuthpatAuth

path Parameters

role

required

string non-empty

Responses

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

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

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

Response samples

200
401
500

Content type

application/json

{"success": true
}

List Users

List known users

Authorizations:

jwtAuthpatAuth

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"users": [{"name": "string",
"roles": ["string"
]
}
]
}

Get User

Authorizations:

jwtAuthpatAuth

path Parameters

user

required

string non-empty

Responses

Response samples

200
401
403
404

Content type

application/json

{"success": true,
"user": {"name": "string",
"roles": ["string"
]
}
}

Save User

Authorizations:

jwtAuthpatAuth

path Parameters

user

required

string non-empty

Request Body schema: application/json

roles required	Array of strings or null
password required	string

Responses

Request samples

Payload

Content type

application/json

{"password": "string",
"roles": ["string"
]
}

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Delete User

Authorizations:

jwtAuthpatAuth

path Parameters

user

required

string non-empty

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Patch User Roles

Authorizations:

jwtAuthpatAuth

path Parameters

user

required

string non-empty

Request Body schema: application/json

roles

required

Array of strings or null[ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"roles": ["string"
]
}

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

streams

List Streams

List known stream

Authorizations:

jwtAuthpatAuth

Responses

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

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

required

object (ModelsStreamConfig)

ttl required	integer <int64> TTL in seconds, 0 to disable
size required	integer <int64> Maximum size in MB, 0 to disable
indexed_fields	Array of strings or null[ items non-empty ]

Responses

Request samples

Payload

Content type

application/json

{"config": {"size": 0,
"ttl": 0
}
}

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

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

Response samples

200
401
403
500

Content type

application/json

{"fields": ["string"
],
"success": true
}

Get Stream indices

Get distinct values for indexed fields in a Stream

Authorizations:

jwtAuthpatAuth

path Parameters

stream

required

string non-empty

Responses

Response samples

200
401
403
500

Content type

application/json

{"indices": {"property1": ["string"
],
"property2": ["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
	null or object

Responses

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

Response samples

401
403
500

Content type

application/json

{"code": 0,
"context": {"property1": null,
"property2": null
},
"error": "string",
"status": "string"
}

Get Stream usage

Authorizations:

jwtAuthpatAuth

path Parameters

stream

required

string non-empty

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"usage": 0
}

config

Get System configuration

Authorizations:

jwtAuthpatAuth

Responses

Response samples

200
401
403
500

Content type

application/json

{"configuration": {"default_roles": ["string"
],
"syslog_allowed_origins": ["string"
]
},
"success": true
}

Update System configuration

Authorizations:

jwtAuthpatAuth

Request Body schema: application/json

default_roles	Array of strings or null
syslog_allowed_origins	Array of strings or null

Responses

Request samples

Payload

Content type

application/json

{ }

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

tests

Test Forwarder

Test forwarder

Authorizations:

jwtAuthpatAuth

path Parameters

forwarder

required

string non-empty

Request Body schema: application/json

required

object or null

property name*

additional property

string

Responses

Request samples

Payload

Content type

application/json

{"record": {"property1": "string",
"property2": "string"
}
}

Response samples

200
401
403
404
500

Content type

application/json

{"success": true
}

Test the pipeline

Test running structured logs through a pipeline

Authorizations:

jwtAuthpatAuth

path Parameters

pipeline

required

string non-empty

Request Body schema: application/json

required	object (ModelsFlowGraphV2)
required	Array of objects or null

Responses

Request samples

Payload

Content type

application/json

{"flow": {"edges": [{"id": "string",
"source": "string",
"target": "string"
}
],
"nodes": [{"data": {"property1": "string",
"property2": "string"
},
"id": "string",
"position": {"x": 0.1,
"y": 0.1
},
"type": "source"
}
]
},
"records": [{"property1": "string",
"property2": "string"
}
]
}

Response samples

200
401
403
500

Content type

application/json

{"error": null,
"success": true,
"trace": [{"error": null,
"input": {"property1": "string",
"property2": "string"
},
"nodeID": "string",
"output": [{"property1": "string",
"property2": "string"
}
]
}
]
}

Test Transformer

Authorizations:

jwtAuthpatAuth

Request Body schema: application/json

code required	string
required	object or null

Responses

Request samples

Payload

Content type

application/json

{"code": "string",
"record": {"property1": "string",
"property2": "string"
}
}

Response samples

200
401
403
412
500

Content type

application/json

{"records": [{"property1": "string",
"property2": "string"
}
],
"success": true
}

transformers

List Transformers

Authorizations:

jwtAuthpatAuth

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true,
"transformers": ["string"
]
}

Get Transformer

Authorizations:

jwtAuthpatAuth

path Parameters

transformer

required

string non-empty

Responses

Response samples

200
401
403
404
500

Content type

application/json

{"script": "string",
"success": true
}

Save Transformer

Authorizations:

jwtAuthpatAuth

path Parameters

transformer

required

string non-empty

Request Body schema: application/json

script

required

string

Responses

Request samples

Payload

Content type

application/json

{"script": "string"
}

Response samples

200
401
403
500

Content type

application/json

{"success": true
}

Delete Transformer

Authorizations:

jwtAuthpatAuth

path Parameters

transformer

required

string non-empty

Responses

Response samples

200
401
403
500

Content type

application/json

{"success": true
}