title: CloudFabrix RDA Platform API v3.2.2 language_tabs:

python: Python
java: java language_clients:
python: ""
java: "" toc_footers: [] includes: [] search: true highlight_theme: darkula headingLevel: 2

CloudFabrix RDA Platform API v3.2.2

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

CloudFabrix RDA Platform API

Authentication

Login into api server. (Run this first)

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/login', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/login");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/v2/login

Body parameter

{
  "user": "string",
  "password": "string"
}

Name	In	Type	Required	Description
body	body	LoginInput	true	none

Example responses

200 Response

{
  "authenticated": true,
  "company": "CloudFabrix",
  "first_name": "Acme",
  "firstname": "Acme",
  "id": "acme@cfx.com",
  "is_authenticated": true,
  "is_workspaceadmin": false,
  "is_workspacecreator": 0,
  "last_name": "Inc",
  "lastname": "Inc",
  "login-time": "2023-06-28T15:35:30.500255",
  "rdac_auth_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyLWlkIjoiYWNtZUBjZnguY29tIiwid29ya3NwYWNlaWQiOiI4MGQ1MGI0ZS1lMWYyLTQ3ZGUtOGZmMC1hMzhjMTgwY2VmYmIifQ.4lE3Uzlh7PJwyuCJ8DdJ2xq6szMzF-B4PSTjomrOl8k",
  "remote_user": false,
  "reset_password": 0,
  "role": "TENANT_USERS",
  "session-id": "39030163f5eb4e30a713be9c9c4bab7f",
  "status": "ok",
  "tenantid": "80d50b4e-e1f2-47de-8ff0-a38c180cefbb",
  "user": "acme@cfx.com",
  "workspace": "ws80d50b",
  "workspaceid": "80d50b4e-e1f2-47de-8ff0-a38c180cefbb"
}

Status	Meaning	Description	Schema
200	OK	Successful Response	UserDetails
422	Unprocessable Entity	Validation Error	HTTPValidationError

Users

Get current logged in user details

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/current_user', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/current_user");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/current_user

Get the details of the current user

Example responses

200 Response

{
  "authenticated": true,
  "company": "CloudFabrix",
  "first_name": "Acme",
  "firstname": "Acme",
  "id": "acme@cfx.com",
  "is_authenticated": true,
  "is_workspaceadmin": false,
  "is_workspacecreator": 0,
  "last_name": "Inc",
  "lastname": "Inc",
  "login-time": "2023-06-28T15:35:30.500255",
  "rdac_auth_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyLWlkIjoiYWNtZUBjZnguY29tIiwid29ya3NwYWNlaWQiOiI4MGQ1MGI0ZS1lMWYyLTQ3ZGUtOGZmMC1hMzhjMTgwY2VmYmIifQ.4lE3Uzlh7PJwyuCJ8DdJ2xq6szMzF-B4PSTjomrOl8k",
  "remote_user": false,
  "reset_password": 0,
  "role": "TENANT_USERS",
  "session-id": "39030163f5eb4e30a713be9c9c4bab7f",
  "status": "ok",
  "tenantid": "80d50b4e-e1f2-47de-8ff0-a38c180cefbb",
  "user": "acme@cfx.com",
  "workspace": "ws80d50b",
  "workspaceid": "80d50b4e-e1f2-47de-8ff0-a38c180cefbb"
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	UserDetails

Get all users

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/users', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/users

Get all the users belonging to the same tenant as the current user

Example responses

200 Response

{
  "is_first": true,
  "is_last": true,
  "num_items": 12,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "userId",
        "identifier": "userId",
        "key": true,
        "sortable": true,
        "title": "User ID",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Tenant Users"
  },
  "total_count": 112,
  "users": [
    {
      "contactNumber": "",
      "emailId": "acme@cfx.com",
      "firstName": "acme",
      "id": "user-dashboard-user-permissions",
      "lastName": "user",
      "localuser": "Yes",
      "loggedIn_user": true,
      "parentResourceId": "0d76cbf4-6234-483d-b11d-c00c209fa668",
      "profile": "msp-admin",
      "role": "msp-admin",
      "status": "Active",
      "userGroup": "msp-admin-group",
      "userId": "acme@cfx.com",
      "userType": "local"
    }
  ]
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Users

Add user

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/users', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/v2/users

Add a user

Body parameter

{
  "remoteUser": false,
  "authenticationType": "ad",
  "group": "string",
  "firstname": "string",
  "lastname": "string",
  "id": "user@example.com"
}

Parameters

Name	In	Type	Required	Description
body	body	UserAddModel	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Change User Activation Status

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/v2/users/user/{id}/status', params={
  'activate': 'true'
}, headers = headers)

print(r.json())

URL obj = new URL("/api/v2/users/user/{id}/status?activate=true");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /api/v2/users/user/{id}/status

Activate/Deactivate User. Deactivating currently logged in user is not allowed.

Parameters

Name	In	Type	Required	Description
id	path	string	true	ID of the user to be activated/deactivated
activate	query	boolean	true	Desired user status: Activate (True) or Deactivate(False)

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Change User group

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('/api/v2/users/user/{id}/group', params={
  'group': 'string'
}, headers = headers)

print(r.json())

URL obj = new URL("/api/v2/users/user/{id}/group?group=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /api/v2/users/user/{id}/group

Change user group. Changing currently logged in user is not allowed.

Parameters

Name	In	Type	Required	Description
id	path	string	true	ID of the user to be activated/deactivated
group	query	string	true	New group for the user.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Dashboards

Fetch meta data for dashboards

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/dashboards', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/dashboards");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/dashboards

Fetch meta data for dashboards

Parameters

Name	In	Type	Required	Description
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'description', 'usecase', 'category', 'version']
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return
sort	query	any	false	Sort the output based on given fields

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Datasets

Fetch meta data about datasets

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/datasets', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/datasets

Fetch meta data about datasets

Parameters

Name	In	Type	Required	Description
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'schema']
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return
sort	query	any	false	Sort the output based on given fields

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Add a dataset

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/datasets', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/v2/datasets

Add a dataset.

Body parameter

{
  "name": "string",
  "folder": "Default",
  "schema_name": "string",
  "tag": "string"
}

Parameters

Name	In	Type	Required	Description
body	body	DatasetAddModel	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Delete a dataset

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/v2/datasets/dataset/{name}', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets/dataset/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/v2/datasets/dataset/{name}

Delete a dataset. Please note that all the data of the dataset will be deleted and can not be undone.

Parameters

Name	In	Type	Required	Description
name	path	string	true	Dataset name to be deleted.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Get data of a dataset

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/datasets/dataset/{name}/data', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets/dataset/{name}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/datasets/dataset/{name}/data

Get data of a dataset

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the dataset
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'comment']
sort	query	any	false	Sort the output based on given fields. Prepend '-' to sort descending
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Update rows of a dataset

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/datasets/dataset/{name}/data', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets/dataset/{name}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /api/v2/datasets/dataset/{name}/data

Update (merge or replace) existing dataset data. This function currently does not support deleting rows.
If replace is true, entire existing dataset data is replaced with the new data in input.
If replace is false,

If keys are not given, the input data is appened to the existing dataset.
If keys are given then the following flow explains the operation
For each row in the input data:
- The rows with same values for all the keys are replaced with input row.
- Other rows are appended to the existing dataset
Error raised when:
- If there are duplicate rows in input data with same key values
- If any key passed in keys is not present as a column in the input data

NOTE: This directly updates the dataset and all drafts are removed.

Body parameter

[
  {}
]

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the dataset
replace	query	any	false	If set to true, replace the existing data with new data
keys	query	any	false	Array of keys to match for updating rows
body	body	array[object]	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Delete matching dataset rows

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.delete('/api/v2/datasets/dataset/{name}/data', params={
  'keys': [
  "string"
]
}, headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets/dataset/{name}/data?keys=string");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/v2/datasets/dataset/{name}/data

Delete dataset rows matching the input data All the rows in existing dataset that match all the keys in input data are deleted. NOTE: This directly updates the dataset and all drafts are removed.

Body parameter

[
  {}
]

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the dataset
keys	query	any	true	Array of keys to match for updating rows
body	body	array[object]	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Delete enitre data of a dataset

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/v2/datasets/dataset/{name}/data/all', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/datasets/dataset/{name}/data/all");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/v2/datasets/dataset/{name}/data/all

Delete entire data of a dataset

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the dataset

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Persistent Streams

Fetch meta data about pstreams

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/pstreams', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pstreams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/pstreams

Fetch meta data about pstreams

Parameters

Name	In	Type	Required	Description
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name']
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return
sort	query	any	false	Sort the output based on given fields

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Add a pstream

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/api/v2/pstreams', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pstreams");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

POST /api/v2/pstreams

Add a new pstream to the system

Body parameter

{
  "attributes": {
    "retention_days": 31,
    "unique_keys": [
      "key1",
      "key2"
    ]
  },
  "name": "example_pstream"
}

Parameters

Name	In	Type	Required	Description
body	body	PstreamAddModel	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Edit attributes of a pstream

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('/api/v2/pstreams/pstream/{name}', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pstreams/pstream/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

PUT /api/v2/pstreams/pstream/{name}

Edit the attributes of a persistent stream

Body parameter

{
  "attributes": {
    "retention_days": 31,
    "unique_keys": [
      "key1",
      "key2"
    ]
  }
}

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the pstream to be edited
body	body	PstreamEditModel	true	none

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Delete a pstream.

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('/api/v2/pstreams/pstream/{name}', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pstreams/pstream/{name}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

DELETE /api/v2/pstreams/pstream/{name}

Delete a persistent stream.

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the pstream to be deleted
delete_data	query	boolean	false	Delete data as well. If data is not deleted, adding the same pstream again will add the old data back.

Example responses

200 Response

null

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	Inline
422	Unprocessable Entity	Validation Error	HTTPValidationError

Response Schema

Get data of a pstream

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/pstreams/pstream/{name}/data', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pstreams/pstream/{name}/data");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/pstreams/pstream/{name}/data

Get data of a persistent stream

Parameters

Name	In	Type	Required	Description
name	path	string	true	Name of the pstream
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'comment']
sort	query	any	false	Sort the output based on given fields. Prepend '-' to sort descending
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Pipelines

Fetch meta data about pipelines

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/pipelines', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pipelines");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/pipelines

Fetch meta data about pipelines

Parameters

Name	In	Type	Required	Description
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'description']
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return
sort	query	any	false	Sort the output based on given fields

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Fetch meta data about draft pipelines

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/pipelines/draft', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/pipelines/draft");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/pipelines/draft

Fetch meta data about draft pipelines

Parameters

Name	In	Type	Required	Description
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'description']
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return
sort	query	any	false	Sort the output based on given fields

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Blueprints

Fetch meta data about blueprints

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('/api/v2/Blueprints', headers = headers)

print(r.json())

URL obj = new URL("/api/v2/Blueprints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

GET /api/v2/Blueprints

Fetch meta data about blueprints

Parameters

Name	In	Type	Required	Description
cfxql_query	query	any	false	cfxql query string to filter the results
search	query	any	false	search across fields: ['name', 'comment']
offset	query	any	false	Offset to start the results from.
limit	query	any	false	Maximum number of results to return
sort	query	any	false	Sort the output based on given fields

Example responses

200 Response

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

Responses

Status	Meaning	Description	Schema
200	OK	Successful Response	TableReportResponse
422	Unprocessable Entity	Validation Error	HTTPValidationError

Schemas

AuthType

"ad"

AuthType

Properties

Name	Type	Required	Restrictions	Description
AuthType	string	false	none	none

Enumerated Values

Property	Value
AuthType	ad
AuthType	sso

DatasetAddModel

{
  "name": "string",
  "folder": "Default",
  "schema_name": "string",
  "tag": "string"
}

DatasetAddModel

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
folder	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
schema_name	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
tag	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

HTTPValidationError

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

HTTPValidationError

Properties

Name	Type	Required	Restrictions	Description
detail	[ValidationError]	false	none	none

LoginInput

{
  "user": "string",
  "password": "string"
}

LoginInput

Properties

Name	Type	Required	Restrictions	Description
user	string	true	none	none
password	string	true	none	none

PstreamAddModel

{
  "attributes": {
    "retention_days": 31,
    "unique_keys": [
      "key1",
      "key2"
    ]
  },
  "name": "example_pstream"
}

PstreamAddModel

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
attributes	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

PstreamEditModel

{
  "attributes": {
    "retention_days": 31,
    "unique_keys": [
      "key1",
      "key2"
    ]
  }
}

PstreamEditModel

Properties

Name	Type	Required	Restrictions	Description
attributes	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

TableReportResponse

{
  "is_first": false,
  "is_last": false,
  "last_sort_results": [
    "Authentication Servers",
    "9d74183bf12af49841f054467d25b1b6"
  ],
  "limit": 100,
  "num_items": 12,
  "offset": 100,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "name",
        "identifier": "name",
        "key": false,
        "sortable": true,
        "title": "name",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Dashboards"
  },
  "sort": [
    "-name"
  ],
  "total_count": 112
}

TableReportResponse

Properties

Name	Type	Required	Restrictions	Description
last_sort_results	any	false	none	Last sort tags used for internal puposes

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
reportMetaData	any	false	none	Meta information about the report, including columns and types etc

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
offset	any	false	none	Starting offset in the filtered results

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
limit	any	false	none	Maximum number of results to be returned per page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
sort	any	false	none	Sort order passed as part of request

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
total_count	any	false	none	Total number of results that matched the query

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
num_items	any	false	none	Number of results returned in this page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
is_first	any	false	none	True if this page is first page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
is_last	any	false	none	True if this page is last page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

User

{
  "contactNumber": "string",
  "emailId": "string",
  "firstName": "string",
  "id": "string",
  "lastName": "string",
  "localuser": true,
  "loggedIn_user": true,
  "parentResourceId": "string",
  "profile": "string",
  "status": "string",
  "userGroup": "string",
  "userId": "string",
  "userType": "string",
  "validationStatus": "string",
  "role": "string"
}

User

Properties

Name	Type	Required	Restrictions	Description
contactNumber	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
emailId	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
firstName	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
id	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
lastName	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
localuser	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
loggedIn_user	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
parentResourceId	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
profile	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
status	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
userGroup	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
userId	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
userType	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
validationStatus	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
role	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

UserAddModel

{
  "remoteUser": false,
  "authenticationType": "ad",
  "group": "string",
  "firstname": "string",
  "lastname": "string",
  "id": "user@example.com"
}

UserAddModel

Properties

Name	Type	Required	Restrictions	Description
remoteUser	boolean	false	none	none
authenticationType	any	false	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	AuthType	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
group	string	true	none	none
firstname	string	true	none	none
lastname	string	true	none	none
id	string(email)	true	none	none

UserDetails

{
  "authenticated": true,
  "company": "CloudFabrix",
  "first_name": "Acme",
  "firstname": "Acme",
  "id": "acme@cfx.com",
  "is_authenticated": true,
  "is_workspaceadmin": false,
  "is_workspacecreator": 0,
  "last_name": "Inc",
  "lastname": "Inc",
  "login-time": "2023-06-28T15:35:30.500255",
  "rdac_auth_token": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyLWlkIjoiYWNtZUBjZnguY29tIiwid29ya3NwYWNlaWQiOiI4MGQ1MGI0ZS1lMWYyLTQ3ZGUtOGZmMC1hMzhjMTgwY2VmYmIifQ.4lE3Uzlh7PJwyuCJ8DdJ2xq6szMzF-B4PSTjomrOl8k",
  "remote_user": false,
  "reset_password": 0,
  "role": "TENANT_USERS",
  "session-id": "39030163f5eb4e30a713be9c9c4bab7f",
  "status": "ok",
  "tenantid": "80d50b4e-e1f2-47de-8ff0-a38c180cefbb",
  "user": "acme@cfx.com",
  "workspace": "ws80d50b",
  "workspaceid": "80d50b4e-e1f2-47de-8ff0-a38c180cefbb"
}

UserDetails

Properties

Name	Type	Required	Restrictions	Description
authenticated	boolean	false	none	Whether user is authenticated
company	any	false	none	Company the user belongs to

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
first_name	any	false	none	First name

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
id	string	false	none	Id of the user (email address)
is_authenticated	boolean	false	none	Alias to 'authenticated'
is_workspaceadmin	boolean	false	none	Is the user a workspace admin
is_workspacecreator	boolean	false	none	Is the user a workspace creator
last_name	boolean	false	none	Last Name
lastname	boolean	false	none	Alias to last_name
login_time	string	false	none	Login time in ISO format
rdac_auth_token	string	false	none	Authentication Token
remote_user	boolean	false	none	Whether user is a remote user or a local user
role	string	false	none	User Role
session_id	string	false	none	Current session id
status	string	false	none	Current status of the user
tenantid	string	false	none	Tenant ID of the user
user	string	false	none	alias to 'id'
workspace	string	false	none	Name of the workspace
workspaceid	string	false	none	ID of the workspace

Users

{
  "is_first": true,
  "is_last": true,
  "num_items": 12,
  "properties": {},
  "reportMetaData": {
    "reportColumnDefinitionList": [
      {
        "hidden": false,
        "id": "userId",
        "identifier": "userId",
        "key": true,
        "sortable": true,
        "title": "User ID",
        "type": "TEXT",
        "visible": true
      }
    ],
    "title": "Tenant Users"
  },
  "total_count": 112,
  "users": [
    {
      "contactNumber": "",
      "emailId": "acme@cfx.com",
      "firstName": "acme",
      "id": "user-dashboard-user-permissions",
      "lastName": "user",
      "localuser": "Yes",
      "loggedIn_user": true,
      "parentResourceId": "0d76cbf4-6234-483d-b11d-c00c209fa668",
      "profile": "msp-admin",
      "role": "msp-admin",
      "status": "Active",
      "userGroup": "msp-admin-group",
      "userId": "acme@cfx.com",
      "userType": "local"
    }
  ]
}

Users

Properties

Name	Type	Required	Restrictions	Description
last_sort_results	any	false	none	Last sort tags used for internal puposes

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
reportMetaData	any	false	none	Meta information about the report, including columns and types etc

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	object	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
offset	any	false	none	Starting offset in the filtered results

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
limit	any	false	none	Maximum number of results to be returned per page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
sort	any	false	none	Sort order passed as part of request

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[string]	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
total_count	any	false	none	Total number of results that matched the query

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
num_items	any	false	none	Number of results returned in this page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
is_first	any	false	none	True if this page is first page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
is_last	any	false	none	True if this page is last page

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	boolean	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

continued

Name	Type	Required	Restrictions	Description
users	any	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	[User]	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	null	false	none	none

ValidationError

{
  "loc": [
    "string"
  ],
  "msg": "string",
  "type": "string"
}

ValidationError

Properties

Name	Type	Required	Restrictions	Description
loc	[anyOf]	true	none	none

anyOf

Name	Type	Required	Restrictions	Description
» anonymous	string	false	none	none

Name	Type	Required	Restrictions	Description
» anonymous	integer	false	none	none

continued

Name	Type	Required	Restrictions	Description
msg	string	true	none	none
type	string	true	none	none

blueprints_enum

"auto_deploy"

blueprints_enum

Properties

Name	Type	Required	Restrictions	Description
blueprints_enum	string	false	none	none

Enumerated Values

Property	Value
blueprints_enum	auto_deploy
blueprints_enum	-auto_deploy
blueprints_enum	category
blueprints_enum	-category
blueprints_enum	comment
blueprints_enum	-comment
blueprints_enum	enabled
blueprints_enum	-enabled
blueprints_enum	errors
blueprints_enum	-errors
blueprints_enum	id
blueprints_enum	-id
blueprints_enum	name
blueprints_enum	-name
blueprints_enum	saved_type
blueprints_enum	-saved_type
blueprints_enum	state
blueprints_enum	-state
blueprints_enum	timestamp
blueprints_enum	-timestamp
blueprints_enum	type
blueprints_enum	-type
blueprints_enum	version
blueprints_enum	-version

dashboards_enum

"category"

dashboards_enum

Properties

Name	Type	Required	Restrictions	Description
dashboards_enum	string	false	none	none

Enumerated Values

Property	Value
dashboards_enum	category
dashboards_enum	-category
dashboards_enum	description
dashboards_enum	-description
dashboards_enum	folder
dashboards_enum	-folder
dashboards_enum	name
dashboards_enum	-name
dashboards_enum	saved_time
dashboards_enum	-saved_time
dashboards_enum	timestamp
dashboards_enum	-timestamp
dashboards_enum	usecase
dashboards_enum	-usecase
dashboards_enum	version
dashboards_enum	-version
dashboards_enum	versions_count
dashboards_enum	-versions_count

datasets_enum

"folder"

datasets_enum

Properties

Name	Type	Required	Restrictions	Description
datasets_enum	string	false	none	none

Enumerated Values

Property	Value
datasets_enum	folder
datasets_enum	-folder
datasets_enum	format
datasets_enum	-format
datasets_enum	mem_size_mb
datasets_enum	-mem_size_mb
datasets_enum	name
datasets_enum	-name
datasets_enum	num_columns
datasets_enum	-num_columns
datasets_enum	num_rows
datasets_enum	-num_rows
datasets_enum	saved_time
datasets_enum	-saved_time
datasets_enum	schema
datasets_enum	-schema
datasets_enum	timestamp
datasets_enum	-timestamp

draft_pipelines_enum

"category"

draft_pipelines_enum

Properties

Name	Type	Required	Restrictions	Description
draft_pipelines_enum	string	false	none	none

Enumerated Values

Property	Value
draft_pipelines_enum	category
draft_pipelines_enum	-category
draft_pipelines_enum	description
draft_pipelines_enum	-description
draft_pipelines_enum	folder
draft_pipelines_enum	-folder
draft_pipelines_enum	name
draft_pipelines_enum	-name
draft_pipelines_enum	saved_time
draft_pipelines_enum	-saved_time
draft_pipelines_enum	timestamp
draft_pipelines_enum	-timestamp
draft_pipelines_enum	usercase
draft_pipelines_enum	-usercase
draft_pipelines_enum	version
draft_pipelines_enum	-version
draft_pipelines_enum	version_count
draft_pipelines_enum	-version_count

pipelines_enum

"category"

pipelines_enum

Properties

Name	Type	Required	Restrictions	Description
pipelines_enum	string	false	none	none

Enumerated Values

Property	Value
pipelines_enum	category
pipelines_enum	-category
pipelines_enum	description
pipelines_enum	-description
pipelines_enum	folder
pipelines_enum	-folder
pipelines_enum	name
pipelines_enum	-name
pipelines_enum	saved_time
pipelines_enum	-saved_time
pipelines_enum	timestamp
pipelines_enum	-timestamp
pipelines_enum	usercase
pipelines_enum	-usercase
pipelines_enum	version
pipelines_enum	-version
pipelines_enum	version_count
pipelines_enum	-version_count

pstreams_enum

"collection_status"

pstreams_enum

Properties

Name	Type	Required	Restrictions	Description
pstreams_enum	string	false	none	none

Enumerated Values

Property	Value
pstreams_enum	collection_status
pstreams_enum	-collection_status
pstreams_enum	database
pstreams_enum	-database
pstreams_enum	datastore_type
pstreams_enum	-datastore_type
pstreams_enum	index_name
pstreams_enum	-index_name
pstreams_enum	name
pstreams_enum	-name
pstreams_enum	retention_days
pstreams_enum	-retention_days
pstreams_enum	saved_time
pstreams_enum	-saved_time
pstreams_enum	system_defined
pstreams_enum	-system_defined
pstreams_enum	timestamp
pstreams_enum	-timestamp

cloudfabrix / api-postman

readme

CloudFabrix RDA Platform API v3.2.2

Authentication

Login into api server. (Run this first)

Parameters

Responses

Users

Get current logged in user details

Responses

Get all users

Responses

Add user

Parameters

Responses

Response Schema

Change User Activation Status

Parameters

Responses

Response Schema

Change User group

Parameters

Responses

Response Schema

Dashboards

Fetch meta data for dashboards

Parameters

Responses

Datasets

Fetch meta data about datasets

Parameters

Responses

Add a dataset

Parameters

Responses

Response Schema

Delete a dataset

Parameters

Responses

Response Schema

Get data of a dataset

Parameters

Responses

Update rows of a dataset

Parameters

Responses

Response Schema

Delete matching dataset rows

Parameters

Responses

Response Schema

Delete enitre data of a dataset

Parameters

Responses

Response Schema

Persistent Streams

Fetch meta data about pstreams

Parameters

Responses

Add a pstream

Parameters

Responses

Response Schema

Edit attributes of a pstream

Parameters

Responses

Response Schema

Delete a pstream.

Parameters

Responses

Response Schema

Get data of a pstream

Parameters

Responses

Pipelines

Fetch meta data about pipelines

Parameters

Responses

Fetch meta data about draft pipelines

Parameters