API

Webhook

Endpoint to receive messages to be processed by HTTP inputs

Inserts a message into one or more Firehose input configs

post
/v1/webhook

Use this endpoint to send message to HTTP inputs configurations

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Query parameters
firehose-idsstring[]Required

One or more input config ids

Header parameters
Content-TypestringRequired

The content type of the message

Body
Other propertiesanyOptional
Responses
chevron-right
200

OK

*/*
successbooleanOptional

If the operation was executed successfully

post
/v1/webhook
200

OK

Sindicator Manager

The sindicator manager is responsible for all the APIs to manage configurations and authentication.

Lists the Firehose configs owned by groups of the user

get

Lists the Firehose configs owned by groups of the user

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Responses
chevron-right
200

OK

application/json
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
get
/v1/configs
200

OK

Adds a new Firehose config

post

Adds a new Firehose config

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Body
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
Responses
chevron-right
200

OK

application/json
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
post
/v1/configs
200

OK

Verifies a Firehose config

post

Verifies a Firehose config

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Body
Responses
chevron-right
200

OK

application/json
post
/v1/verify
200

OK

Gets a Firehose config by id

get

Gets a Firehose config by its id

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Path parameters
keystringRequired

The Firehose config id

Responses
chevron-right
200

OK

application/json
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
get
/v1/configs/{key}
200

OK

Edits Firehose config by id

put

Edits a Firehose config by its id

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Path parameters
keystringRequired

The Firehose config id

Body
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
Responses
chevron-right
200

OK

application/json
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
put
/v1/configs/{key}
200

OK

Deletes a Firehose config by id

delete

Deletes a Firehose config by its id

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Path parameters
keystringRequired

The Firehose config id

Responses
chevron-right
200

OK

application/json
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
delete
/v1/configs/{key}
200

OK

Edits some fields from a Firehose config by id

patch

Edits some fields from a Firehose config by its id

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Path parameters
keystringRequired

The Firehose config id

Body
descriptionstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
Responses
chevron-right
200

OK

application/json
descriptionstringOptional
groupsstring[] · max: 1Optional
idstringOptional
namestringOptional
sharing_groupsstring[]Optional
statusstring · enumOptionalPossible values:
patch
/v1/configs/{key}
200

OK

Inspects an user access token

get

Inspects an user access token

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Responses
chevron-right
200

OK

application/json
get
/v1/auth/inspect-token
200

OK

Login as an authenticated user to retrieve the access token

post

Login as an authenticated user to retrieve the access token

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Body
passwordstringRequired
usernamestringRequired
Responses
chevron-right
200

OK

application/json
access_tokenstringOptional
expires_inintegerOptional
id_tokenstringOptional
refresh_expires_inintegerOptional
refresh_tokenstringOptional
scopestringOptional
session_statestringOptional
token_typestringOptional
post
/v1/auth/login
200

OK

Refresh an user access token

post

Refresh an user access token

Authorizations
AuthorizationstringRequired

The Bearer token to authenticate.

Body
refresh_tokenstringRequired
Responses
chevron-right
200

OK

application/json
access_tokenstringOptional
expires_inintegerOptional
id_tokenstringOptional
refresh_expires_inintegerOptional
refresh_tokenstringOptional
scopestringOptional
session_statestringOptional
token_typestringOptional
post
/v1/auth/refresh-token
200

OK

Last updated