{"openapi":"3.1.0","info":{"title":"Fabrix.ai RDA Platform API","description":"Fabrix.ai RDA Platform API","version":"8.0"},"paths":{"/api/v2/login":{"post":{"tags":["Authentication"],"summary":"Login into api server. (Run this first)","description":"Login into api server. (Run this first)","operationId":"login","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginInput"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/current_user":{"get":{"tags":["Users"],"summary":"Get current logged in user details","description":"Get the details of the current user","operationId":"get_current_user","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserDetails"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/users":{"get":{"tags":["Users"],"summary":"Get all users","description":"Get all the users belonging to the same tenant as the current user","operationId":"get_tenant_users","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Users"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["Users"],"summary":"Add user","description":"Add a user","operationId":"add_tenant_user","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserAddModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/users/user/{id}/status":{"put":{"tags":["Users"],"summary":"Change User Activation Status","description":"Activate/Deactivate User. Deactivating currently logged in user is not allowed.","operationId":"change_user_status","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"ID of the user to be activated/deactivated","title":"Id"},"description":"ID of the user to be activated/deactivated"},{"name":"activate","in":"query","required":true,"schema":{"type":"boolean","description":"Desired user status: Activate (True) or Deactivate(False)","title":"Activate"},"description":"Desired user status: Activate (True) or Deactivate(False)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/users/user/{id}":{"delete":{"tags":["Users"],"summary":"Delete User","description":"Delete user. Note that only inactive users can be deleted.","operationId":"delete_user","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"ID of the user to be deleted","title":"Id"},"description":"ID of the user to be deleted"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/users/user/{id}/group":{"put":{"tags":["Users"],"summary":"Change User group","description":"Change user group. Changing currently logged in user is not allowed.","operationId":"change_user_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"ID of the user to be activated/deactivated","title":"Id"},"description":"ID of the user to be activated/deactivated"},{"name":"group","in":"query","required":true,"schema":{"type":"string","description":"New group for the user.","title":"Group"},"description":"New group for the user."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/dashboards":{"get":{"tags":["Dashboards"],"summary":"Fetch meta data for dashboards","description":"Fetch meta data for dashboards","operationId":"get_dashboards","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'description', 'usecase', 'category', 'version']","title":"Search"},"description":"search across fields: ['name', 'description', 'usecase', 'category', 'version']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/dashboards_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Dashboards"],"summary":"Add a dashboard","description":"Add dashboard","operationId":"add_dashboard","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/datasets":{"get":{"tags":["Datasets"],"summary":"Fetch meta data about datasets","description":"Fetch meta data about datasets","operationId":"get_datasets","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'schema']","title":"Search"},"description":"search across fields: ['name', 'schema']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/datasets_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Datasets"],"summary":"Add a dataset","description":"Add a dataset.","operationId":"add_dataset","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetAddResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pstreams":{"get":{"tags":["Persistent Streams"],"summary":"Fetch meta data about pstreams","description":"Fetch meta data about pstreams","operationId":"get_pstreams","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name']","title":"Search"},"description":"search across fields: ['name']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/pstreams_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Persistent Streams"],"summary":"Add a pstream","description":"Add a new pstream to the system","operationId":"add_pstream","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamAddResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines":{"get":{"tags":["Pipelines"],"summary":"Fetch meta data about pipelines","description":"Fetch meta data about pipelines","operationId":"get_pipelines","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'description']","title":"Search"},"description":"search across fields: ['name', 'description']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/main__pipelines_enum__1"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Pipelines"],"summary":"Add a published pipeline","description":"Add a new published pipeline.","operationId":"add_published_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"query","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"},{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"Category","title":"Category"},"description":"Category"},{"name":"usecase","in":"query","required":false,"schema":{"type":"string","description":"Usecase","title":"Usecase"},"description":"Usecase"},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Pipeline Folder name","default":"Default","title":"Folder"},"description":"Pipeline Folder name"},{"name":"skip_verification","in":"query","required":false,"schema":{"type":"boolean","description":"Enable to skip verification","default":false,"title":"Skip Verification"},"description":"Enable to skip verification"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker","default":"*","title":"Sites"},"description":"Regular expression to select worker"}],"requestBody":{"required":true,"content":{"text/plain":{"schema":{"type":"string","description":"Pipeline content","title":"Pipeline Content"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPublishedPipelineModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/draft":{"get":{"tags":["Pipelines"],"summary":"Fetch meta data about draft pipelines","description":"Fetch meta data about draft pipelines","operationId":"get_draft_pipelines","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'description']","title":"Search"},"description":"search across fields: ['name', 'description']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/draft_pipelines_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Pipelines"],"summary":"Add a draft pipeline","description":"Add a new draft pipeline.","operationId":"add_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"query","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"query","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"},{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"Category","title":"Category"},"description":"Category"},{"name":"usecase","in":"query","required":false,"schema":{"type":"string","description":"Usecase","title":"Usecase"},"description":"Usecase"},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Pipeline Folder name","default":"Default","title":"Folder"},"description":"Pipeline Folder name"},{"name":"skip_verification","in":"query","required":false,"schema":{"type":"boolean","description":"Enable to skip verification","default":false,"title":"Skip Verification"},"description":"Enable to skip verification"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker","default":"*","title":"Sites"},"description":"Regular expression to select worker"}],"requestBody":{"required":true,"content":{"text/plain":{"schema":{"type":"string","description":"Pipeline content","title":"Pipeline Content"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDraftPipelineModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/blueprints":{"get":{"tags":["Blueprints"],"summary":"Fetch meta data about blueprints","description":"Fetch meta data about blueprints","operationId":"get_blueprints","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'comment']","title":"Search"},"description":"search across fields: ['name', 'comment']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/blueprints_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Blueprints"],"summary":"Add a blueprint","description":"Add a new blueprint.","operationId":"add_a_blueprint","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddBlueprintModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEditBlueprintResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/credentials":{"get":{"tags":["Credentials"],"summary":"Fetch meta data about credentials","description":"Fetch meta data about credentials","operationId":"get_secrets","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'type', 'typeDescription']","title":"Search"},"description":"search across fields: ['name', 'type', 'typeDescription']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/credentials_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Credentials"],"summary":"Add a credential","description":"Add a new credential.","operationId":"add_credential","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCredentialsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/rda_packs":{"get":{"tags":["Rda Packs"],"summary":"Fetch meta data about packs","description":"Fetch meta data about packs","operationId":"get_packs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['id', 'name', 'type', 'version', 'scope', 'publisher', 'status']","title":"Search"},"description":"search across fields: ['id', 'name', 'type', 'version', 'scope', 'publisher', 'status']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/rda_packs_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/textfsms":{"get":{"tags":["TextFsm Template"],"summary":"Fetch meta data about TextFsm","description":"Fetch meta data about TextFsm","operationId":"get_textfsm","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['name', 'type', 'folder', 'description']","title":"Search"},"description":"search across fields: ['name', 'type', 'folder', 'description']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/textfsm_enum"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["TextFsm Template"],"summary":"Add a textfsm template","description":"Add a TextFSM Template","operationId":"add_textfsm","security":[{"APIKeyHeader":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateAddResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/traces":{"get":{"tags":["Pipelines"],"summary":"Fetch traces for pipelines","description":"Fetch traces for pipelines","operationId":"get_pipelines_traces","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['pipeline_name', 'jobid', 'status_type', 'bot', 'query']","title":"Search"},"description":"search across fields: ['pipeline_name', 'jobid', 'status_type', 'bot', 'query']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/main__pipelines_enum__2"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/logs":{"get":{"tags":["Pipelines"],"summary":"Fetch logs for pipelines","description":"Fetch logs for pipelines","operationId":"get_pipelines_logs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['pipeline_name', 'jobid', 'message']","title":"Search"},"description":"search across fields: ['pipeline_name', 'jobid', 'message']"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/main__pipelines_enum__3"}},{"type":"null"}],"description":"Sort the output based on given fields","default":["-timestamp"],"title":"Sort"},"description":"Sort the output based on given fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/datasets/dataset/{name}":{"delete":{"tags":["Datasets"],"summary":"Delete a dataset","description":"Delete a dataset. Please note that all the data of the dataset will be deleted and can not be undone.","operationId":"delete_dataset","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Dataset name to be deleted.","title":"Name"},"description":"Dataset name to be deleted."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/datasets/dataset/{name}/data":{"get":{"tags":["Datasets"],"summary":"Get data of a dataset","description":"Get data of a dataset","operationId":"get_dataset_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dataset","title":"Name"},"description":"Name of the dataset"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['pipeline_name', 'jobid', 'message']","title":"Search"},"description":"search across fields: ['pipeline_name', 'jobid', 'message']"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Datasets"],"summary":"Update rows of a dataset","description":"Update (merge or replace) existing dataset data.\n    This function currently does not support deleting rows.<br/>\n    If replace is true, entire existing dataset data is replaced with the new data in input.<br/>\n    If replace is false, <br/>\n    <ul>\n        <li>If keys are not given, the input data is appened to the existing dataset.\n        <li>If keys are given then the following flow explains the operation<br/>\n            For each row in the input data:\n            <ul>\n                <li>The rows with same values for all the keys are replaced with input row.\n                <li>Other rows are appended to the existing dataset\n            </ul>\n        Error raised when:\n            <ul>\n                <li>If there are duplicate rows in input data with same key values\n                <li>If any key passed in keys is not present as a column in the input data\n            </ul>\n    </ul>\n    NOTE: This directly updates the dataset and all drafts are removed.","operationId":"update_dataset_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dataset","title":"Name"},"description":"Name of the dataset"},{"name":"replace","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"If set to true, replace the existing data with new data","default":false,"title":"Replace"},"description":"If set to true, replace the existing data with new data"},{"name":"keys","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Array of keys to match for updating rows","title":"Keys"},"description":"Array of keys to match for updating rows"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"},"description":"List of dictionaries to replace/merge with existing data","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetUpdateResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Datasets"],"summary":"Delete matching dataset rows","description":"Delete dataset rows matching the input data\n    All the rows in existing dataset that match all the keys in input data are deleted.\n    NOTE: This directly updates the dataset and all drafts are removed.","operationId":"delete_dataset_rows","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dataset","title":"Name"},"description":"Name of the dataset"},{"name":"keys","in":"query","required":true,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Array of keys to match for updating rows","title":"Keys"},"description":"Array of keys to match for updating rows"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"},"description":"List of dictionaries to replace/merge with existing data","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDeleteRowResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/datasets/dataset/{name}/data/all":{"delete":{"tags":["Datasets"],"summary":"Delete enitre data of a dataset","description":"Delete entire data of a dataset","operationId":"delete_dataset_all_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dataset","title":"Name"},"description":"Name of the dataset"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DatasetDeleteAllDataResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pstreams/pstream/{name}":{"put":{"tags":["Persistent Streams"],"summary":"Edit attributes of a pstream","description":"Edit the attributes of a persistent stream","operationId":"edit_pstream","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream to be edited","title":"Name"},"description":"Name of the pstream to be edited"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamEditModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamEditResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Persistent Streams"],"summary":"Delete a pstream.","description":"Delete a persistent stream.","operationId":"delete_pstream","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream to be deleted","title":"Name"},"description":"Name of the pstream to be deleted"},{"name":"delete_data","in":"query","required":false,"schema":{"type":"boolean","description":"Delete data as well. If data is not deleted, adding the same pstream again will add the old data back.","default":false,"title":"Delete Data"},"description":"Delete data as well. If data is not deleted, adding the same pstream again will add the old data back."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pstreams/pstream/{name}/data":{"get":{"tags":["Persistent Streams"],"summary":"Get data of a pstream","description":"Get data of a persistent stream","operationId":"get_pstream_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream","title":"Name"},"description":"Name of the pstream"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"group_by","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Group the results by values of the given columns","title":"Group By"},"description":"Group the results by values of the given columns"},{"name":"aggs","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Run the results through aggregate function. The expected format is function:column:label Where label is optional.(e.g. sum:duration, value_count:count_:Record_Count)","title":"Aggs"},"description":"Run the results through aggregate function. The expected format is function:column:label Where label is optional.(e.g. sum:duration, value_count:count_:Record_Count)"},{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"search across fields: ['pipeline_name', 'jobid', 'message']","title":"Search"},"description":"search across fields: ['pipeline_name', 'jobid', 'message']"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TableReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Persistent Streams"],"summary":"Add data to an existing pstream","description":"Add new data to an existing persistent stream (pstream), merging it with any previously existing data.","operationId":"publish_to_pstream","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream","title":"Name"},"description":"Name of the pstream"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"object"},"description":"Array data, Appends the provided data array to the specified pstream","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishDataPstreamResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Persistent Streams"],"summary":"Update data in a pstream by query","description":"Update specific data within an existing persistent stream (pstream) based on a query.","operationId":"update_pstream_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream","title":"Name"},"description":"Name of the pstream"},{"name":"cfxql_query","in":"query","required":true,"schema":{"type":"string","description":"CFXQL Query, Use CFXQL query to locate entries in the pstream and update them with the provided data.","title":"Cfxql Query"},"description":"CFXQL Query, Use CFXQL query to locate entries in the pstream and update them with the provided data."},{"name":"conflicts","in":"query","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/ConflictsOption"}],"description":"What to do when the update-by-query hits version conflicts?","default":"abort","title":"Conflicts"},"description":"What to do when the update-by-query hits version conflicts?"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Data to be updated in the pstream","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePstreamDataResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Persistent Streams"],"summary":"Delete specific data from a pstream","description":"Delete specific data from an existing persistent stream (pstream) based on a query.","operationId":"delete_pstream_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream","title":"Name"},"description":"Name of the pstream"},{"name":"cfxql_query","in":"query","required":true,"schema":{"type":"string","description":"CFXQL Query, Use CFXQL query to locate entries in the pstream and delete data.","title":"Cfxql Query"},"description":"CFXQL Query, Use CFXQL query to locate entries in the pstream and delete data."},{"name":"conflicts","in":"query","required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/ConflictsOption"}],"description":"What to do when the delete by query hits version conflicts?","default":"abort","title":"Conflicts"},"description":"What to do when the delete by query hits version conflicts?"},{"name":"case_sensitive","in":"query","required":false,"schema":{"type":"boolean","description":"Use this option to enable or disable text case sensitive search","default":true,"title":"Case Sensitive"},"description":"Use this option to enable or disable text case sensitive search"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePstreamDataResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/dashboards/dashboard/{dashboard_id}":{"put":{"tags":["Dashboards"],"summary":"Update a dashboard. Note: If the dashboard does not exist, it will be added to the system.","description":"Update dashboard","operationId":"edit_dashboard","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","description":"Name of the dashboard to update","title":"Dashboard Id"},"description":"Name of the dashboard to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardAddModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dashboards"],"summary":"Delete a dashboard","description":"Delete dashboard","operationId":"delete_dashboard","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"dashboard_id","in":"path","required":true,"schema":{"type":"string","title":"Dashboard Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/{name}/traces":{"get":{"tags":["Pipelines"],"summary":"Get traces of a pipeline","description":"Get traces of a pipeline","operationId":"get_pipeline_traces","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pipeline","title":"Name"},"description":"Name of the pipeline"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineTracesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/{name}/version/{version}/traces":{"get":{"tags":["Pipelines"],"summary":"Get traces for a pipeline version","description":"Get traces for a specific version of a pipeline","operationId":"get_pipeline_version_traces","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pipeline","title":"Name"},"description":"Name of the pipeline"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Version of the pipeline","title":"Version"},"description":"Version of the pipeline"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersionTracesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/{name}/logs":{"get":{"tags":["Pipelines"],"summary":"Get logs of a pipeline","description":"Get logs of a pipeline","operationId":"get_pipeline_logs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pipeline","title":"Name"},"description":"Name of the pipeline"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineLogsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/{name}/version/{version}/logs":{"get":{"tags":["Pipelines"],"summary":"Get logs for a pipeline version","description":"Get logs for a specific version of a pipeline","operationId":"get_pipeline_version_logs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pipeline","title":"Name"},"description":"Name of the pipeline"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Version of the pipeline","title":"Version"},"description":"Version of the pipeline"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineVersionLogsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/pipeline/{name}/versions":{"get":{"tags":["Pipelines"],"summary":"Get all versions of a published pipeline","description":"Get all versions of a published pipeline","operationId":"get_published_pipeline_versions","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pipeline","title":"Name"},"description":"Name of the pipeline"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishedPipelineVersionsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/draft/{name}/versions":{"get":{"tags":["Pipelines"],"summary":"Get all versions of a draft pipeline","description":"Get all versions of a draft pipeline","operationId":"get_draft_pipeline_versions","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pipeline","title":"Name"},"description":"Name of the pipeline"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DraftPipelineVersionsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/pipeline/{name}/version/{version}":{"get":{"tags":["Pipelines"],"summary":"Get a published pipeline version","description":"Get a specific version of a published pipeline","operationId":"get_published_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPipelineContentResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Pipelines"],"summary":"Delete a published pipeline version","description":"Delete a specific version of a published pipeline","operationId":"delete_published_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePipelineResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/draft/{name}/version/{version}":{"get":{"tags":["Pipelines"],"summary":"Get a draft pipeline version","description":"Get a specific version of a draft pipeline","operationId":"get_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPipelineContentResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Pipelines"],"summary":"Delete a draft pipeline version","description":"Delete a specific version of a draft pipeline.","operationId":"delete_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePipelineResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/pipeline/{name}/version/{version}/run":{"post":{"tags":["Pipelines"],"summary":"Run a Published Pipeline","description":"Run a published pipeline with given verison","operationId":"run_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"},{"name":"enable_tracing","in":"query","required":false,"schema":{"type":"boolean","description":"Enable ability to view traces of bots during the execution","default":true,"title":"Enable Tracing"},"description":"Enable ability to view traces of bots during the execution"},{"name":"enable_logging","in":"query","required":false,"schema":{"type":"boolean","description":"Enable ability to view log messages during the execution","default":true,"title":"Enable Logging"},"description":"Enable ability to view log messages during the execution"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker to run the pipeline","default":"*","title":"Sites"},"description":"Regular expression to select worker to run the pipeline"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PipelineAddModel"},{"type":"array","items":{"type":"object"}}],"description":"Input data and run context for the pipeline","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunPipelineResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/organizations":{"get":{"tags":["Organizations"],"summary":"Get Organizations","description":"Get Organizations","operationId":"get_organizations","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsGetResponseModel"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["Organizations"],"summary":"Add Organization","description":"Add Organization","operationId":"add_organization","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsAddResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/user_groups":{"get":{"tags":["UserGroups"],"summary":"Get all user groups","description":"Get all the user groups belonging to the same tenant as the current user","operationId":"get_user_groups","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupGetResponseModel"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["UserGroups"],"summary":"Add user group","description":"Add a user group","operationId":"add_user_group","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupAddModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupAddResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/user_groups/user_group/{name}":{"put":{"tags":["UserGroups"],"summary":"Edit user group","description":"Edit a user group","operationId":"edit_user_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the user group to modify","title":"Name"},"description":"Name of the user group to modify"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupEditModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupEditResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["UserGroups"],"summary":"Delete user group","description":"Delete a user group","operationId":"delete_user_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the user group to delete","title":"Name"},"description":"Name of the user group to delete"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserGroupDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/dashboard_groups":{"get":{"tags":["Dashboard Groups"],"summary":"Get all dashboard groups","description":"Get all dashboard groups","operationId":"get_dashboard_groups","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"title":"Response Get Dashboard Groups"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["Dashboard Groups"],"summary":"Add dashboard group","description":"Add a dashboard group","operationId":"add_dashboard_group","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGroupAddModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/dashboard_groups/dashboard_group/{name}":{"put":{"tags":["Dashboard Groups"],"summary":"Edit dashboard group. Note: If the Dashboard Group does not exist, it will be added to the system.","description":"Edit a dashboard group","operationId":"edit_dashboard_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dashboard group to modify","title":"Name"},"description":"Name of the dashboard group to modify"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGroupEditModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Dashboard Groups"],"summary":"Delete dashboard group","description":"Delete a dashboard group","operationId":"delete_dashboard_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dashboard group to delete","title":"Name"},"description":"Name of the dashboard group to delete"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGroupDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/dashboard_groups/dashboard_group/{name}/status":{"put":{"tags":["Dashboard Groups"],"summary":"Activate/Deactivate a dashboard group","description":"Activate/Deactivate a dashboard group","operationId":"status_dashboard_group","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the dashboard group","title":"Name"},"description":"Name of the dashboard group"},{"name":"activate","in":"query","required":true,"schema":{"type":"boolean","description":"Desired dashboard group status: Activate (True) or Deactivate(False)","title":"Activate"},"description":"Desired dashboard group status: Activate (True) or Deactivate(False)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardGroupStatusUpdateResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/organizations/organization/{id}":{"put":{"tags":["Organizations"],"summary":"Edit Organization","description":"Edit the name and description of an organization. Changing the tag of the organization is not allowed.","operationId":"edit_organization","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"ID of the Organization to be updated","title":"Id"},"description":"ID of the Organization to be updated"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationEditModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsEditResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Organizations"],"summary":"Delete Organizations.","description":"Delete Organization.","operationId":"delete_organization","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"ID of the Organization to be deleted","title":"Id"},"description":"ID of the Organization to be deleted"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationsDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/users/resetpassword":{"post":{"tags":["Users"],"summary":"Reset Password will be enabled when user logged in with default password only","description":"Reset Password will be enabled when user logged in with default password only","operationId":"resetPassword","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResetPasswordModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/pipelines/draft/{name}/version/{version}/run":{"post":{"tags":["Pipelines"],"summary":"Run a Draft Pipeline","description":"Run a draft pipeline with given verison","operationId":"run_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Pipeline version","title":"Version"},"description":"Pipeline version"},{"name":"enable_tracing","in":"query","required":false,"schema":{"type":"boolean","description":"Enable ability to view traces of bots during the execution","default":true,"title":"Enable Tracing"},"description":"Enable ability to view traces of bots during the execution"},{"name":"enable_logging","in":"query","required":false,"schema":{"type":"boolean","description":"Enable ability to view log messages during the execution","default":true,"title":"Enable Logging"},"description":"Enable ability to view log messages during the execution"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker to run the pipeline","default":"*","title":"Sites"},"description":"Regular expression to select worker to run the pipeline"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/PipelineAddModel"},{"type":"array","items":{"type":"object"}}],"description":"Input data and run context for the pipeline","title":"Data"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunPipelineResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/pipeline/{name}":{"put":{"tags":["Pipelines"],"summary":"Edit a published pipeline. Note: If the Pipeline does not exist, it will be added to the system.","description":"Edit a published pipeline.","operationId":"edit_published_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"query","required":true,"schema":{"type":"string","description":"Pipeline version, changes are added with the version provided and can be new version or existing version.","title":"Version"},"description":"Pipeline version, changes are added with the version provided and can be new version or existing version."},{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"Category","title":"Category"},"description":"Category"},{"name":"usecase","in":"query","required":false,"schema":{"type":"string","description":"Usecase","title":"Usecase"},"description":"Usecase"},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Pipeline folder name","default":"Default","title":"Folder"},"description":"Pipeline folder name"},{"name":"skip_verification","in":"query","required":false,"schema":{"type":"boolean","description":"Enable to skip verification","default":false,"title":"Skip Verification"},"description":"Enable to skip verification"},{"name":"publish","in":"query","required":false,"schema":{"type":"boolean","description":"By default, new pipeline content is added to a draft pipeline and the current published pipeline will be unchanged. Set the publish to True to publish immediately after a successful update.","default":false,"title":"Publish"},"description":"By default, new pipeline content is added to a draft pipeline and the current published pipeline will be unchanged. Set the publish to True to publish immediately after a successful update."},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker","default":"*","title":"Sites"},"description":"Regular expression to select worker"}],"requestBody":{"required":true,"content":{"text/plain":{"schema":{"type":"string","description":"Pipeline content","title":"Pipeline Content"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddPublishedPipelineModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Pipelines"],"summary":"Delete all versions of a published pipeline","description":"Delete all versions of a published pipeline.","operationId":"delete_all_versions_published_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePipelineResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/draft/{name}":{"put":{"tags":["Pipelines"],"summary":"Edit a draft pipeline. Note: If the Pipeline does not exist, it will be added to the system.","description":"Edit a draft pipeline.","operationId":"edit_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"},{"name":"version","in":"query","required":true,"schema":{"type":"string","description":"Pipeline version, changes are added with the version provided and can be new version or existing version.","title":"Version"},"description":"Pipeline version, changes are added with the version provided and can be new version or existing version."},{"name":"category","in":"query","required":false,"schema":{"type":"string","description":"Category","title":"Category"},"description":"Category"},{"name":"usecase","in":"query","required":false,"schema":{"type":"string","description":"Usecase","title":"Usecase"},"description":"Usecase"},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Pipeline folder name","default":"Default","title":"Folder"},"description":"Pipeline folder name"},{"name":"skip_verification","in":"query","required":false,"schema":{"type":"boolean","description":"Enable to skip verification","default":false,"title":"Skip Verification"},"description":"Enable to skip verification"},{"name":"publish","in":"query","required":false,"schema":{"type":"boolean","description":"By default, new pipeline content is added to a draft pipeline and the current published pipeline will be unchanged. Set the publish to True to publish immediately after a successful update.","default":false,"title":"Publish"},"description":"By default, new pipeline content is added to a draft pipeline and the current published pipeline will be unchanged. Set the publish to True to publish immediately after a successful update."},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker","default":"*","title":"Sites"},"description":"Regular expression to select worker"}],"requestBody":{"required":true,"content":{"text/plain":{"schema":{"type":"string","description":"Pipeline content","title":"Pipeline Content"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddDraftPipelineModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Pipelines"],"summary":"Delete all versions of a draft pipeline","description":"Delete all versions of a draft pipeline.","operationId":"delete_all_versions_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Pipeline name","title":"Name"},"description":"Pipeline name"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeletePipelineResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pipelines/draft/{name}/version/{version}/publish":{"post":{"tags":["Pipelines"],"summary":"Publish a draft pipeline","description":"Publish a draft pipeline","operationId":"publish_draft_pipeline","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Draft Pipeline name","title":"Name"},"description":"Draft Pipeline name"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Existing draft pipeline version","title":"Version"},"description":"Existing draft pipeline version"},{"name":"folder","in":"query","required":false,"schema":{"type":"string","description":"Publish folder name","default":"Default","title":"Folder"},"description":"Publish folder name"},{"name":"publish_version","in":"query","required":false,"schema":{"type":"string","description":"Publish version, the pipeline will be published with existing draft pipeline version if publish version is not provided","title":"Publish Version"},"description":"Publish version, the pipeline will be published with existing draft pipeline version if publish version is not provided"},{"name":"skip_verification","in":"query","required":false,"schema":{"type":"boolean","description":"Enable to skip verification","default":false,"title":"Skip Verification"},"description":"Enable to skip verification"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker","default":"*","title":"Sites"},"description":"Regular expression to select worker"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishDraftPipelineModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/blueprints/blueprint/{id}":{"get":{"tags":["Blueprints"],"summary":"Get a blueprint","description":"Get a blueprint","operationId":"get_blueprint","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Id of the blueprint","title":"Id"},"description":"Id of the blueprint"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlueprintResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Blueprints"],"summary":"Edit a blueprint. Note: If the Blueprint does not exist, it will be added to the system.","description":"Edit an existing blueprint.","operationId":"edit_blueprint","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Id of the blueprint","title":"Id"},"description":"Id of the blueprint"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditBlueprintModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddEditBlueprintResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Blueprints"],"summary":"Delete a blueprint","description":"Delete a specific blueprint","operationId":"delete_blueprint","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Id of the blueprint","title":"Id"},"description":"Id of the blueprint"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteBlueprintModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/blueprints/blueprint/{id}/status":{"put":{"tags":["Blueprints"],"summary":"Enable/Disable an existing blueprint","description":"Enable/Disable an existing blueprint.","operationId":"change_blueprint_status","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Id of the blueprint","title":"Id"},"description":"Id of the blueprint"},{"name":"status","in":"query","required":true,"schema":{"allOf":[{"$ref":"#/components/schemas/BlueprintStatusOption"}],"description":"Choose (Enable/Disable) to change status of a blueprint","title":"Status"},"description":"Choose (Enable/Disable) to change status of a blueprint"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlueprintStatusModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/blueprints/blueprint/{name}/{id}/audit/":{"get":{"tags":["Blueprints"],"summary":"Get blueprint audit report","description":"Get blueprint audit report","operationId":"get_aduit_report","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the blueprint","title":"Name"},"description":"Name of the blueprint"},{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Id of the blueprint","title":"Id"},"description":"Id of the blueprint"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlueprintAuditReportModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/blueprints/blueprint/{id}/artifacts/":{"get":{"tags":["Blueprints"],"summary":"Get blueprint artifact dependencies report","description":"Get blueprint artifact dependencies report","operationId":"get_artifact_report","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"Id of the blueprint","title":"Id"},"description":"Id of the blueprint"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetBlueprintArtifactDependenciesModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/credentials/credential/{name}":{"get":{"tags":["Credentials"],"summary":"Get a credential","description":"Get a credential","operationId":"get_credential","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the credential","title":"Name"},"description":"Name of the credential"},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"Type of the credential","title":"Type"},"description":"Type of the credential"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCredentialResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Credentials"],"summary":"Edit a credential. Note: If the Credential does not exist, it will be added to the system.","description":"Edit an existing credential by updating its configuration or authentication details.","operationId":"edit_credential","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the credential to edit","title":"Name"},"description":"Name of the credential to edit"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialEditModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCredentialsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Credentials"],"summary":"Delete a credential","description":"Delete a specified credential.","operationId":"delete_credential","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the credential to delete","title":"Name"},"description":"Name of the credential to delete"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeleteCredentialResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/credentials/credential/{name}/verify":{"post":{"tags":["Credentials"],"summary":"Verify connectivity and credential validity","description":"Check connectivity and verify the credentials, ensuring that connectivity is established and credentials are valid.","operationId":"check_connectivity","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the credential","title":"Name"},"description":"Name of the credential"},{"name":"sites","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Regular expression to select worker","default":"*","title":"Sites"},"description":"Regular expression to select worker"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyCredentialsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/credentials/types":{"get":{"tags":["Credentials"],"summary":"Get all credential types","description":"Get all available credential types.","operationId":"get_credential_types","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialTypes"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/credentials/types/{type}":{"get":{"tags":["Credentials"],"summary":"Get fields of a credential type","description":"Get the fields required for a specific credential type.","operationId":"get_credential_type_fields","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"type","in":"path","required":true,"schema":{"type":"string","description":"Type of the particular credential to get the fields","title":"Type"},"description":"Type of the particular credential to get the fields"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CredentialTypeFields"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pstreams/pstream/{name}/metadata":{"get":{"tags":["Persistent Streams"],"summary":"Get metadata of a pstream","description":"Get metadata of a persistent stream","operationId":"get_pstream_metadata","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream","title":"Name"},"description":"Name of the pstream"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamMetadataResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/pstreams/pstream/{name}/stats":{"get":{"tags":["Persistent Streams"],"summary":"Get stats of a pstream","description":"Get stats of a persistent stream","operationId":"get_pstream_stats","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the pstream","title":"Name"},"description":"Name of the pstream"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PstreamStatsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/textfsms/textfsm/{name}/view":{"get":{"tags":["TextFsm Template"],"summary":"View textfsm template","description":"View textfsm template","operationId":"get_textfsm_template_data","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the TextFSM template","title":"Name"},"description":"Name of the TextFSM template"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateViewResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/textfsms/validate_template":{"post":{"tags":["TextFsm Template"],"summary":"validate a textfsm template","description":"Validate a TextFSM Template","operationId":"validate_textfsm_template","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateValidateModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateValidateResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/textfsms/textfsm/{name}":{"put":{"tags":["TextFsm Template"],"summary":"Update a TextFsm template","description":"Update a TextFsm Template","operationId":"update_textfsm","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the TextFSM template","title":"Name"},"description":"Name of the TextFSM template"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateUpdateModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateUpdateResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["TextFsm Template"],"summary":"Delete a textfsm template","description":"Delete a TextFsm Template","operationId":"delete_textfsm","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the TextFSM template","title":"Name"},"description":"Name of the TextFSM template"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TextFsmTemplateDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/rda_packs/rda_pack/upload":{"post":{"tags":["Rda Packs"],"summary":"Upload a RDA pack","description":"Upload a RDA pack","operationId":"upload_rda_pack_api_v2_rda_packs_rda_pack_upload_post","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_rda_pack_api_v2_rda_packs_rda_pack_upload_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdaPacksUploadResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/api/v2/rda_packs/rda_pack/{name}/{version}/status":{"put":{"tags":["Rda Packs"],"summary":"Activate/Deactivate an RDA pack with specified name and version","description":"Activate/Deactivate an RDA pack","operationId":"status_rda_pack","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the RDA pack","title":"Name"},"description":"Name of the RDA pack"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Version of the RDA pack","title":"Version"},"description":"Version of the RDA pack"},{"name":"activate","in":"query","required":true,"schema":{"type":"boolean","description":"Desired Pack status: Activate (True) or Deactivate(False)","title":"Activate"},"description":"Desired Pack status: Activate (True) or Deactivate(False)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdaPacksStatusUpdateResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/rda_packs/rda_pack/{name}/{version}/delete":{"delete":{"tags":["Rda Packs"],"summary":"Delete an RDA pack with specified name and version","description":"Delete an RDA pack","operationId":"delete_rda_pack","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the RDA pack","title":"Name"},"description":"Name of the RDA pack"},{"name":"version","in":"path","required":true,"schema":{"type":"string","description":"Version of the RDA pack","title":"Version"},"description":"Version of the RDA pack"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RdaPacksDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/farbic_health/workers":{"get":{"tags":["Fabric Health"],"summary":"Get details of worker pods running on the system","description":"Get worker details","operationId":"get_workers","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetWorkerResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/farbic_health/agents/rda_agents":{"get":{"tags":["Fabric Health"],"summary":"Get details of RDA Agents","description":"Get agents details","operationId":"get_agents","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetAgentsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/farbic_health/agents/event_gateways/endpoints":{"get":{"tags":["Fabric Health"],"summary":"Get event gateway endpoint details","description":"Get event gateway endpoint details","operationId":"get_event_gw_endpoint","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetEventGwEndpointResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/farbic_health/microservices/core":{"get":{"tags":["Fabric Health"],"summary":"Get details of microservices that belong to core RDAF platform","description":"Get core microservices","operationId":"get_core_microservices","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetCoreMicroservicesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/farbic_health/microservices/app":{"get":{"tags":["Fabric Health"],"summary":"Get details of micro services belonging to Applications (e.g. OIA)","description":"Get app microservices","operationId":"get_app_microservices","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetAppMircroservicesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/farbic_health/usage":{"get":{"tags":["Fabric Health"],"summary":"Get fabric usage","description":"Get fabric uisage","operationId":"get_fabric_usage","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetFabricUsageResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/jobs":{"get":{"tags":["Jobs"],"summary":"Get jobs deatils","description":"Get active/all jobs with worker node count, site count, total CPU count, total memory, and agents","operationId":"get_jobs","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"active","in":"query","required":false,"schema":{"type":"boolean","description":"If True, returns only actively running jobs. Otherwise (default) returns all jobs","default":false,"title":"Active"},"description":"If True, returns only actively running jobs. Otherwise (default) returns all jobs"},{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetJobsResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/jobs/job/{job_id}/traces":{"get":{"tags":["Jobs"],"summary":"Get traces of the jobs","description":"Get job traces","operationId":"get_job_traces","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"job_id","in":"path","required":true,"schema":{"type":"string","description":"JobId of the job associated with the traces","title":"Job Id"},"description":"JobId of the job associated with the traces"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FabricHealthGetJobsTracesResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/icons":{"get":{"tags":["Icon Library"],"summary":"Get details of icons in the library","description":"Get icon details","operationId":"get_icon_report","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconReportResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/icons/upload/{name}":{"post":{"tags":["Icon Library"],"summary":"Upload an image file to Icon Library","description":"Upload an image file (.png, .jpeg, .jpg, .gif, .ico) to the Icon Library","operationId":"upload_icon_file_api_v2_icons_upload__name__post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the icon","title":"Name"},"description":"Name of the icon"},{"name":"public","in":"query","required":false,"schema":{"type":"boolean","description":"Select if the icon should be publicly accessible","default":false,"title":"Public"},"description":"Select if the icon should be publicly accessible"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_upload_icon_file_api_v2_icons_upload__name__post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconsUploadResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/icons/bulk_upload":{"post":{"tags":["Icon Library"],"summary":"Bulk Import Icons","description":"Bulk upload icons from a .zip or .tar.gz file to the Icon Library.","operationId":"bulk_import_icons_api_v2_icons_bulk_upload_post","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"public","in":"query","required":false,"schema":{"type":"boolean","description":"Select if the icon should be publicly accessible","default":false,"title":"Public"},"description":"Select if the icon should be publicly accessible"}],"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_bulk_import_icons_api_v2_icons_bulk_upload_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkIconsUploadResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/icons/icon/{name}/{id}":{"delete":{"tags":["Icon Library"],"summary":"Delete Icon","description":"Delete an icon from the Icon Library.","operationId":"delete_icon_api_v2_icons_icon__name___id__delete","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"name","in":"path","required":true,"schema":{"type":"string","description":"Name of the icon to be deleted","title":"Name"},"description":"Name of the icon to be deleted"},{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"ID of the icon to be deleted","title":"Id"},"description":"ID of the icon to be deleted"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IconsDeleteResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v2/audit":{"get":{"tags":["Audit Report"],"summary":"Get details of audit report","description":"Get audit details","operationId":"get_audit_report","security":[{"APIKeyHeader":[]}],"parameters":[{"name":"cfxql_query","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results","title":"Cfxql Query"},"description":"<a href='https://bot-docs.cloudfabrix.io/reference_guides/cfxql/'>cfxql query</a> string to filter the results"},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Sort the output based on given fields. Prepend '-' to sort descending","title":"Sort"},"description":"Sort the output based on given fields. Prepend '-' to sort descending"},{"name":"offset","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":0},{"type":"null"}],"description":"Offset to start the results from.","default":0,"title":"Offset"},"description":"Offset to start the results from."},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum number of results to return","default":100,"title":"Limit"},"description":"Maximum number of results to return"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditReportResponseModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AddBlueprintModel":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"},"version":{"type":"string","title":"Version"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"},"enabled":{"type":"boolean","title":"Enabled"},"type":{"type":"string","title":"Type","default":"Service"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"service_pipelines":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Service Pipelines"},"action_pipelines":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Action Pipelines"},"scheduled_pipelines":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Scheduled Pipelines"}},"additionalProperties":true,"type":"object","required":["name","id","version","category","comment","enabled","provider","service_pipelines","action_pipelines","scheduled_pipelines"],"title":"AddBlueprintModel","example":{"action_pipelines":[],"category":"sample","comment":"API tests","enabled":true,"id":"sample scheduled blueprint","name":"Sample Scheduled Blueprint","provider":"CloudFabrix Software, Inc.","scheduled_pipelines":[{"cron_expression":"0 12 * * *","label":"Sample scheduled pipeline 1","name":"sample-scheduled-pipeline-1","site":"rda.*","site_type":"regex","version":"*"}],"service_pipelines":[],"type":"Service","version":"1"}},"AddCredentialsResponseModel":{"properties":{},"type":"object","title":"AddCredentialsResponseModel","example":{"completed":"2024-11-09T14:02:27.281254","created":"2024-11-09T14:02:26.057613","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Credentials added/edited successfully"}}},"AddDraftPipelineModel":{"properties":{},"type":"object","title":"AddDraftPipelineModel","example":{"completed":"2024-11-09T10:19:22.132222","created":"2024-11-09T10:19:19.455834","serviceError":"none","serviceResult":{"context":{"is_draft":true,"name":"example_draft_pipeline","version":"2024_11_09"},"reason":"","results":[],"status":"SUBMIT_OK","statusMessage":"Draft Pipeline saved successfully"}}},"AddEditBlueprintResponse":{"properties":{},"type":"object","title":"AddEditBlueprintResponse","example":{"completed":"2024-11-09T13:18:31.835018","created":"2024-11-09T13:18:28.179296","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Added/edited service blueprint successfully"}}},"AddPublishedPipelineModel":{"properties":{},"type":"object","title":"AddPublishedPipelineModel","example":{"completed":"2024-11-09T10:23:47.330168","created":"2024-11-09T10:23:41.795408","serviceError":"none","serviceResult":{"context":{"is_draft":false,"name":"example_published_pipeline","version":"2024_11_09"},"reason":"","results":[],"status":"SUBMIT_OK","statusMessage":"Pipeline published successfully"}}},"AuditReportResponseModel":{"properties":{},"type":"object","title":"AuditReportResponseModel","example":{"audit_report":[{"_RDA_Id":"173622861527902920716f83a4","artifact_name":"login_post","artifact_type":"UserActivity","count_":1,"description":"User Logged IN","hostname":"738d9ed9ee0f","operation":"LOGIN","service":"authenticator","timestamp":"2025-01-07T05:43:35.069985","user_id":"admin@cfx.com"}],"is_first":true,"is_last":true,"last_sort_results":[1736191069922,"173619107062302821716f83a4"],"limit":100,"num_items":100,"offset":0,"properties":{},"reportMetaData":{"export":true,"filtering":true,"paginated":true,"refreshRequired":false,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Audit Report"},"search":true,"sort":[],"total_count":3017}},"AuthType":{"type":"string","enum":["ad","sso"],"title":"AuthType"},"BlueprintStatusModel":{"properties":{},"type":"object","title":"BlueprintStatusModel","example":{"completed":"2024-11-09T13:26:31.013786","created":"2024-11-09T13:26:27.415860","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Service blueprint activated/deactivated successfully"}}},"BlueprintStatusOption":{"type":"string","enum":["enable","disable"],"title":"BlueprintStatusOption"},"Body_bulk_import_icons_api_v2_icons_bulk_upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"The archive file (.zip, .tar.gz) to upload for bulk import"}},"type":"object","required":["file"],"title":"Body_bulk_import_icons_api_v2_icons_bulk_upload_post"},"Body_upload_icon_file_api_v2_icons_upload__name__post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"The image file to upload (.png, .jpeg, .jpg, .gif, .ico)"}},"type":"object","required":["file"],"title":"Body_upload_icon_file_api_v2_icons_upload__name__post"},"Body_upload_rda_pack_api_v2_rda_packs_rda_pack_upload_post":{"properties":{"file":{"type":"string","format":"binary","title":"File","description":"The RDA pack .tar.gz file to upload"}},"type":"object","required":["file"],"title":"Body_upload_rda_pack_api_v2_rda_packs_rda_pack_upload_post"},"BulkIconsUploadResponseModel":{"properties":{},"type":"object","title":"BulkIconsUploadResponseModel","example":{"completed":"2024-12-19T21:10:06.481410","created":"2024-12-19T21:10:06.272460","serviceError":"none","serviceResult":{"status":"SUCCESS","statusMessage":"Icons imported successfully."}}},"ConflictsOption":{"type":"string","enum":["abort","proceed"],"title":"ConflictsOption"},"CredentialAddModel":{"properties":{"name":{"type":"string","title":"Name"},"type":{"type":"string","title":"Type"},"add_to_default_site_profile":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Default Site Profile","default":true},"sites":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sites","default":"*"}},"additionalProperties":true,"type":"object","required":["name","type"],"title":"CredentialAddModel","example":{"add_to_default_site_profile":true,"host":"10.95.125.90","name":"jack95_ssh_credential","password":"xadqwhusnizmo-janygqwegdl","port":22,"sites":"*","type":"ssh-cred","username":"jack95"}},"CredentialEditModel":{"properties":{"add_to_default_site_profile":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Add To Default Site Profile","default":true},"sites":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sites","default":"*"},"type":{"type":"string","title":"Type"}},"additionalProperties":true,"type":"object","required":["type"],"title":"CredentialEditModel","example":{"add_to_default_site_profile":false,"host":"10.95.125.96","password":"xadqwhusnizmo-janygqwegdl","port":21,"sites":"*","type":"ssh-cred","username":"jack96"}},"CredentialTypeFields":{"properties":{},"type":"object","title":"CredentialTypeFields","example":[{"controlPropertyList":[],"controlType":"TEXT_FIELD","dataType":"string","defaultValue":"","description":"Name for the Integration","editable":true,"fieldId":"name","hidden":false,"label":"Name","lovValues":[],"required":true},{"controlPropertyList":[],"controlType":"BOOLEAN_FIELD","dataType":"string","defaultValue":true,"description":"Add this credential to Default Site Profile","editable":true,"fieldId":"add_to_default_site_profile","hidden":false,"label":"Add to Default Site Profile","lovValues":[],"required":false}]},"CredentialTypes":{"properties":{},"type":"object","title":"CredentialTypes","example":[{"displayName":"aiaexpress: CloudFabrix AIA Express","identifier":"aiaexpress"},{"displayName":"algosec: Algosec - Collect inventory information from Algosec","identifier":"algosec"}]},"DashboardAddModel":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"description":{"type":"string","title":"Description"},"version":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Version"},"enabled":{"type":"boolean","title":"Enabled","default":true},"dashboard_style":{"anyOf":[{"$ref":"#/components/schemas/DashboardStyle"},{"type":"null"}],"default":"auto"},"dashboard_filters":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Dashboard Filters"},"dashboard_sections":{"items":{"type":"object"},"type":"array","title":"Dashboard Sections"},"dashboard_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dashboard Type"},"dashboard_pages":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Dashboard Pages","default":[]}},"type":"object","required":["name","label","description","dashboard_sections"],"title":"DashboardAddModel","example":{"dashboard_filters":{"columns_filter":[],"group_filters":[],"time_filter":true},"dashboard_pages":[],"dashboard_sections":[],"dashboard_style":"tabbed","dashboard_type":"app","description":"RDAF Platform service's log analysis dashboard","enabled":true,"label":"RDAF Platform Logs","name":"example_dashboard","status_poller":{},"version":"24.4.10.1"}},"DashboardGroupAddModel":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"userGroups":{"items":{"type":"object"},"type":"array","title":"Usergroups"},"dashboardList":{"items":{"type":"object"},"type":"array","title":"Dashboardlist"}},"type":"object","required":["name","label","userGroups","dashboardList"],"title":"DashboardGroupAddModel","example":{"dashboardList":[{"id":"user-dashboard-topology-details-app","name":"topology-details-app"},{"id":"user-dashboard-oia-alert-analytics-os","name":"oia-alert-analytics-os"}],"description":"Description","label":"Label","name":"example_DashboardGroup","userGroups":[{"name":"Admin","tenantId":"f76806c0-1a99-48fb-b3d0-c0d8bf43300e"},{"name":"Users","tenantId":"f76806c0-1a99-48fb-b3d0-c0d8bf43300e"}]}},"DashboardGroupDeleteResponseModel":{"properties":{},"type":"object","title":"DashboardGroupDeleteResponseModel","example":{"status":"SUBMIT_OK","statusMessage":"Group deleted successfully"}},"DashboardGroupEditModel":{"properties":{"label":{"type":"string","title":"Label"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"userGroups":{"items":{"type":"object"},"type":"array","title":"Usergroups"},"dashboardList":{"items":{"type":"object"},"type":"array","title":"Dashboardlist"}},"type":"object","required":["label","userGroups","dashboardList"],"title":"DashboardGroupEditModel","example":{"dashboardList":[{"id":"user-dashboard-topology-details-app","name":"topology-details-app"},{"id":"user-dashboard-acme-devops-app","name":"acme-devops-app"}],"description":"Description","label":"Label","userGroups":[{"name":"Tenant Users","tenantId":"f76806c0-1a99-48fb-b3d0-c0d8bf43300e"}]}},"DashboardGroupStatusUpdateResponseModel":{"properties":{},"type":"object","title":"DashboardGroupStatusUpdateResponseModel","example":{"completed":"2024-12-16T19:01:37.970829","created":"2024-12-16T19:01:37.577846","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Dashboard Group enabled/disabled successfully"}}},"DashboardStyle":{"type":"string","enum":["tabbed","sectioned","auto"],"title":"DashboardStyle"},"DatasetAddModel":{"properties":{"name":{"type":"string","title":"Name"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder","default":"Default"},"schema_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Schema Name"},"tag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tag"}},"type":"object","required":["name"],"title":"DatasetAddModel"},"DatasetAddResponseModel":{"properties":{},"type":"object","title":"DatasetAddResponseModel","example":{"completed":"2025-01-15T07:31:35.978861","created":"2025-01-15T07:31:35.421251","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Dataset added successfully"}}},"DatasetDeleteAllDataResponseModel":{"properties":{},"type":"object","title":"DatasetDeleteAllDataResponseModel","example":{"completed":"2025-01-15T07:52:32.720330","created":"2025-01-15T07:52:32.177872","serviceError":"none","serviceResult":{"added":0,"deleted":0,"message":"Successfully deleted entire data from dataset test.","name":"test","status":"SUBMIT_OK","updated":0}}},"DatasetDeleteResponseModel":{"properties":{},"type":"object","title":"DatasetDeleteResponseModel","example":{"completed":"2025-01-15T07:31:35.978861","created":"2025-01-15T07:31:35.421251","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Dataset deleted successfully"}}},"DatasetDeleteRowResponseModel":{"properties":{},"type":"object","title":"DatasetDeleteRowResponseModel","example":{"completed":"2025-01-15T07:50:41.396577","created":"2025-01-15T07:50:40.531177","serviceError":"none","serviceResult":{"added":0,"deleted":1,"message":"Successfully deleted rows from dataset test.","name":"test","status":"SUBMIT_OK","updated":0}}},"DatasetUpdateResponseModel":{"properties":{},"type":"object","title":"DatasetUpdateResponseModel","example":{"completed":"2025-01-15T07:48:58.228832","created":"2025-01-15T07:48:56.276262","serviceError":"none","serviceResult":{"added":1,"deleted":0,"message":"Successfully updated dataset test.","name":"Test","status":"SUBMIT_OK","updated":0}}},"DeleteBlueprintModel":{"properties":{},"type":"object","title":"DeleteBlueprintModel","example":{"completed":"2024-11-09T13:42:59.859111","created":"2024-11-09T13:42:57.125764","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Service blueprint deleted successfully"}}},"DeleteCredentialResponseModel":{"properties":{},"type":"object","title":"DeleteCredentialResponseModel","example":{"completed":"2024-11-09T14:16:52.144763","created":"2024-11-09T14:16:50.694835","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Credentials deleted successfully"}}},"DeletePipelineResponseModel":{"properties":{},"type":"object","title":"DeletePipelineResponseModel","example":{"completed":"2024-11-09T09:38:53.505403","created":"2024-11-09T09:38:52.814767","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Pipeline deleted successfully"}}},"DeletePstreamDataResponseModel":{"properties":{},"type":"object","title":"DeletePstreamDataResponseModel","example":{"completed":"2024-11-10T20:29:16.435154","created":"2024-11-10T20:29:15.852670","serviceError":"none","serviceResult":{"dataResults":{"data":{"batches":1,"deleted":1,"noops":0,"requests_per_second":-1.0,"retries":{"bulk":0,"search":0},"throttled_millis":0,"throttled_until_millis":0,"timed_out":false,"took":38,"total":1,"version_conflicts":0},"now":"2024-11-10T20:29:16.430167","reason":"","status":"ok"},"status":"SUBMIT_OK","statusMessage":"Pstream data deleted successfully"}}},"DraftPipelineVersionsResponseModel":{"properties":{},"type":"object","title":"DraftPipelineVersionsResponseModel","example":{"draft_pipeline_versions":[{"category":"demo","folder":"Default","is_draft":true,"last_modified":"2024-12-03T04:55:58.169220","name":"test_pipeline","usecase":"API","version":"2024_12_02_2"},{"category":"demo","folder":"Default","is_draft":true,"last_modified":"2024-12-02T06:24:42.053282","name":"test_pipeline","usecase":"API","version":"2024_12_02_1"}],"reportMetaData":{"export":true,"filtering":false,"identifier":"d2b9297e-3e00-4577-be22-6b157f07fb69","paginated":false,"remoteSearchSupported":false,"sorting":true,"title":"Pipeline Version History"},"total_count":2}},"EditBlueprintModel":{"properties":{"name":{"type":"string","title":"Name"},"id":{"type":"string","title":"Id"},"version":{"type":"string","title":"Version"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"comment":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Comment"},"enabled":{"type":"boolean","title":"Enabled"},"type":{"type":"string","title":"Type","default":"Service"},"provider":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider"},"service_pipelines":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Service Pipelines"},"action_pipelines":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Action Pipelines"},"scheduled_pipelines":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Scheduled Pipelines"}},"additionalProperties":true,"type":"object","required":["name","id","version","category","comment","enabled","provider","service_pipelines","action_pipelines","scheduled_pipelines"],"title":"EditBlueprintModel","example":{"action_pipelines":[],"category":"sample testing","comment":"API tests-1","enabled":true,"id":"sample scheduled blueprint","name":"Sample Scheduled Blueprint-1","provider":"CloudFabrix Software, Inc.","scheduled_pipelines":[{"cron_expression":"0 24 * * *","label":"Sample scheduled pipeline 1","name":"sample-scheduled-pipeline-1","site":"rda.*","site_type":"regex","version":"*"}],"service_pipelines":[],"type":"Service","version":"1"}},"FabricHealthGetAgentsResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetAgentsResponseModel","example":{"agents":[{"agent_type":"rda-event-gateway","cpu_count":4,"hostname":"HA-AIA-Automation3.qa.engr.cloudfabrix.com","mem_percent":13.8,"mem_total_gb":31.3,"pod_id":"996da1cc","proc_id":8,"site_name":"event_gateway_site01","uptime":"4 days ago"}],"hasMoreResults":false,"reportMetaData":{"export":true,"filtering":false,"identifier":"50c5fee4-2cad-4144-982b-2971e02454e8","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"RDA Agents"},"totalResults":7}},"FabricHealthGetAppMircroservicesResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetAppMircroservicesResponseModel","example":{"app_microservices":[{"build_tag":"daily","cpu_count":4,"hostname":"11aa6f316597","mem_percent":41.7,"mem_total_gb":31.3,"pod_category":"rda_app","pod_id":"ca9dd291","pod_type":"asset-dependency","rda_messenger_version":"24.12.4.1","rda_pod_version":"22.12.26.1","uptime":"4 days ago"}],"hasMoreResults":false,"reportMetaData":{"export":true,"filtering":false,"identifier":"862e0059-7028-424b-9696-99fbbc4fa966","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"RDA Application Pods"},"totalResults":23}},"FabricHealthGetCoreMicroservicesResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetCoreMicroservicesResponseModel","example":{"core_microservices":[{"build_tag":"daily","cpu_count":4,"hostname":"84d5c63f859e","mem_percent":41.9,"mem_total_gb":31.3,"pod_category":"rda_infra","pod_id":"ac43f6f4","pod_leader":"","pod_type":"asm","rda_messenger_version":"24.12.3.2","rda_pod_version":"24.12.3.1","uptime":"4 days ago"}],"hasMoreResults":false,"reportMetaData":{"export":true,"filtering":false,"identifier":"d5c73554-70d7-4126-9602-88747709bbac","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"RDA Pods"},"totalResults":5}},"FabricHealthGetEventGwEndpointResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetEventGwEndpointResponseModel","example":{"event_gw_endpoint":[{"ep_name":"snmp_trap_events","id":"4a8c4258","port":162,"reltime":"less than a minute ago","site":"event_gateway_site01","ssl":"","status":"Started","stream":"NULL","timestamp":"2024-12-11T07:11:45.359086+00:00","type":"snmp_trap_go"}],"reportMetaData":{"export":true,"filtering":false,"identifier":"78342661-a6e7-4791-ae3a-4723b023e77c","paginated":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Event Gateway Status"},"totalResults":0}},"FabricHealthGetFabricUsageResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetFabricUsageResponseModel","example":{"fabric_usage":[{"24 Hours":0,"Last 30 Days":0,"This Month":0,"category":"Ingested data","label":"Ingested Events"}],"hasMoreResults":false,"reportMetaData":{"export":true,"filtering":false,"identifier":"f3c7e57e-9cc5-4561-85f5-12e4c0949593","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Usage"},"totalResults":38}},"FabricHealthGetJobsResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetJobsResponseModel","example":{"hasMoreResults":false,"jobs":[{"created":1733386498632,"deployment_id":"","deployment_name":"","deployment_type":"","deployment_type_service_color":"none","id":"765eb5d4","jobid":"765eb5d44caa49d2bcc998de20541e71","pid":316,"pipeline_name":"loooping","pipeline_version":"","reason":"","reltime":"4 days ago","status":"Running","worker_host":"02e3514b9050","worker_id":"51c208a4","worker_site":"rda-site-01"}],"reportMetaData":{"export":true,"filtering":false,"identifier":"e3a62f96-9c11-46b9-82e5-5a4b6ed46c82","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":false,"title":"Jobs"},"totalResults":1}},"FabricHealthGetJobsTracesResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetJobsTracesResponseModel","example":{"reportMetaData":{"dataResults":[{"attributes_is_draft":"no","bot":"@dm:addrow","df":"0x0","error_message":"","inspect":"no","jobid":"765eb5d4","num_cols":0,"num_rows":0,"pipeline_name":"loooping","pod_group":"rda-site-01","pos":2,"query":"x =  '1'","seq":522583,"statusColor":"#03A9F4","status_type":"in-progress","timestamp":"2024-12-11T09:26:08.364743","when":"less than a minute ago"}],"export":true,"filtering":false,"hasMoreResults":true,"identifier":"e8e9edda-35ce-4b67-8809-40d70869489f","paginated":true,"properties":{"offset":0,"maxResults":10},"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Traces for Job: 765eb5d44caa49d2bcc998de20541e71","totalResults":522565}}},"FabricHealthGetWorkerResponseModel":{"properties":{},"type":"object","title":"FabricHealthGetWorkerResponseModel","example":{"hasMoreResults":false,"reportMetaData":{"identifier":"cd7825e6-44af-4b93-bb71-6af4e5e80f3c","reportColumnDefinitionList":[],"title":"RDA Pods"},"totalResults":1,"worker":[{"build_tag":"daily","cpu_count":4,"cpu_load5":0.01,"hostname":"02e3514b9050","mem_percent":13.8,"mem_total_gb":31.3,"pod_category":"rda_infra","pod_id":"51c208a4","pod_type":"worker","pod_usage_active_jobs":1,"pod_usage_total_jobs":1,"public_access":"Yes","rda_messenger_version":"24.12.4.1","rda_platform_version":"24.11.12.1","rda_pod_version":"24.10.28.1","site_name":"rda-site-01","uptime":"4 days ago"}]}},"GetBlueprintArtifactDependenciesModel":{"properties":{},"type":"object","title":"GetBlueprintArtifactDependenciesModel","example":{"dataResults":[{"access":"Read","is_critical":false,"name":"linux_inventory_and_topology_using_ssh","subtype":"","type":"pipeline"}],"hasMoreResults":false,"reportMetaData":{"export":true,"filtering":false,"identifier":"b31c328b-009b-4a10-8983-2495631e9bfb","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Artifact Dependencies"},"totalResults":3}},"GetBlueprintAuditReportModel":{"properties":{},"type":"object","title":"GetBlueprintAuditReportModel","example":{"completed":"2024-12-17T05:58:30.563804","created":"2024-12-17T05:58:28.462988","serviceError":"none","serviceResult":{"dataResults":[{"actionType":"Pipeline","message":"No published versions found for pipline: vcenter_inventory","params":{"name":"vcenter_inventory","version":"*"},"severity":"WARNING","severityColor":"#FFA726","sourceName":"vcenter_inventory","sourceType":"*","type":"Verify Pipeline"}],"hasMoreResults":false,"reportMetaData":{"export":true,"filtering":false,"identifier":"3ec97ae5-5e10-4b4c-95e6-dd3dd434b23b","paginated":true,"refreshOptions":{"refreshInterval":60000,"refreshType":"Periodic"},"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Audit Report for vcenter_vmware"},"totalResults":3}}},"GetBlueprintResponseModel":{"properties":{},"type":"object","title":"GetBlueprintResponseModel","example":{"action_pipelines":[],"category":"sample","comment":"API tests","enabled":true,"id":"sample scheduled blueprint","name":"Sample Scheduled Blueprint","provider":"CloudFabrix Software, Inc.","scheduled_pipelines":[{"cron_expression":"0 12 * * *","label":"Sample scheduled pipeline 1","name":"sample-scheduled-pipeline-1","site":"rda.*","site_type":"regex","version":"*"}],"service_pipelines":[],"type":"Service","version":"1"}},"GetCredentialResponseModel":{"properties":{},"type":"object","title":"GetCredentialResponseModel","example":{"add_to_default_site_profile":true,"host":"10.95.125.90","name":"jack95_ssh_credential","password":"mcFg5VkxzS2J3NkxSM2VzeENSUm9tMFFlSTlBTkJFSk90Rnl0a3RIa1QtM0N1U1c0kxSM2VzeENSUm9tMFFlSTlBTSTlBTkJFSk90Rnl0a3RIxSM2VzeENSUm9tMFFl","port":22,"type":"ssh-cred","username":"jack95"}},"GetPipelineContentResponseModel":{"properties":{},"type":"object","title":"GetPipelineContentResponseModel","example":{"category":"API test","content":"%% stream = no and limit = 0\n\n@c:timed-loop interval = 34\n    --> @exec:run-pipeline name = \"test_draft\" & ignore_failures = \"yes\"\n\n","folder":"Default","name":"test_example","usecase":"example_pipelines","version":"2024_12_02_1"}},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"IconReportResponseModel":{"properties":{},"type":"object","title":"IconReportResponseModel","example":{"hasMoreResults":false,"icons":[{"alternativeUrl":"/iconlib/sdef","createdAt":1734597123241,"id":"25e97975","name":"sdef","preview":"/iconlib/25e97975","public":"No","publicColor":"#9E9E9E","size":"4.98 KB","type":"png","uploadedBy":"admin@cfx.com","url":"/iconlib/25e97975"}],"properties":{"offset":0,"maxResults":100},"reportMetaData":{"export":true,"filtering":false,"identifier":"dae9b388-9d40-11ed-8cbf-770158ef1f35","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Icons Report"},"totalResults":7}},"IconsDeleteResponseModel":{"properties":{},"type":"object","title":"IconsDeleteResponseModel","example":{"completed":"2024-12-19T21:37:01.209607","created":"2024-12-19T21:37:00.860426","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Icon deleted successfully"}}},"IconsUploadResponseModel":{"properties":{},"type":"object","title":"IconsUploadResponseModel","example":{"completed":"2024-12-19T21:11:49.779605","created":"2024-12-19T21:11:49.369134","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Imported image icon 'bot' successfully"}}},"LoginInput":{"properties":{"user":{"type":"string","title":"User"},"password":{"type":"string","title":"Password"}},"type":"object","required":["user","password"],"title":"LoginInput"},"OrganizationEditModel":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"}},"type":"object","required":["name"],"title":"OrganizationEditModel","example":{"description":"Description","name":"CloudFabrix"}},"OrganizationModel":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"tag":{"type":"string","title":"Tag"}},"type":"object","required":["name","tag"],"title":"OrganizationModel","example":{"description":"Description","name":"CloudFabrix","tag":"CFX"}},"OrganizationsAddResponseModel":{"properties":{},"type":"object","title":"OrganizationsAddResponseModel","example":{"completed":"2025-01-15T09:44:19.338068","created":"2025-01-15T09:44:19.060197","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Organization test added successfully"}}},"OrganizationsDeleteResponseModel":{"properties":{},"type":"object","title":"OrganizationsDeleteResponseModel","example":{"completed":"2025-01-15T09:44:19.338068","created":"2025-01-15T09:44:19.060197","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Organization Deleted successfully"}}},"OrganizationsEditResponseModel":{"properties":{},"type":"object","title":"OrganizationsEditResponseModel","example":{"completed":"2025-01-15T09:44:19.338068","created":"2025-01-15T09:44:19.060197","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Organization edited successfully"}}},"OrganizationsGetResponseModel":{"properties":{},"type":"object","title":"OrganizationsGetResponseModel","example":{"is_first":true,"is_last":true,"num_items":1,"organizations":[{"createdAt":1736932873000,"customerId":"c82a7de82e4c40d896618d99a22f466e","customerName":"OIA-CloudFabrix","deployment":"aiops","description":"Description","id":"10aeb888-d322-11ef-901b-0242ac120006","name":"OIA-CloudFabrix","parentResourceId":"b0ff9cfc-04e5-40da-b6d6-8d0b2ad93485","projectId":"10aeb888-d322-11ef-901b-0242ac120006","rowContext":{"resource":"10aeb888-d322-11ef-901b-0242ac120006","resourceKey":"projectId","resourceLabel":"OIA-CloudFabrix"},"tag1":"CFX"}],"reportMetaData":{"export":true,"filtering":false,"identifier":"755b6a53-b95f-4750-bd5c-5cd4a49ade57","paginated":false,"sorting":true,"title":"Organizations"},"total_count":0}},"PipelineAddModel":{"properties":{"input_data":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Input Data","default":[{}]},"run_context":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Run Context","default":{}}},"type":"object","title":"PipelineAddModel"},"PipelineLogsResponseModel":{"properties":{},"type":"object","title":"PipelineLogsResponseModel","example":{"dataResults":[],"filter_os_query":{"query":{"bool":{"must":[{"bool":{"must":[{"term":{"pipeline_name":{"case_insensitive":true,"value":"test_example"}}}]}}]}}},"is_first":true,"is_last":true,"limit":100,"num_items":0,"offset":0,"properties":{},"reportMetaData":{"export":true,"filtering":true,"identifier":"dynamic_widget_dynamic_widget_","paginated":true,"refreshRequired":false,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Logs for Pipeline"},"search":"null","sort":[],"total_count":0}},"PipelineTracesResponseModel":{"properties":{},"type":"object","title":"PipelineTracesResponseModel","example":{"dataResults":[],"filter_os_query":{"query":{"bool":{"must":[{"bool":{"must":[{"term":{"pipeline_name.keyword":{"case_insensitive":true,"value":"test_example"}}}]}}]}}},"is_first":true,"is_last":true,"limit":100,"num_items":0,"offset":0,"properties":{},"reportMetaData":{"export":true,"filtering":true,"identifier":"dynamic_widget_dynamic_widget_","paginated":true,"refreshRequired":false,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Traces for Pipeline"},"search":"null","sort":[],"total_count":0}},"PipelineVersionLogsResponseModel":{"properties":{},"type":"object","title":"PipelineVersionLogsResponseModel","example":{"dataResults":[],"filter_os_query":{"query":{"bool":{"must":[{"bool":{"must":[{"term":{"pipeline_name":{"case_insensitive":true,"value":"test_example"}}}]}},{"bool":{"must":[{"term":{"attributes_pipeline_version":{"case_insensitive":true,"value":"2024_12_24"}}}]}}]}}},"is_first":true,"is_last":true,"limit":100,"num_items":0,"offset":0,"properties":{},"reportMetaData":{"export":true,"filtering":true,"identifier":"dynamic_widget_dynamic_widget_","paginated":true,"refreshRequired":false,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Logs for Pipeline"},"search":"null","sort":[],"total_count":0}},"PipelineVersionTracesResponseModel":{"properties":{},"type":"object","title":"PipelineVersionTracesResponseModel","example":{"dataResults":[],"filter_os_query":{"query":{"bool":{"must":[{"bool":{"must":[{"term":{"pipeline_name.keyword":{"case_insensitive":true,"value":"test_example"}}}]}},{"bool":{"must":[{"term":{"attributes_pipeline_version.keyword":{"case_insensitive":true,"value":"2024_12_23"}}}]}}]}}},"is_first":true,"is_last":true,"limit":100,"num_items":0,"offset":0,"properties":{},"reportMetaData":{"export":true,"filtering":true,"identifier":"dynamic_widget_dynamic_widget_","paginated":true,"refreshRequired":false,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Traces for Pipeline"},"search":"null","sort":[],"total_count":0}},"PstreamAddModel":{"properties":{"name":{"type":"string","title":"Name"},"attributes":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Attributes"}},"type":"object","required":["name"],"title":"PstreamAddModel","example":{"attributes":{"retention_days":31,"unique_keys":["key1","key2"]},"name":"example_pstream"}},"PstreamAddResponseModel":{"properties":{},"type":"object","title":"PstreamAddResponseModel","example":{"completed":"2025-01-15T07:54:35.063797","created":"2025-01-15T07:54:34.566736","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Added Pstream successfully"}}},"PstreamDeleteResponseModel":{"properties":{},"type":"object","title":"PstreamDeleteResponseModel","example":{"completed":"2025-01-15T07:56:45.341251","created":"2025-01-15T07:56:44.158575","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Pstream deleted successfully"}}},"PstreamEditModel":{"properties":{"attributes":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Attributes"}},"type":"object","title":"PstreamEditModel","example":{"attributes":{"retention_days":31,"unique_keys":["key1","key2"]}}},"PstreamEditResponseModel":{"properties":{},"type":"object","title":"PstreamEditResponseModel","example":{"completed":"2025-01-15T07:55:29.773723","created":"2025-01-15T07:55:29.498675","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Updated Pstream successfully"}}},"PstreamMetadataResponseModel":{"properties":{},"type":"object","title":"PstreamMetadataResponseModel","example":{"Metadata":[],"hasMoreResults":false,"is_first":true,"is_last":true,"num_items":0,"properties":{},"reportMetaData":{"export":true,"filtering":false,"identifier":"3bd0fbcd-1284-44b8-ae2b-53bffac8db99","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Metadata"},"total_count":0}},"PstreamStatsResponseModel":{"properties":{},"type":"object","title":"PstreamStatsResponseModel","example":{"Stats":[],"hasMoreResults":false,"is_first":true,"is_last":true,"num_items":0,"properties":{},"reportMetaData":{"export":true,"filtering":false,"identifier":"3bd0fbcd-1284-44b8-ae2b-53bffac8db99","paginated":true,"remoteSearchSupported":false,"reportColumnDefinitionList":[],"sorting":true,"title":"Details"},"total_count":0}},"PublishDataPstreamResponseModel":{"properties":{},"type":"object","title":"PublishDataPstreamResponseModel","example":{"completed":"2024-11-09T17:08:13.106766","created":"2024-11-09T17:08:12.779445","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Added data to Persistent Stream successfully"}}},"PublishDraftPipelineModel":{"properties":{},"type":"object","title":"PublishDraftPipelineModel","example":{"completed":"2024-11-09T10:09:54.703018","created":"2024-11-09T10:09:51.535143","serviceError":"none","serviceResult":{"context":{"is_draft":true,"name":"example_draft_pipeline","version":"2024_11_08"},"reason":"","results":[],"status":"SUBMIT_OK","statusMessage":"Pipeline published successfully"}}},"PublishedPipelineVersionsResponseModel":{"properties":{},"type":"object","title":"PublishedPipelineVersionsResponseModel","example":{"published_pipeline_versions":[{"category":"demo","folder":"Default","is_draft":false,"last_modified":"2024-12-03T05:06:00.714223","name":"test_example","usecase":"API","version":"2024_12_02_v2"},{"category":"demo","folder":"Default","is_draft":false,"last_modified":"2024-12-02T19:14:41.830839","name":"test_example","usecase":"API","version":"2024_12_02_v1"}],"reportMetaData":{"export":true,"filtering":false,"identifier":"d2b9297e-3e00-4577-be22-6b157f07fb69","paginated":false,"remoteSearchSupported":false,"sorting":true,"title":"Pipeline Version History"},"total_count":2}},"RdaPacksDeleteResponseModel":{"properties":{},"type":"object","title":"RdaPacksDeleteResponseModel","example":{"status":"SUBMIT_OK","statusMessage":"RDA Pack deleted successfully"}},"RdaPacksStatusUpdateResponseModel":{"properties":{},"type":"object","title":"RdaPacksStatusUpdateResponseModel","example":{"completed":"2024-11-28T17:25:48.729256","created":"2024-11-28T17:25:48.728404","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"RDA Pack being activated/deactivated in the background"}}},"RdaPacksUploadResponseModel":{"properties":{},"type":"object","title":"RdaPacksUploadResponseModel","example":{"completed":"2024-11-28T17:13:18.487936","created":"2024-11-28T17:13:14.880646","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"RDA Pack uploaded successfully."}}},"RunPipelineResponseModel":{"properties":{},"type":"object","title":"RunPipelineResponseModel","example":{"completed":"2024-11-09T19:38:47.964110","created":"2024-11-09T19:38:47.618960","serviceError":"none","serviceResult":{"context":{"name":"example","version":"2024_11_08_1"},"job_id":"32b9052a12d8477faf0ce47bbb45b82f","reason":"","status":"SUBMIT_OK_SHOW_MESSAGE","statusMessage":"Pipeline execution started successfully in background. You can check the progress and results in View Traces.","title":"Pipeline Run"}}},"SelectionType":{"type":"string","enum":["tabular_report","cfxql_filter"],"title":"SelectionType"},"TableReportResponse":{"properties":{"last_sort_results":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Last Sort Results","description":"Last sort tags used for internal puposes"},"reportMetaData":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Reportmetadata","description":"Meta information about the report, including columns and types etc"},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset","description":"Starting offset in the filtered results"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"Maximum number of results to be returned per page"},"sort":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sort","description":"Sort order passed as part of request"},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"Total number of results that matched the query"},"num_items":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items","description":"Number of results returned in this page"},"is_first":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is First","description":"True if this page is first page","default":true},"is_last":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Last","description":"True if this page is last page","default":true}},"type":"object","title":"TableReportResponse","example":{"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}},"TextFsmTemplateAddModel":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"textfsm_template":{"type":"string","title":"Textfsm Template"},"sample_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample Input"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder","default":"Default"}},"type":"object","required":["name","description","textfsm_template"],"title":"TextFsmTemplateAddModel","example":{"description":"Extracts email addresses from logs","folder":"Default","name":"EmailExtraction","sample_input":"Email: john.doe@example.com\nEmail: alice.smith@company.org\nEmail: bob@subdomain.website.co.uk\nEmail: invalid-email@missingdotcom","textfsm_template":"Value USERNAME (\\S+)\nValue DOMAIN (\\S+\\.\\S+)\n\nStart\n  ^Email: ${USERNAME}@${DOMAIN} -> Record"}},"TextFsmTemplateAddResponseModel":{"properties":{},"type":"object","title":"TextFsmTemplateAddResponseModel","example":{"completed":"2024-11-21T16:46:59.440906","created":"2024-11-21T16:46:59.146648","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Added textfsm successfully"}}},"TextFsmTemplateDeleteResponseModel":{"properties":{},"type":"object","title":"TextFsmTemplateDeleteResponseModel","example":{"completed":"2024-11-21T16:46:59.440906","created":"2024-11-21T16:46:59.146648","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Deleted textfsm successfully"}}},"TextFsmTemplateUpdateModel":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"textfsm_template":{"type":"string","title":"Textfsm Template"},"sample_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample Input"},"folder":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folder"}},"type":"object","required":["description","textfsm_template","sample_input","folder"],"title":"TextFsmTemplateUpdateModel","example":{"description":"Extracts email addresses from logs","folder":"Default","sample_input":"Email: john.doe@example.com\nEmail: alice.smith@company.org\nEmail: bob@subdomain.website.co.uk\nEmail: invalid-email@missingdotcom","textfsm_template":"Value USERNAME (\\S+)\nValue DOMAIN (\\S+\\.\\S+)\n\nStart\n  ^Email: ${USERNAME}@${DOMAIN} -> Record"}},"TextFsmTemplateUpdateResponseModel":{"properties":{},"type":"object","title":"TextFsmTemplateUpdateResponseModel","example":{"completed":"2024-11-21T16:46:59.440906","created":"2024-11-21T16:46:59.146648","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Updated textfsm successfully"}}},"TextFsmTemplateValidateModel":{"properties":{"textfsm_template":{"type":"string","title":"Textfsm Template"},"sample_input":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sample Input"}},"type":"object","required":["textfsm_template"],"title":"TextFsmTemplateValidateModel","example":{"sample_input":"Email: john.doe@example.com\nEmail: alice.smith@company.org\nEmail: bob@subdomain.website.co.uk\nEmail: invalid-email@missingdotcom","textfsm_template":"Value USERNAME (\\S+)\nValue DOMAIN (\\S+\\.\\S+)\n\nStart\n  ^Email: ${USERNAME}@${DOMAIN} -> Record"}},"TextFsmTemplateValidateResponseModel":{"properties":{},"type":"object","title":"TextFsmTemplateValidateResponseModel","example":[{"DOMAIN":"example.com","USERNAME":"john.doe"},{"DOMAIN":"company.org","USERNAME":"alice.smith"},{"DOMAIN":"subdomain.website.co.uk","USERNAME":"bob"}]},"TextFsmTemplateViewResponseModel":{"properties":{},"type":"object","title":"TextFsmTemplateViewResponseModel","example":[{"formData":{"description":"Extracts email addresses from logs","folder":"Default","name":"EmailExtraction","sampleInput":"Email: john.doe@example.com\nEmail: alice.smith@company.org\nEmail: bob@subdomain.website.co.uk\nEmail: invalid-email@missingdotcom","saved_time":"2024-11-20T06:23:15.679725","textfsmTemplate":"Value USERNAME (\\S+)\nValue DOMAIN (\\S+\\.\\S+)\n\nStart\n  ^Email: ${USERNAME}@${DOMAIN} -> Record","type":"textfsm_template"},"formDefinition":{"enableLazyLoading":false,"formFieldList":[],"id":"rda.saas.textfsm.view","refreshRequired":false,"submitRequired":false}}]},"UpdatePstreamDataResponseModel":{"properties":{},"type":"object","title":"UpdatePstreamDataResponseModel","example":{"completed":"2024-11-10T19:46:27.994739","created":"2024-11-10T19:46:27.394291","serviceError":"none","serviceResult":{"dataResults":{"data":{"batches":1,"deleted":0,"failures":[],"noops":0,"requests_per_second":-1.0,"retries":{"bulk":0,"search":0},"throttled_millis":0,"throttled_until_millis":0,"timed_out":false,"took":250,"total":1,"updated":1,"version_conflicts":0},"now":"2024-11-10T19:46:27.988838","reason":"","status":"ok"},"status":"SUBMIT_OK","statusMessage":"Pstream data updated successfully"}}},"User":{"properties":{"contactNumber":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contactnumber"},"emailId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Emailid"},"firstName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Firstname"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id"},"lastName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lastname"},"localuser":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Localuser"},"loggedIn_user":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Loggedin User"},"parentResourceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parentresourceid"},"profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"userGroup":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usergroup"},"userId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Userid"},"userType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Usertype"},"validationStatus":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Validationstatus"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"}},"type":"object","required":["contactNumber","emailId","firstName","id","lastName","localuser","loggedIn_user","parentResourceId","profile","status","userGroup","userId","userType","validationStatus","role"],"title":"User"},"UserAddModel":{"properties":{"remoteUser":{"type":"boolean","title":"Remoteuser","default":false},"apiUser":{"type":"boolean","title":"Apiuser","default":false},"authenticationType":{"anyOf":[{"$ref":"#/components/schemas/AuthType"},{"type":"null"}]},"group":{"type":"string","title":"Group"},"firstname":{"type":"string","title":"Firstname"},"lastname":{"type":"string","title":"Lastname"},"id":{"type":"string","format":"email","title":"Id"}},"type":"object","required":["group","firstname","lastname","id"],"title":"UserAddModel"},"UserDetails":{"properties":{"authenticated":{"type":"boolean","title":"Authenticated","description":"Whether user is authenticated"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company","description":"Company the user belongs to"},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"First name"},"id":{"type":"string","title":"Id","description":"Id of the user (email address)"},"is_authenticated":{"type":"boolean","title":"Is Authenticated","description":"Alias to 'authenticated'"},"is_workspaceadmin":{"type":"boolean","title":"Is Workspaceadmin","description":"Is the user a workspace admin"},"is_workspacecreator":{"type":"boolean","title":"Is Workspacecreator","description":"Is the user a workspace creator"},"last_name":{"type":"boolean","title":"Last Name","description":"Last Name"},"lastname":{"type":"boolean","title":"Lastname","description":"Alias to last_name"},"login_time":{"type":"string","title":"Login Time","description":"Login time in ISO format"},"rdac_auth_token":{"type":"string","title":"Rdac Auth Token","description":"Authentication Token"},"remote_user":{"type":"boolean","title":"Remote User","description":"Whether user is a remote user or a local user"},"role":{"type":"string","title":"Role","description":"User Role"},"session_id":{"type":"string","title":"Session Id","description":"Current session id"},"status":{"type":"string","title":"Status","description":"Current status of the user"},"tenantid":{"type":"string","title":"Tenantid","description":"Tenant ID of the user"},"user":{"type":"string","title":"User","description":"alias to 'id'"},"workspace":{"type":"string","title":"Workspace","description":"Name of the workspace"},"workspaceid":{"type":"string","title":"Workspaceid","description":"ID of the workspace"}},"type":"object","title":"UserDetails","description":"Response for isUserAuthenticated request. This response contains all the user information that is currently logged in.","example":{"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"}},"UserGroupAddModel":{"properties":{"name":{"type":"string","title":"Name"},"profile":{"$ref":"#/components/schemas/UserRoleProfiles"},"selection_type":{"$ref":"#/components/schemas/SelectionType"},"projects":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Projects","default":[]},"project_cfxql":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Cfxql"},"data_access_policy":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Data Access Policy","default":[]},"tags":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]}},"type":"object","required":["name","profile","selection_type"],"title":"UserGroupAddModel","example":{"name":"example-UserGroup","profile":"msp-admin","projects":[{"customerId":"67deec38-9ac8-11ee-8514-0242ac120005","customerName":"CloudFabrix"}],"selection_type":"tabular_report"}},"UserGroupAddResponseModel":{"properties":{},"type":"object","title":"UserGroupAddResponseModel","example":{"completed":"2025-01-15T10:33:04.236246","created":"2025-01-15T10:33:03.133234","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Added user group successfully"}}},"UserGroupDeleteResponseModel":{"properties":{},"type":"object","title":"UserGroupDeleteResponseModel","example":{"completed":"2025-01-15T10:42:11.420708","created":"2025-01-15T10:42:10.951691","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Deleted user group successfully"}}},"UserGroupEditModel":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"chatbot_policy":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chatbot Policy"},"profile":{"$ref":"#/components/schemas/UserRoleProfiles"},"selection_type":{"$ref":"#/components/schemas/SelectionType"},"tenantId":{"type":"string","title":"Tenantid"},"projects":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Projects","default":[]},"project_cfxql":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Project Cfxql"},"data_access_policy":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Data Access Policy","default":[]},"tags":{"anyOf":[{"items":{"type":"object"},"type":"array"},{"type":"null"}],"title":"Tags","default":[]}},"type":"object","required":["profile","selection_type","tenantId"],"title":"UserGroupEditModel","example":{"profile":"msp-admin","projects":[{"customerId":"67deec38-9ac8-11ee-8514-0242ac120005","customerName":"CloudFabrix"}],"selection_type":"tabular_report"}},"UserGroupEditResponseModel":{"properties":{},"type":"object","title":"UserGroupEditResponseModel","example":{"completed":"2025-01-15T10:38:28.471300","created":"2025-01-15T10:38:27.784524","serviceError":"none","serviceResult":{"status":"SUBMIT_OK","statusMessage":"Updated user group successfully"}}},"UserGroupGetResponseModel":{"properties":{},"type":"object","title":"UserGroupGetResponseModel","example":{"hasMoreResults":false,"is_first":true,"is_last":true,"num_items":1,"properties":{},"reportMetaData":{"export":true,"filtering":false,"identifier":"c6b7738a-008a-4666-ad47-ec4340b92e2c","paginated":true,"remoteSearchSupported":false,"sorting":true,"title":"User Groups"},"total_count":1,"user_groups":[{"createdAt":"2025-01-15T10:09:56","name":"Test","profile":"msp-admin","project_names":"OIA-CloudFabrix","projects":"10aeb888-d322-11ef-901b-0242ac120006","role":"msp-admin","status":"Active","tags":[],"tenantId":"b0ff9cfc-04e5-40da-b6d6-8d0b2ad93485"}]}},"UserResetPasswordModel":{"properties":{"new_password":{"type":"string","title":"New Password"},"confirm_password":{"type":"string","title":"Confirm Password"}},"type":"object","required":["new_password","confirm_password"],"title":"UserResetPasswordModel"},"UserRoleProfiles":{"type":"string","enum":["msp-admin","msp-user","msp-user-read-only","tenant-admin-profile","tenant-user-profile","tenant-user-read-only","l3-user","l1-user"],"title":"UserRoleProfiles"},"Users":{"properties":{"last_sort_results":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Last Sort Results","description":"Last sort tags used for internal puposes"},"reportMetaData":{"anyOf":[{"type":"object"},{"type":"null"}],"title":"Reportmetadata","description":"Meta information about the report, including columns and types etc"},"offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Offset","description":"Starting offset in the filtered results"},"limit":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Limit","description":"Maximum number of results to be returned per page"},"sort":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sort","description":"Sort order passed as part of request"},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count","description":"Total number of results that matched the query"},"num_items":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Items","description":"Number of results returned in this page"},"is_first":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is First","description":"True if this page is first page","default":true},"is_last":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Last","description":"True if this page is last page","default":true},"users":{"anyOf":[{"items":{"$ref":"#/components/schemas/User"},"type":"array"},{"type":"null"}],"title":"Users"}},"type":"object","required":["users"],"title":"Users","example":{"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"}]}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VerifyCredentialsResponseModel":{"properties":{},"type":"object","title":"VerifyCredentialsResponseModel","example":{"name":"example-credential","status":"OK"}},"blueprints_enum":{"type":"string","enum":["auto_deploy","-auto_deploy","category","-category","comment","-comment","enabled","-enabled","errors","-errors","id","-id","name","-name","saved_type","-saved_type","state","-state","timestamp","-timestamp","type","-type","version","-version"],"title":"blueprints_enum"},"credentials_enum":{"type":"string","enum":["checksum","-checksum","has_credential_check","-has_credential_check","name","-name","saved_time","-saved_time","timestamp","-timestamp","type","-type","typeDescription","-typeDescription"],"title":"credentials_enum"},"dashboards_enum":{"type":"string","enum":["category","-category","description","-description","folder","-folder","name","-name","saved_time","-saved_time","timestamp","-timestamp","usecase","-usecase","version","-version","versions_count","-versions_count"],"title":"dashboards_enum"},"datasets_enum":{"type":"string","enum":["folder","-folder","format","-format","mem_size_mb","-mem_size_mb","name","-name","num_columns","-num_columns","num_rows","-num_rows","saved_time","-saved_time","schema","-schema","timestamp","-timestamp"],"title":"datasets_enum"},"draft_pipelines_enum":{"type":"string","enum":["category","-category","description","-description","folder","-folder","name","-name","saved_time","-saved_time","timestamp","-timestamp","usercase","-usercase","version","-version","version_count","-version_count"],"title":"draft_pipelines_enum"},"main__pipelines_enum__1":{"type":"string","enum":["category","-category","description","-description","folder","-folder","name","-name","saved_time","-saved_time","timestamp","-timestamp","usercase","-usercase","version","-version","version_count","-version_count"],"title":"pipelines_enum"},"main__pipelines_enum__2":{"type":"string","enum":["attributes_pipeline_version","-attributes_pipeline_version","bot","-bot","jobid","-jobid","pipeline_name","-pipeline_name","query","-query","status_type","-status_type","timestamp","-timestamp"],"title":"pipelines_enum"},"main__pipelines_enum__3":{"type":"string","enum":["jobid","-jobid","message","-message","pipeline_name","-pipeline_name","timestamp","-timestamp"],"title":"pipelines_enum"},"pstreams_enum":{"type":"string","enum":["collection_status","-collection_status","database","-database","datastore_type","-datastore_type","index_name","-index_name","name","-name","retention_days","-retention_days","saved_time","-saved_time","system_defined","-system_defined","timestamp","-timestamp"],"title":"pstreams_enum"},"rda_packs_enum":{"type":"string","enum":["name","-name","publisher","-publisher","scope","-scope","status","-status","timestamp","-timestamp","type","-type","upload_time","-upload_time","version","-version"],"title":"rda_packs_enum"},"textfsm_enum":{"type":"string","enum":["description","-description","folder","-folder","name","-name","saved_time","-saved_time","timestamp","-timestamp","type","-type"],"title":"textfsm_enum"}},"securitySchemes":{"APIKeyHeader":{"type":"apiKey","in":"header","name":"Authorization"}}}}