API Reference

Get dFlux server version information

get

Responses

200

return server version information

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/version HTTP/1.1
Host: 
Accept: */*

200

return server version information

{
  "App": "text",
  "AppID": "text",
  "Addr": "text",
  "Version": "text",
  "Commit": "text",
  "BuildTime": "text"
}

Get Enf status

get

Responses

200

return enf status information

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/status HTTP/1.1
Host: 
Accept: */*

200

return enf status information

{
  "status": "starting",
  "error": "text",
  "started": "text",
  "uptime": "text",
  "runningFlows": [
    {
      "ID": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": [
        "text"
      ],
      "namespace": "text",
      "kind": "envv"
    }
  ]
}

Get templates list

get

Path parameters

kindstringRequired

kind

Responses

200

returns templates information

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/templates/{kind} HTTP/1.1
Host: 
Accept: */*

200

returns templates information

[
  {
    "ID": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": [
      "text"
    ],
    "namespace": "text",
    "kind": "envv"
  }
]

Create new template

post

Body

IDstringOptional

labelsstring[]Optional

namespacestringOptional

kindstring · enumOptionalPossible values:

envvstring[]Optional

Responses

201

Template Created

application/json

post

HTTPcURLJavaScriptPython

POST 50051/dfxe/v1/template HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1492

{
  "ID": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "labels": [
    "text"
  ],
  "namespace": "text",
  "kind": "envv",
  "envv": [
    "text"
  ],
  "config": [
    {
      "type": "text",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "fsm": [
    {
      "state": "text",
      "nextstate": "text",
      "event": "text",
      "timeout": "text",
      "actions": [
        "text"
      ]
    }
  ],
  "messages": [
    {
      "name": "text",
      "type": "text",
      "message": "text"
    }
  ],
  "checks": [
    {
      "name": "text",
      "operations": [
        "text"
      ]
    }
  ],
  "tests": [
    {
      "name": "text",
      "operations": [
        "text"
      ]
    }
  ],
  "settings": {
    "timeout": "text",
    "repetitions": 1,
    "duration": "text",
    "rate": {
      "repetitions": 1,
      "interval": "text"
    },
    "failFast": true
  },
  "flow": {
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": [
      "text"
    ],
    "refs": {
      "envv": "text",
      "config": "text",
      "data": "text",
      "fsm": "text",
      "messages": "text",
      "checks": "text",
      "tests": "text",
      "settings": "text"
    },
    "envv": [
      "text"
    ],
    "config": [
      {
        "type": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "fsm": [
      {
        "state": "text",
        "nextstate": "text",
        "event": "text",
        "timeout": "text",
        "actions": [
          "text"
        ]
      }
    ],
    "messages": [
      {
        "name": "text",
        "type": "text",
        "message": "text"
      }
    ],
    "checks": [
      {
        "name": "text",
        "operations": [
          "text"
        ]
      }
    ],
    "tests": [
      {
        "name": "text",
        "operations": [
          "text"
        ]
      }
    ],
    "subscribers": [
      {
        "ID": "text",
        "namespace": "text",
        "supi": "text",
        "suci": "text",
        "snn": "text",
        "ki": "text",
        "opc": "text",
        "rand": "text",
        "sqn": "text",
        "op": "text",
        "mcc": "text",
        "mnc": "text",
        "msin": "text",
        "imsi": "text",
        "imsisv": "text",
        "calg": "text",
        "ialg": "text"
      }
    ],
    "settings": {
      "timeout": "text",
      "repetitions": 1,
      "duration": "text",
      "rate": {
        "repetitions": 1,
        "interval": "text"
      },
      "failFast": true
    }
  }
}

201

Template Created

{
  "ID": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "labels": [
    "text"
  ],
  "namespace": "text",
  "kind": "envv"
}

Get template

get

Path parameters

IDstringRequired

kind

Responses

200

returns template

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/template/{ID} HTTP/1.1
Host: 
Accept: */*

200

returns template

{
  "ID": "text",
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "labels": [
    "text"
  ],
  "namespace": "text",
  "kind": "envv",
  "envv": [
    "text"
  ],
  "config": [
    {
      "type": "text",
      "params": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "fsm": [
    {
      "state": "text",
      "nextstate": "text",
      "event": "text",
      "timeout": "text",
      "actions": [
        "text"
      ]
    }
  ],
  "messages": [
    {
      "name": "text",
      "type": "text",
      "message": "text"
    }
  ],
  "checks": [
    {
      "name": "text",
      "operations": [
        "text"
      ]
    }
  ],
  "tests": [
    {
      "name": "text",
      "operations": [
        "text"
      ]
    }
  ],
  "settings": {
    "timeout": "text",
    "repetitions": 1,
    "duration": "text",
    "rate": {
      "repetitions": 1,
      "interval": "text"
    },
    "failFast": true
  },
  "flow": {
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": [
      "text"
    ],
    "refs": {
      "envv": "text",
      "config": "text",
      "data": "text",
      "fsm": "text",
      "messages": "text",
      "checks": "text",
      "tests": "text",
      "settings": "text"
    },
    "envv": [
      "text"
    ],
    "config": [
      {
        "type": "text",
        "params": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        }
      }
    ],
    "fsm": [
      {
        "state": "text",
        "nextstate": "text",
        "event": "text",
        "timeout": "text",
        "actions": [
          "text"
        ]
      }
    ],
    "messages": [
      {
        "name": "text",
        "type": "text",
        "message": "text"
      }
    ],
    "checks": [
      {
        "name": "text",
        "operations": [
          "text"
        ]
      }
    ],
    "tests": [
      {
        "name": "text",
        "operations": [
          "text"
        ]
      }
    ],
    "subscribers": [
      {
        "ID": "text",
        "namespace": "text",
        "supi": "text",
        "suci": "text",
        "snn": "text",
        "ki": "text",
        "opc": "text",
        "rand": "text",
        "sqn": "text",
        "op": "text",
        "mcc": "text",
        "mnc": "text",
        "msin": "text",
        "imsi": "text",
        "imsisv": "text",
        "calg": "text",
        "ialg": "text"
      }
    ],
    "settings": {
      "timeout": "text",
      "repetitions": 1,
      "duration": "text",
      "rate": {
        "repetitions": 1,
        "interval": "text"
      },
      "failFast": true
    }
  }
}

Remove a template

delete

Path parameters

IDstringRequired

Unique ID of the template to be deleted

Responses

204

Template delete successfully

delete

HTTPcURLJavaScriptPython

DELETE 50051/dfxe/v1/template/{ID} HTTP/1.1
Host: 
Accept: */*

204

Template delete successfully

No content

Get Execution

get

Body

executeIDstringOptional

Responses

200

returns execution information

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/execute HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "executeID": "text"
}

200

returns execution information

{
  "executeID": "text",
  "templateInfo": {
    "ID": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": [
      "text"
    ],
    "namespace": "text",
    "kind": "envv"
  },
  "metrics": [
    {
      "type": "PACKET",
      "name": "text",
      "unit": "text",
      "value": 1,
      "packets": 1,
      "max": 1,
      "min": 1
    }
  ]
}

Execute a flow template

post

Body

commandstring · enumOptionalPossible values:

flowTemplateIDstringOptional

Responses

200

Execution Response

application/json

post

HTTPcURLJavaScriptPython

POST 50051/dfxe/v1/execute HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "command": "start",
  "flowTemplateID": "text"
}

200

Execution Response

{
  "executeID": "text",
  "reportID": "text",
  "flowTemplateID": "text",
  "status": "running"
}

Get subscribers list

get

Path parameters

namespacestringRequired

namespace

Responses

200

returns subscribers information

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/subscribres/{namespace} HTTP/1.1
Host: 
Accept: */*

200

returns subscribers information

[
  {
    "ID": "text",
    "namespace": "text",
    "supi": "text",
    "suci": "text",
    "snn": "text",
    "ki": "text",
    "opc": "text",
    "rand": "text",
    "sqn": "text",
    "op": "text",
    "mcc": "text",
    "mnc": "text",
    "msin": "text",
    "imsi": "text",
    "imsisv": "text",
    "calg": "text",
    "ialg": "text"
  }
]

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

201

Subscribers Created

post

HTTPcURLJavaScriptPython

POST 50051/dfxe/v1/subscribres/{namespace} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 237

[
  {
    "ID": "text",
    "namespace": "text",
    "supi": "text",
    "suci": "text",
    "snn": "text",
    "ki": "text",
    "opc": "text",
    "rand": "text",
    "sqn": "text",
    "op": "text",
    "mcc": "text",
    "mnc": "text",
    "msin": "text",
    "imsi": "text",
    "imsisv": "text",
    "calg": "text",
    "ialg": "text"
  }
]

201

Subscribers Created

No content

Delete all subscribers in the namespace

delete

Path parameters

namespacestringRequired

namespace

Responses

200

Subscribers Deleted

delete

HTTPcURLJavaScriptPython

DELETE 50051/dfxe/v1/subscribres/{namespace} HTTP/1.1
Host: 
Accept: */*

200

Subscribers Deleted

No content

Get all reports

get

Responses

200

return available reports list

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/reports HTTP/1.1
Host: 
Accept: */*

200

return available reports list

[
  {
    "ID": "text",
    "executionID": "text",
    "templateID": "text",
    "namespace": "text",
    "template": {
      "ID": "text",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "labels": [
        "text"
      ],
      "namespace": "text",
      "kind": "envv"
    }
  }
]

Get execution info

get

Path parameters

reportIDstringRequired

id of report

Responses

200

returns execution information (report)

application/json

get

HTTPcURLJavaScriptPython

GET 50051/dfxe/v1/report/{reportID} HTTP/1.1
Host: 
Accept: */*

200

returns execution information (report)

{
  "ID": "text",
  "executionID": "text",
  "templateID": "text",
  "namespace": "text",
  "template": {
    "ID": "text",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "labels": [
      "text"
    ],
    "namespace": "text",
    "kind": "envv"
  },
  "startTime": "text",
  "endTime": "text",
  "duration": "text",
  "result": true,
  "metrics": [
    {
      "type": "PACKET",
      "name": "text",
      "unit": "text",
      "value": 1,
      "packets": 1,
      "max": 1,
      "min": 1
    }
  ],
  "tests": [
    {
      "name": "text",
      "operation": "text",
      "value": "text",
      "result": true,
      "err": "text"
    }
  ]
}