API Reference

Get dFlux server version information

get
Responses
chevron-right
200

return server version information

application/json
get
/version
200

return server version information

Get Enf status

get
Responses
chevron-right
200

return enf status information

application/json
get
/status
200

return enf status information

Get templates list

get
Path parameters
kindstringRequired

kind

Responses
chevron-right
200

returns templates information

application/json
get
/templates/{kind}
200

returns templates information

Create new template

post
Body
IDstringOptional
labelsstring[]Optional
namespacestringOptional
kindstring · enumOptionalPossible values:
envvstring[]Optional
Responses
post
/template
201

Template Created

Get template

get
Path parameters
IDstringRequired

kind

Responses
chevron-right
200

returns template

application/json
get
/template/{ID}
200

returns template

Remove a template

delete
Path parameters
IDstringRequired

Unique ID of the template to be deleted

Responses
delete
/template/{ID}
204

Template delete successfully

No content

Get Execution

get
Body
executeIDstringOptional
Responses
chevron-right
200

returns execution information

application/json
get
/execute
200

returns execution information

Execute a flow template

post
Body
commandstring · enumOptionalPossible values:
flowTemplateIDstringOptional
Responses
chevron-right
200

Execution Response

application/json
post
/execute
200

Execution Response

Get subscribers list

get
Path parameters
namespacestringRequired

namespace

Responses
chevron-right
200

returns subscribers information

application/json
get
/subscribres/{namespace}
200

returns subscribers information

Create subscribers in the namespace

post
Path parameters
namespacestringRequired

namespace

Bodyobject[]
IDstringOptional
namespacestringOptional
supistringOptional
sucistringOptional
snnstringOptional
kistringOptional
opcstringOptional
randstringOptional
sqnstringOptional
opstringOptional
mccstringOptional
mncstringOptional
msinstringOptional
imsistringOptional
imsisvstringOptional
calgstringOptional
ialgstringOptional
Responses
post
/subscribres/{namespace}
201

Subscribers Created

No content

Delete all subscribers in the namespace

delete
Path parameters
namespacestringRequired

namespace

Responses
chevron-right
200

Subscribers Deleted

No content

delete
/subscribres/{namespace}
200

Subscribers Deleted

No content

Get all reports

get
Responses
chevron-right
200

return available reports list

application/json
get
/reports
200

return available reports list

Get execution info

get
Path parameters
reportIDstringRequired

id of report

Responses
chevron-right
200

returns execution information (report)

application/json
get
/report/{reportID}
200

returns execution information (report)

Last updated