Litmus Portal API Documentation API Reference

Litmus Portal provides console and UI experience for managing, monitoring, and events around chaos workflows. Chaos workflows consist of a sequence of experiments run together to achieve the objective of introducing some kind of fault into an application or the Kubernetes platform.

API Endpoints
Dev:
http://localhost:8080
Prod:
http://localhost:8080/query

Cluster

Litmus Portal gives the ability to run chaos on remote Kubernetes cluster. Self cluster is automatically getting connected after submitting the welcome model. To connect an external cluster, use the following APIs for cluster operations.
User can access connected clusters via agents page of Litmus Portal.

Cluster

List Cluster

Returns a list of cluster with Litmus Portal. It includes pending, active and inactive clusters.

Field Possible values Mandatory/Optional
project_id - Mandatory
cluster_type external/internal Mandatory
Example Body:
{

"project_id": "5fd7d9212c9f32447e28317b",
"cluster_type": "external",

}
project_id:
string

(no description)

cluster_type:
string

(no description)

Example

Request Content-Types: application/json
Query
query getCluster($project_id: String!, $cluster_type: String){
  getCluster(project_id: $project_id, cluster_type: $cluster_type){
    cluster_id
    project_id
    cluster_name
    description
    platform_name
    access_key
    is_registered
    is_cluster_confirmed
    is_active
    updated_at
    created_at
    cluster_type
    no_of_schedules
    no_of_workflows
    token
    agent_namespace
    serviceaccount
    agent_scope
    agent_ns_exists
    agent_sa_exists
    last_workflow_timestamp
    start_time
    version
  }
}
Variables
{
  "project_id": "string",
  "cluster_type": "string"
}
Try it now
200 OK

Successful operation

type
Cluster
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getCluster": [
      {
        "cluster_id": "string",
        "project_id": "string",
        "cluster_name": "string",
        "description": "string",
        "platform_name": "string",
        "access_key": "string",
        "is_registered": "boolean",
        "is_cluster_confirmed": "boolean",
        "is_active": "boolean",
        "updated_at": "string",
        "created_at": "string",
        "cluster_type": "string",
        "no_of_schedules": "integer",
        "no_of_workflows": "integer",
        "token": "string",
        "agent_namespace": "string",
        "serviceaccount": "string",
        "agent_scope": "string",
        "agent_ns_exists": "boolean",
        "agent_sa_exists": "boolean",
        "last_workflow_timestamp": "string",
        "start_time": "string",
        "version": "string"
      }
    ]
  }
}
Cluster

Register Cluster

User can make requests to connect their kubernetes cluster and get a token as response, that token can be used to get the subscriber manifest which needs to apply in their cluster.

Field Possible values Mandatory/Optional
cluster_name - Mandatory
description - Optional
project_id - Mandatory
platform_name - Optional
cluster_type external/internal Mandatory
agent_namespace - Optional
serviceaccount - Optional
agent_scope cluster/namespace Mandatory
agent_ns_exists true/false Mandatory
agent_sa_exists true/false Mandatory
node_selector - Mandatory
Example Body:
{

"cluster_name": "Litmus-cluster",
"description": "New Litmus Portal Cluster",
"platform_name": "AWS",
"project_id": "5fd7d9212c9f32447e28317b",
"cluster_type": "external",
"agent_namespace": "",
"agent_namespace": "",
"agent_scope": cluster,
"agent_ns_exists": false,
"agent_sa_exists": false,

}
clusterInput:

(no description)

Example

Request Content-Types: application/json
Query
mutation userClusterReg($clusterInput: ClusterInput!){
  userClusterReg(clusterInput: $clusterInput){
    token
    cluster_id
    cluster_name
  }
}
Variables
{
  "clusterInput": {
    "cluster_name": "string",
    "description": "string",
    "platform_name": "string",
    "project_id": "object",
    "cluster_type": "string",
    "agent_namespace": "string",
    "serviceaccount": "string",
    "agent_scope": "string",
    "agent_ns_exists": "boolean",
    "agent_sa_exists": "boolean",
    "skip_ssl": "boolean",
    "node_selector": "string",
    "tolerations": [
      {
        "tolerationSeconds": "number",
        "key": "string",
        "operator": "string",
        "effect": "string",
        "value": "string"
      }
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "userClusterReg": {
      "token": "string",
      "cluster_id": "string",
      "cluster_name": "string"
    }
  }
}
Cluster

Delete Cluster

This query can be used to delete a cluster from litmus portal. It cannot be undone.
Note: User can access the details of deleted cluster inside MongoDB, which are being marked as removed.

Field Possible values Mandatory/Optional
cluster_id - Mandatory
Example Body:
{

"cluster_id": "2df3212c9f32447e28317b",

}
cluster_id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteClusterReg($cluster_id: String!){
  deleteClusterReg(cluster_id: $cluster_id)
}
Variables
{
  "cluster_id": "string"
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteClusterReg": "string"
  }
}

Chaos Workflow

Chaos workflows consist of a sequence of experiments run together to introduce chaos in the Kubernetes platform.
Note: Target cluster should be in active state before scheduling the workflow

Chaos Workflow

Create ChaosWorkflow

User can create Chaos Workflow easily via the workflow page of the Litmus Portal dashboard.

Field Possible values Mandatory/Optional
workflow_id - Optional
workflow_manifest - Mandatory
workflow_manifest - Mandatory
cronSyntax - Optional
workflow_name external/internal Mandatory
weightages - Mandatory
workflow_description - Optional
isCustomWorkflow true/false Madatory
project_id Mandatory
cluster_id Mandatory
Example Body:
{

"workflow_name": "Pod-networkloss-chaos",
"workflow_manifest": "{ apiVersion: v1 ......}",
"cronSyntax": "***/2",
"project_id": "5fd7d9212c9f32447e28317b",
"cluster_id": "3gr3f492146f53d4g3e283re",
"workflow_description": "Pod networkloss-experiment",
"isCustomWorkflow": false,

}
input:

(no description)

Example

Request Content-Types: application/json
Query
mutation createChaosWorkFlow($input: ChaosWorkFlowInput!){
  createChaosWorkFlow(input: $input){
    workflow_id
    cronSyntax
    workflow_name
    workflow_description
    isCustomWorkflow
  }
}
Variables
{
  "input": {
    "workflow_id": "string",
    "workflow_manifest": "string",
    "cronSyntax": "string",
    "workflow_name": "string",
    "workflow_description": "string",
    "weightages": [
      {
        "experiment_name": "string",
        "weightage": "number"
      }
    ],
    "isCustomWorkflow": "boolean",
    "project_id": "object",
    "cluster_id": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createChaosWorkFlow": {
      "workflow_id": "string",
      "cronSyntax": "string",
      "workflow_name": "string",
      "workflow_description": "string",
      "isCustomWorkflow": "boolean"
    }
  }
}
Chaos Workflow

Get ChaosWorkflow Runs

Returns a list of chaos workflow and details of particular using a same endpoint. It can fetch both cron and non-cron workflow present in the Litmus Portal. false
This query also supports pagination, filtering and sorting of data according to different parameters.

Field Possible values Mandatory/Optional
project_id - Mandatory
workflow_ids [] Optional
workflow_run_ids [] Optional
pagination {page: "integer", limit:"integer"} Optional
sort - Optional
filter - Optional
workflowRunsInput:

(no description)

Example

Request Content-Types: application/json
Query
query getWorkflowRuns($workflowRunsInput: GetWorkflowRunsInput!){
  getWorkflowRuns(workflowRunsInput: $workflowRunsInput){
    total_no_of_workflow_runs
  }
}
Variables
{
  "workflowRunsInput": {
    "project_id": "object",
    "workflow_run_ids": [
      "object"
    ],
    "workflow_ids": [
      "object"
    ],
    "pagination": {
      "page": "number",
      "limit": "number"
    },
    "sort": {
      "field": "string",
      "descending": "boolean"
    },
    "filter": {
      "workflow_name": "string",
      "cluster_name": "string",
      "workflow_status": "string",
      "date_range": {
        "start_date": "string",
        "end_date": "string"
      }
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getWorkflowRuns": {
      "total_no_of_workflow_runs": "integer"
    }
  }
}
Chaos Workflow

List Chaos Workflow

This query is used to get the list of all the scheduled workflows. Individual schedules can also be extracted by providing the workflow_ids

Field Possible values Mandatory/Optional
project_id - Mandatory
workflow_ids [] Optional
pagination {page: "integer", limit:"integer"} Optional
sort - Optional
filter - Optional
workflowInput:

(no description)

Example

Request Content-Types: application/json
Query
query ListWorkflow($workflowInput: ListWorkflowsInput!){
  ListWorkflow(workflowInput: $workflowInput){
    total_no_of_workflows
  }
}
Variables
{
  "workflowInput": {
    "project_id": "object",
    "workflow_ids": [
      "object"
    ],
    "pagination": {
      "page": "number",
      "limit": "number"
    },
    "sort": {
      "field": "string",
      "descending": "boolean"
    },
    "filter": {
      "workflow_name": "string",
      "cluster_name": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "ListWorkflow": {
      "total_no_of_workflows": "integer"
    }
  }
}
Chaos Workflow

Re Run Chaos Workflow

This API is used to re-run a particular chaos workflow on the basis of workflow_id

Field Possible values Mandatory/Optional
workflow_id string Mandatory
workflowID:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation reRunChaosWorkFlow($workflowID: String!){
  reRunChaosWorkFlow(workflowID: $workflowID)
}
Variables
{
  "workflowID": "string"
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "reRunChaosWorkFlow": "string"
  }
}
Chaos Workflow

Update ChaosWorkflow

Update the specified chaos workflow by setting the values of the parameters passed. Any parameters not provided will change with its empty value.

Field Possible values Mandatory/Optional
workflow_id - Mandatory
cronSyntax - Mandatory
workflow_name - Mandatory
workflow_description - Mandatory
isCustomWorkflow true/false Mandatory
Example Body:
{

"workflow_id": "5fd7d9212c9f32447e28317b",
"cronSyntax": "****",
"workflow_name": "New-network-chaos",
"workflow_description": "Update Chaos workflow",
"isCustomWorkflow": false

}
input:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateChaosWorkflow($input: ChaosWorkFlowInput){
  updateChaosWorkflow(input: $input){
    workflow_id
    cronSyntax
    workflow_name
    workflow_description
    isCustomWorkflow
  }
}
Variables
{
  "input": {
    "workflow_id": "string",
    "workflow_manifest": "string",
    "cronSyntax": "string",
    "workflow_name": "string",
    "workflow_description": "string",
    "weightages": [
      {
        "experiment_name": "string",
        "weightage": "number"
      }
    ],
    "isCustomWorkflow": "boolean",
    "project_id": "object",
    "cluster_id": "object"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateChaosWorkflow": {
      "workflow_id": "string",
      "cronSyntax": "string",
      "workflow_name": "string",
      "workflow_description": "string",
      "isCustomWorkflow": "boolean"
    }
  }
}
Chaos Workflow

Delete ChaosWorkflow

Delete chaos workflow will permanently delete schedule workflow from the cluster. It cannot be undone. Note: User can access the details of deleted workflow inside MongoDB, which are being marked as removed.

Field Possible values Mandatory/Optional
workflowid - Mandatory
Example Body:
{

"workflowid": "2df3212c9f32447e28317b",

}
workflowid:
string

(no description)

workflow_run_id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteChaosWorkflow($workflowid: String, $workflow_run_id: String){
  deleteChaosWorkflow(workflowid: $workflowid, workflow_run_id: $workflow_run_id)
}
Variables
{
  "workflowid": "string",
  "workflow_run_id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteChaosWorkflow": "boolean"
  }
}
Chaos Workflow

Save Template

Save a scheduled workflow as a template. Provide a workflow name and description, and use the scheduled manifest as a template.

Field Possible values Mandatory/Optional
isCustomWorkflow true/false/td> Optional
manifest "kind: CronWorkflow\napiVersion: argoproj.io/v1alpha1\nmetadata:\n name: bank-of-anthos-1626851266\n namespace: litmus\n .... Mandatory
project_id - Mandatory
template_name new-saved-template Mandatory
template_description Demo Description Mandatory
templateInput:

(no description)

Example

Request Content-Types: application/json
Query
mutation createManifestTemplate($templateInput: TemplateInput){
  createManifestTemplate(templateInput: $templateInput){
    template_id
    manifest
    template_name
    template_description
    project_id
    project_name
    created_at
    is_removed
    isCustomWorkflow
  }
}
Variables
{
  "templateInput": {
    "manifest": "string",
    "template_name": "string",
    "template_description": "string",
    "project_id": "string",
    "isCustomWorkflow": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createManifestTemplate": {
      "template_id": "string",
      "manifest": "string",
      "template_name": "string",
      "template_description": "string",
      "project_id": "string",
      "project_name": "string",
      "created_at": "string",
      "is_removed": "boolean",
      "isCustomWorkflow": "boolean"
    }
  }
}
Chaos Workflow

List Manifest Template

This query lists all the available Templates present in a particular project.

Field Possible values Mandatory/Optional
project_id - Mandatory
project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query ListManifestTemplate($project_id: String!){
  ListManifestTemplate(project_id: $project_id){
    template_id
    manifest
    template_name
    template_description
    project_id
    project_name
    created_at
    is_removed
    isCustomWorkflow
  }
}
Variables
{
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
ManifestTemplate
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "ListManifestTemplate": [
      {
        "template_id": "string",
        "manifest": "string",
        "template_name": "string",
        "template_description": "string",
        "project_id": "string",
        "project_name": "string",
        "created_at": "string",
        "is_removed": "boolean",
        "isCustomWorkflow": "boolean"
      }
    ]
  }
}
Chaos Workflow

Get Template Manifest

This query fetches the manifest from a selected template. It takes the template_id as an input.

Field Possible values Mandatory/Optional
template_id - Mandatory
template_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query GetTemplateManifestByID($template_id: String!){
  GetTemplateManifestByID(template_id: $template_id){
    template_id
    manifest
    template_name
    template_description
    project_id
    project_name
    created_at
    is_removed
    isCustomWorkflow
  }
}
Variables
{
  "template_id": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetTemplateManifestByID": {
      "template_id": "string",
      "manifest": "string",
      "template_name": "string",
      "template_description": "string",
      "project_id": "string",
      "project_name": "string",
      "created_at": "string",
      "is_removed": "boolean",
      "isCustomWorkflow": "boolean"
    }
  }
}

ChaosHub

ChaosHub constructs workflow from a set of experiments from Chaos Hub or the Git Repo. There is a public hub which get cloned during the installation by default.

ChaosHub

Add ChaosHub

User can add chaoshub easily via the myhub page of the Litmus Portal dashboard. After adding chaoshub, it will clone the git repository which has the chaos charts. You can connect both Public and Private Repositories. For Private Repositories, user can authenticate using Access Token or SSH for cloning the repository.

Field Possible values Mandatory/Optional
RepoURL - Mandatory
RepoBranch - Mandatory
HubName - Mandatory
IsPrivate - Mandatory
AuthType - Mandatory
Token - Optional
UserName - Optional
Password - Optional
SSHPublicKey - Optional
SSHPrivateKey - Optional
ProjectID - Mandatory
Example Body:
{

"RepoURL": "https://github.com/litmuschaos/chaos-charts",
"RepoBranch": "master",
"HubName": "my-chaos-hub",

}
myhubInput:

(no description)

projectID:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation addMyHub($myhubInput: CreateMyHub!, $projectID: String!){
  addMyHub(myhubInput: $myhubInput, projectID: $projectID){
    id
    RepoURL
    RepoBranch
    ProjectID
    HubName
    IsPrivate
    AuthType
    Token
    UserName
    Password
    SSHPrivateKey
    IsRemoved
    CreatedAt
    UpdatedAt
    LastSyncedAt
  }
}
Variables
{
  "myhubInput": {
    "HubName": "string",
    "RepoURL": "string",
    "RepoBranch": "string",
    "IsPrivate": "boolean",
    "AuthType": "string",
    "Token": "string",
    "UserName": "string",
    "Password": "string",
    "SSHPrivateKey": "string",
    "SSHPublicKey": "string"
  },
  "projectID": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "addMyHub": {
      "id": "string",
      "RepoURL": "string",
      "RepoBranch": "string",
      "ProjectID": "string",
      "HubName": "string",
      "IsPrivate": "boolean",
      "Token": "string",
      "UserName": "string",
      "Password": "string",
      "SSHPrivateKey": "string",
      "IsRemoved": "boolean",
      "CreatedAt": "string",
      "UpdatedAt": "string",
      "LastSyncedAt": "string"
    }
  }
}
ChaosHub

List ChaosHub

Returns a list of ChaosHub connected with Litmus Portal along with the status and the total number of experiments.

Field Possible values Mandatory/Optional
projectID - Mandatory
Example Body:
{

"projectID": "5fd7d9212c9f32447e28317b",

}
projectID:
string

(no description)

Example

Request Content-Types: application/json
Query
query getHubStatus($projectID: String!){
  getHubStatus(projectID: $projectID){
    id
    RepoURL
    RepoBranch
    IsAvailable
    TotalExp
    HubName
    IsPrivate
    AuthType
    Token
    UserName
    Password
    IsRemoved
    SSHPrivateKey
    SSHPublicKey
    LastSyncedAt
  }
}
Variables
{
  "projectID": "string"
}
Try it now
200 OK

Successful operation

type
MyHubStatus
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getHubStatus": [
      {
        "id": "string",
        "RepoURL": "string",
        "RepoBranch": "string",
        "IsAvailable": "boolean",
        "TotalExp": "string",
        "HubName": "string",
        "IsPrivate": "boolean",
        "Token": "string",
        "UserName": "string",
        "Password": "string",
        "IsRemoved": "boolean",
        "SSHPrivateKey": "string",
        "SSHPublicKey": "string",
        "LastSyncedAt": "string"
      }
    ]
  }
}
ChaosHub

Sync ChaosHub

Sync hub will pull the latest commits from the git repository.

Field Possible values Mandatory/Optional
id - Mandatory
Example Body:
{

"id": "5fd7d9212c9f32447e28317b",

}
id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation syncHub($id: ID!){
  syncHub(id: $id){
    id
    RepoURL
    RepoBranch
    IsAvailable
    TotalExp
    HubName
    IsPrivate
    AuthType
    Token
    UserName
    Password
    IsRemoved
    SSHPrivateKey
    SSHPublicKey
    LastSyncedAt
  }
}
Variables
{
  "id": "string"
}
Try it now
200 OK

Successful operation

type
MyHubStatus
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "syncHub": [
      {
        "id": "string",
        "RepoURL": "string",
        "RepoBranch": "string",
        "IsAvailable": "boolean",
        "TotalExp": "string",
        "HubName": "string",
        "IsPrivate": "boolean",
        "Token": "string",
        "UserName": "string",
        "Password": "string",
        "IsRemoved": "boolean",
        "SSHPrivateKey": "string",
        "SSHPublicKey": "string",
        "LastSyncedAt": "string"
      }
    ]
  }
}
ChaosHub

Update Hub

Update the hub configuration of a ChaosHub

Field Possible values Mandatory/Optional
id - Mandatory
RepoURL - Mandatory
RepoBranch - Mandatory
HubName - Mandatory
IsPrivate - Mandatory
AuthType - Mandatory
Token - Optional
UserName - Optional
Password - Optional
SSHPublicKey - Optional
SSHPrivateKey - Optional
ProjectID - Mandatory
myhubInput:

(no description)

projectID:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation updateMyHub($myhubInput: UpdateMyHub!, $projectID: String!){
  updateMyHub(myhubInput: $myhubInput, projectID: $projectID){
    id
    RepoURL
    RepoBranch
    ProjectID
    HubName
    IsPrivate
    AuthType
    Token
    UserName
    Password
    SSHPrivateKey
    IsRemoved
    CreatedAt
    UpdatedAt
    LastSyncedAt
  }
}
Variables
{
  "myhubInput": {
    "id": "string",
    "HubName": "string",
    "RepoURL": "string",
    "RepoBranch": "string",
    "IsPrivate": "boolean",
    "AuthType": "string",
    "Token": "string",
    "UserName": "string",
    "Password": "string",
    "SSHPrivateKey": "string",
    "SSHPublicKey": "string"
  },
  "projectID": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateMyHub": {
      "id": "string",
      "RepoURL": "string",
      "RepoBranch": "string",
      "ProjectID": "string",
      "HubName": "string",
      "IsPrivate": "boolean",
      "Token": "string",
      "UserName": "string",
      "Password": "string",
      "SSHPrivateKey": "string",
      "IsRemoved": "boolean",
      "CreatedAt": "string",
      "UpdatedAt": "string",
      "LastSyncedAt": "string"
    }
  }
}
ChaosHub

Delete Hub

Delete a ChaosHub from the project

Field Possible values Mandatory/Optional
hub_id - Mandatory
hub_id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteMyHub($hub_id: String!){
  deleteMyHub(hub_id: $hub_id)
}
Variables
{
  "hub_id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteMyHub": "boolean"
  }
}
ChaosHub

Get Charts

Get all the charts from a hub

Field Possible values Mandatory/Optional
HubName - Mandatory
projectID - Mandatory
HubName:
string

(no description)

projectID:
string

(no description)

Example

Request Content-Types: application/json
Query
query getCharts($HubName: String!, $projectID: String!){
  getCharts(HubName: $HubName, projectID: $projectID){
    ApiVersion
    Kind
  }
}
Variables
{
  "HubName": "string",
  "projectID": "string"
}
Try it now
200 OK

Successful operation

type
Chart
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getCharts": [
      {
        "ApiVersion": "string",
        "Kind": "string"
      }
    ]
  }
}
ChaosHub

Get Hub Experiments

Get the experiment details from a selected chart

Field Possible values Mandatory/Optional
ProjectID - Mandatory
ChartName - Mandatory
ExperimentName - Mandatory
HubName - Mandatory
FileType - Optional
experimentInput:

(no description)

Example

Request Content-Types: application/json
Query
query getHubExperiment($experimentInput: ExperimentInput!){
  getHubExperiment(experimentInput: $experimentInput){
    ApiVersion
    Kind
  }
}
Variables
{
  "experimentInput": {
    "ProjectID": "string",
    "ChartName": "string",
    "ExperimentName": "string",
    "HubName": "string",
    "FileType": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getHubExperiment": {
      "ApiVersion": "string",
      "Kind": "string"
    }
  }
}
ChaosHub

Get Experiment YAML

With this query, user can fetch engine or experiment manifest from a hub.

Field Possible values Mandatory/Optional
ProjectID - Mandatory
ChartName - Mandatory
ExperimentName - Mandatory
HubName - Mandatory
FileType - Optional
experimentInput:

(no description)

Example

Request Content-Types: application/json
Query
query getYAMLData($experimentInput: ExperimentInput!){
  getYAMLData(experimentInput: $experimentInput)
}
Variables
{
  "experimentInput": {
    "ProjectID": "string",
    "ChartName": "string",
    "ExperimentName": "string",
    "HubName": "string",
    "FileType": "string"
  }
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getYAMLData": "string"
  }
}
ChaosHub

Get Pre-defined workflow

List of all the pre-defined workflows present in a ChaosHub

Field Possible values Mandatory/Optional
projectID - Mandatory
HubName - Mandatory
HubName:
string

(no description)

projectID:
string

(no description)

Example

Request Content-Types: application/json
Query
query GetPredefinedWorkflowList($HubName: String!, $projectID: String!){
  GetPredefinedWorkflowList(HubName: $HubName, projectID: $projectID)
}
Variables
{
  "HubName": "string",
  "projectID": "string"
}
Try it now
200 OK

Successful operation

type
string[]
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetPredefinedWorkflowList": [
      "string"
    ]
  }
}
ChaosHub

Get Pre-defined Workflow Manifest

With this query, user can fetch engine or experiment manifest from a hub.

Field Possible values Mandatory/Optional
ProjectID - Mandatory
ChartName - Mandatory
ExperimentName - Mandatory
HubName - Mandatory
FileType - Optional
experimentInput:

(no description)

Example

Request Content-Types: application/json
Query
query GetPredefinedExperimentYAML($experimentInput: ExperimentInput!){
  GetPredefinedExperimentYAML(experimentInput: $experimentInput)
}
Variables
{
  "experimentInput": {
    "ProjectID": "string",
    "ChartName": "string",
    "ExperimentName": "string",
    "HubName": "string",
    "FileType": "string"
  }
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetPredefinedExperimentYAML": "string"
  }
}

Workflow Management

Workflow Management APIs are used to manage the workflows with GitOPs. These also allow the user to use custom image registries for the chaos workflows.

Workflow Management

Enable GitOps

This query is used to enable gitops functionality

Field Possible values Mandatory/Optional
ProjectID - Mandatory
Branch - Mandatory
RepoURL - Mandatory
AuthType - Mandatory
Token - Mandatory
UserName - Optional
Password - Optional
SSHPrivateKey - Mandatory
config:

(no description)

Example

Request Content-Types: application/json
Query
mutation enableGitOps($config: GitConfig!){
  enableGitOps(config: $config)
}
Variables
{
  "config": {
    "ProjectID": "string",
    "Branch": "string",
    "RepoURL": "string",
    "AuthType": "string",
    "Token": "string",
    "UserName": "string",
    "Password": "string",
    "SSHPrivateKey": "string"
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "enableGitOps": "boolean"
  }
}
Workflow Management

Disable GitOps

This query is used to disable gitops functionality

Field Possible values Mandatory/Optional
project_id - Mandatory
project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation disableGitOps($project_id: String!){
  disableGitOps(project_id: $project_id)
}
Variables
{
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "disableGitOps": "boolean"
  }
}
Workflow Management

Get GitOPs Details

This query is used to get the gitops details and configurations

Field Possible values Mandatory/Optional
project_id - Mandatory
project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query getGitOpsDetails($project_id: String!){
  getGitOpsDetails(project_id: $project_id){
    Enabled
    ProjectID
    Branch
    RepoURL
    AuthType
    Token
    UserName
    Password
    SSHPrivateKey
  }
}
Variables
{
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getGitOpsDetails": {
      "Enabled": "boolean",
      "ProjectID": "string",
      "Branch": "string",
      "RepoURL": "string",
      "Token": "string",
      "UserName": "string",
      "Password": "string",
      "SSHPrivateKey": "string"
    }
  }
}
Workflow Management

Update GitOps

This query is used to update the gitops details and configurations

Field Possible values Mandatory/Optional
ProjectID - Mandatory
Branch - Mandatory
RepoURL - Mandatory
AuthType - Mandatory
Token - Mandatory
UserName - Optional
Password - Optional
SSHPrivateKey - Mandatory
config:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateGitOps($config: GitConfig!){
  updateGitOps(config: $config)
}
Variables
{
  "config": {
    "ProjectID": "string",
    "Branch": "string",
    "RepoURL": "string",
    "AuthType": "string",
    "Token": "string",
    "UserName": "string",
    "Password": "string",
    "SSHPrivateKey": "string"
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateGitOps": "boolean"
  }
}
Workflow Management

List Image Regisry

This query is used to list all the image registries.

Field Possible values Mandatory/Optional
project_id - Mandatory
project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query ListImageRegistry($project_id: String!){
  ListImageRegistry(project_id: $project_id){
    is_default
    image_registry_id
    project_id
    updated_at
    created_at
    is_removed
  }
}
Variables
{
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
ImageRegistryResponse
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "ListImageRegistry": [
      {
        "is_default": "boolean",
        "image_registry_id": "string",
        "project_id": "string",
        "updated_at": "string",
        "created_at": "string",
        "is_removed": "boolean"
      }
    ]
  }
}
Workflow Management

Create Image Registry

This query is used to create a new image registry.

Field Possible values Mandatory/Optional
project_id - Mandatory
is_default true/false Mandatory
image_registry_name - Mandatory
image_repo_name - Mandatory
image_registry_type - Mandatory
secret_name - Optional
secret_namespace - Optional
enable_registry - Optional
project_id:
string

(no description)

imageRegistryInfo:

(no description)

Example

Request Content-Types: application/json
Query
mutation createImageRegistry($project_id: String!, $imageRegistryInfo: imageRegistryInput!){
  createImageRegistry(project_id: $project_id, imageRegistryInfo: $imageRegistryInfo){
    is_default
    image_registry_id
    project_id
    updated_at
    created_at
    is_removed
  }
}
Variables
{
  "project_id": "string",
  "imageRegistryInfo": {
    "is_default": "boolean",
    "image_registry_name": "string",
    "image_repo_name": "string",
    "image_registry_type": "string",
    "secret_name": "string",
    "secret_namespace": "string",
    "enable_registry": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createImageRegistry": {
      "is_default": "boolean",
      "image_registry_id": "string",
      "project_id": "string",
      "updated_at": "string",
      "created_at": "string",
      "is_removed": "boolean"
    }
  }
}
Workflow Management

Get Image Registry

This query is used to get the the image registry from the project_id and image_registry_id

Field Possible values Mandatory/Optional
project_id - Mandatory
image_registry_id - Mandatory
image_registry_id:
string

(no description)

project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query GetImageRegistry($image_registry_id: String!, $project_id: String!){
  GetImageRegistry(image_registry_id: $image_registry_id, project_id: $project_id){
    is_default
    image_registry_id
    project_id
    updated_at
    created_at
    is_removed
  }
}
Variables
{
  "image_registry_id": "string",
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetImageRegistry": {
      "is_default": "boolean",
      "image_registry_id": "string",
      "project_id": "string",
      "updated_at": "string",
      "created_at": "string",
      "is_removed": "boolean"
    }
  }
}
Workflow Management

Update Image Registry

This query is used to update the image registry.

Field Possible values Mandatory/Optional
image_registry_id - Mandatory
project_id - Mandatory
is_default true/false Mandatory
image_registry_name - Mandatory
image_repo_name - Mandatory
image_registry_type - Mandatory
secret_name - Optional
secret_namespace - Optional
enable_registry - Optional
image_registry_id:
string

(no description)

project_id:
string

(no description)

imageRegistryInfo:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateImageRegistry($image_registry_id: String!, $project_id: String!, $imageRegistryInfo: imageRegistryInput!){
  updateImageRegistry(image_registry_id: $image_registry_id, project_id: $project_id, imageRegistryInfo: $imageRegistryInfo){
    is_default
    image_registry_id
    project_id
    updated_at
    created_at
    is_removed
  }
}
Variables
{
  "image_registry_id": "string",
  "project_id": "string",
  "imageRegistryInfo": {
    "is_default": "boolean",
    "image_registry_name": "string",
    "image_repo_name": "string",
    "image_registry_type": "string",
    "secret_name": "string",
    "secret_namespace": "string",
    "enable_registry": "boolean"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateImageRegistry": {
      "is_default": "boolean",
      "image_registry_id": "string",
      "project_id": "string",
      "updated_at": "string",
      "created_at": "string",
      "is_removed": "boolean"
    }
  }
}
Workflow Management

Delete Image Registry

This query is used to delete the image registry

Field Possible values Mandatory/Optional
project_id - Mandatory
image_registry_id - Mandatory
image_registry_id:
string

(no description)

project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteImageRegistry($image_registry_id: String!, $project_id: String!){
  deleteImageRegistry(image_registry_id: $image_registry_id, project_id: $project_id)
}
Variables
{
  "image_registry_id": "string",
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteImageRegistry": "string"
  }
}

Analytics

Analytics allows user to visualize the chaos metrics with the help of different dashboards and graphs present in the Litmus Portal.

Analytics

Get HeatMap Data

This query is used to get year-wise calendar heatmap of daily average resilience scores for workflow runs.

Field Possible values Mandatory/Optional
project_id - Mandatory
workflow_id - Mandatory
year - Mandatory
project_id:
string

(no description)

workflow_id:
string

(no description)

year:
integer

(no description)

Example

Request Content-Types: application/json
Query
query getHeatmapData($project_id: String!, $workflow_id: String!, $year: Int!){
  getHeatmapData(project_id: $project_id, workflow_id: $workflow_id, year: $year){
  }
}
Variables
{
  "project_id": "string",
  "workflow_id": "string",
  "year": "integer"
}
Try it now
200 OK

Successful operation

type
HeatmapData
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getHeatmapData": [
      {}
    ]
  }
}
Analytics

Get Workflow Stats

This query is used to get monthly, daily and hourly workflow schedule and run statistics as a time series.

Field Possible values Mandatory/Optional
project_id - Mandatory
filter - Mandatory
show_workflow_runs - Mandatory
project_id:
string

(no description)

filter:

(no description)

show_workflow_runs:
boolean

(no description)

Example

Request Content-Types: application/json
Query
query getWorkflowStats($project_id: ID!, $filter: TimeFrequency!, $show_workflow_runs: Boolean!){
  getWorkflowStats(project_id: $project_id, filter: $filter, show_workflow_runs: $show_workflow_runs){
    date
    value
  }
}
Variables
{
  "project_id": "string",
  "filter": "string",
  "show_workflow_runs": "boolean"
}
Try it now
200 OK

Successful operation

type
WorkflowStats
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getWorkflowStats": [
      {
        "date": "number",
        "value": "integer"
      }
    ]
  }
}
Analytics

Get Workflow Run Stats

This query is used to get aggregated workflow and experiment statistics for completed runs of selected schedules.

Field Possible values Mandatory/Optional
project_id - Mandatory
workflow_ids - Mandatory
workflowRunStatsRequest:

(no description)

Example

Request Content-Types: application/json
Query
query getWorkflowRunStats($workflowRunStatsRequest: WorkflowRunStatsRequest!){
  getWorkflowRunStats(workflowRunStatsRequest: $workflowRunStatsRequest){
    total_workflow_runs
    succeeded_workflow_runs
    failed_workflow_runs
    running_workflow_runs
    average_resiliency_score
    total_experiments
    experiments_passed
    experiments_failed
    experiments_awaited
    experiments_stopped
    experiments_na
    passed_percentage
    failed_percentage
    workflow_run_succeeded_percentage
    workflow_run_failed_percentage
  }
}
Variables
{
  "workflowRunStatsRequest": {
    "project_id": "object",
    "workflow_ids": [
      "object"
    ]
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "getWorkflowRunStats": {
      "total_workflow_runs": "integer",
      "succeeded_workflow_runs": "integer",
      "failed_workflow_runs": "integer",
      "running_workflow_runs": "integer",
      "average_resiliency_score": "number",
      "total_experiments": "integer",
      "experiments_passed": "integer",
      "experiments_failed": "integer",
      "experiments_awaited": "integer",
      "experiments_stopped": "integer",
      "experiments_na": "integer",
      "passed_percentage": "number",
      "failed_percentage": "number",
      "workflow_run_succeeded_percentage": "number",
      "workflow_run_failed_percentage": "number"
    }
  }
}
Analytics

List DataSource

This query is used to list all connected data sources in a project.

Field Possible values Mandatory/Optional
project_id - Mandatory
project_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query ListDataSource($project_id: String!){
  ListDataSource(project_id: $project_id){
    ds_id
    ds_name
    ds_type
    ds_url
    access_type
    auth_type
    basic_auth_username
    basic_auth_password
    scrape_interval
    query_timeout
    http_method
    project_id
    health_status
    created_at
    updated_at
  }
}
Variables
{
  "project_id": "string"
}
Try it now
200 OK

Successful operation

type
DSResponse
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "ListDataSource": [
      {
        "ds_id": "string",
        "ds_name": "string",
        "ds_type": "string",
        "ds_url": "string",
        "access_type": "string",
        "auth_type": "string",
        "basic_auth_username": "string",
        "basic_auth_password": "string",
        "scrape_interval": "integer",
        "query_timeout": "integer",
        "http_method": "string",
        "project_id": "string",
        "health_status": "string",
        "created_at": "string",
        "updated_at": "string"
      }
    ]
  }
}
Analytics

Get Prom Query

This query is used to get prometheus time series data from promQL queries and data source details.

query:

(no description)

Example

Request Content-Types: application/json
Query
query GetPromQuery($query: promInput){
  GetPromQuery(query: $query){
  }
}
Variables
{
  "query": {
    "queries": [
      {
        "queryid": "string",
        "query": "string",
        "legend": "string",
        "resolution": "string",
        "minstep": "number"
      }
    ],
    "ds_details": {
      "url": "string",
      "start": "string",
      "end": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetPromQuery": {}
  }
}
Analytics

Get Prom Label names and values

This query is used to get labels and values associated with a prometheus metric and a given data source.

Field Possible values Mandatory/Optional
series - Mandatory
ds_details.url - Mandatory
ds_details.start - Mandatory
ds_details.end - Mandatory
series:

(no description)

Example

Request Content-Types: application/json
Query
query GetPromLabelNamesAndValues($series: promSeriesInput){
  GetPromLabelNamesAndValues(series: $series){
    series
  }
}
Variables
{
  "series": {
    "series": "string",
    "ds_details": {
      "url": "string",
      "start": "string",
      "end": "string"
    }
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetPromLabelNamesAndValues": {
      "series": "string"
    }
  }
}
Analytics

Get Prom Series List

This query is used to get a list of all time series metric names available on a prometheus data source.

Field Possible values Mandatory/Optional
url - Mandatory
start - Mandatory
end - Mandatory
ds_details:

(no description)

Example

Request Content-Types: application/json
Query
query GetPromSeriesList($ds_details: dsDetails){
  GetPromSeriesList(ds_details: $ds_details){
    seriesList
  }
}
Variables
{
  "ds_details": {
    "url": "string",
    "start": "string",
    "end": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "GetPromSeriesList": {
      "seriesList": [
        "string"
      ]
    }
  }
}
Analytics

List Dashboard

This query is used to list all dashboards created in a project.

Field Possible values Mandatory/Optional
project_id - Mandatory
cluster_id - Mandatory
db_id - Mandatory
project_id:
string

(no description)

cluster_id:
string

(no description)

db_id:
string

(no description)

Example

Request Content-Types: application/json
Query
query ListDashboard($project_id: String!, $cluster_id: String, $db_id: String){
  ListDashboard(project_id: $project_id, cluster_id: $cluster_id, db_id: $db_id){
    ds_id
    db_id
    db_name
    db_type_id
    db_type_name
    db_information
    chaos_event_query_template
    chaos_verdict_query_template
    cluster_name
    ds_name
    ds_type
    ds_url
    ds_health_status
    end_time
    start_time
    refresh_rate
    project_id
    cluster_id
    created_at
    updated_at
    viewed_at
  }
}
Variables
{
  "project_id": "string",
  "cluster_id": "string",
  "db_id": "string"
}
Try it now
200 OK

Successful operation

type
listDashboardResponse
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "ListDashboard": [
      {
        "ds_id": "string",
        "db_id": "string",
        "db_name": "string",
        "db_type_id": "string",
        "db_type_name": "string",
        "db_information": "string",
        "chaos_event_query_template": "string",
        "chaos_verdict_query_template": "string",
        "cluster_name": "string",
        "ds_name": "string",
        "ds_type": "string",
        "ds_url": "string",
        "ds_health_status": "string",
        "end_time": "string",
        "start_time": "string",
        "refresh_rate": "string",
        "project_id": "string",
        "cluster_id": "string",
        "created_at": "string",
        "updated_at": "string",
        "viewed_at": "string"
      }
    ]
  }
}
Analytics

Portal Dashboard Data

This query is used to list all pre-configured dashboard templates available in litmus center.

Field Possible values Mandatory/Optional
project_id - Mandatory
hub_name - Mandatory
project_id:
string

(no description)

hub_name:
string

(no description)

Example

Request Content-Types: application/json
Query
query PortalDashboardData($project_id: String!, $hub_name: String!){
  PortalDashboardData(project_id: $project_id, hub_name: $hub_name){
    name
    dashboard_data
  }
}
Variables
{
  "project_id": "string",
  "hub_name": "string"
}
Try it now
200 OK

Successful operation

type
PortalDashboardData
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "PortalDashboardData": [
      {
        "name": "string",
        "dashboard_data": "string"
      }
    ]
  }
}
Analytics

Create DataSource

This mutation is used to add a prometheus data source to the project which serves as a metrics collector for agent clusters.

Field Possible values Mandatory/Optional
ds_name - Mandatory
ds_type - Mandatory
ds_url - Mandatory
access_type - Mandatory
auth_type - Mandatory
basic_auth_username - Mandatory
basic_auth_password - Mandatory
scrape_interval - Mandatory
query_timeout - Mandatory
http_method - Mandatory
project_id - Mandatory
Example Body:
{

"ds_name": "sample data source",
"ds_type": "Prometheus",
"access_type": "Server (Default)",
"auth_type": "no auth",
"basic_auth_password": "",
"basic_auth_username": "",
"ds_url": "https://demo.com:9090",
"http_method": "POST",
"project_id": "4c3d0513-5988-446e-8ce5-1a4c6fb274f3",
"query_timeout": "30",
"scrape_interval": "15",

}
datasource:

(no description)

Example

Request Content-Types: application/json
Query
mutation createDataSource($datasource: DSInput){
  createDataSource(datasource: $datasource){
    ds_id
    ds_name
    ds_type
    ds_url
    access_type
    auth_type
    basic_auth_username
    basic_auth_password
    scrape_interval
    query_timeout
    http_method
    project_id
    health_status
    created_at
    updated_at
  }
}
Variables
{
  "datasource": {
    "ds_id": "string",
    "ds_name": "string",
    "ds_type": "string",
    "ds_url": "string",
    "access_type": "string",
    "auth_type": "string",
    "basic_auth_username": "string",
    "basic_auth_password": "string",
    "scrape_interval": "number",
    "query_timeout": "number",
    "http_method": "string",
    "project_id": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createDataSource": {
      "ds_id": "string",
      "ds_name": "string",
      "ds_type": "string",
      "ds_url": "string",
      "access_type": "string",
      "auth_type": "string",
      "basic_auth_username": "string",
      "basic_auth_password": "string",
      "scrape_interval": "integer",
      "query_timeout": "integer",
      "http_method": "string",
      "project_id": "string",
      "health_status": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}
Analytics

Create Dashboard

This mutation is used to create an application dashboard providing agent information, data source details and prometheus queries.

dashboard:

(no description)

Example

Request Content-Types: application/json
Query
mutation createDashBoard($dashboard: createDBInput){
  createDashBoard(dashboard: $dashboard){
    ds_id
    db_id
    db_name
    db_type_id
    db_type_name
    db_information
    chaos_event_query_template
    chaos_verdict_query_template
    cluster_name
    ds_name
    ds_type
    ds_url
    ds_health_status
    end_time
    start_time
    refresh_rate
    project_id
    cluster_id
    created_at
    updated_at
    viewed_at
  }
}
Variables
{
  "dashboard": {
    "ds_id": "string",
    "db_name": "string",
    "db_type_name": "string",
    "db_type_id": "string",
    "db_information": "string",
    "chaos_event_query_template": "string",
    "chaos_verdict_query_template": "string",
    "application_metadata_map": [
      {
        "namespace": "string",
        "applications": [
          {
            "kind": "string",
            "names": [
              "string"
            ]
          }
        ]
      }
    ],
    "panel_groups": [
      {
        "panels": [
          {
            "panel_id": "string",
            "db_id": "string",
            "y_axis_left": "string",
            "y_axis_right": "string",
            "x_axis_down": "string",
            "unit": "string",
            "panel_group_id": "string",
            "created_at": "string",
            "prom_queries": [
              {
                "queryid": "string",
                "prom_query_name": "string",
                "legend": "string",
                "resolution": "string",
                "minstep": "string",
                "line": "boolean",
                "close_area": "boolean"
              }
            ],
            "panel_options": {
              "points": "boolean",
              "grids": "boolean",
              "left_axis": "boolean"
            },
            "panel_name": "string"
          }
        ],
        "panel_group_name": "string"
      }
    ],
    "end_time": "string",
    "start_time": "string",
    "project_id": "object",
    "cluster_id": "object",
    "refresh_rate": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "createDashBoard": {
      "ds_id": "string",
      "db_id": "string",
      "db_name": "string",
      "db_type_id": "string",
      "db_type_name": "string",
      "db_information": "string",
      "chaos_event_query_template": "string",
      "chaos_verdict_query_template": "string",
      "cluster_name": "string",
      "ds_name": "string",
      "ds_type": "string",
      "ds_url": "string",
      "ds_health_status": "string",
      "end_time": "string",
      "start_time": "string",
      "refresh_rate": "string",
      "project_id": "string",
      "cluster_id": "string",
      "created_at": "string",
      "updated_at": "string",
      "viewed_at": "string"
    }
  }
}
Analytics

Update DataSource

This mutation is used to update a conncted data source's information.

Field Possible values Mandatory/Optional
ds_id - Mandatory
ds_name - Mandatory
ds_type - Mandatory
ds_url - Mandatory
access_type - Mandatory
auth_type - Mandatory
basic_auth_username - Mandatory
basic_auth_password - Mandatory
scrape_interval - Mandatory
query_timeout - Mandatory
http_method - Mandatory
project_id - Mandatory
Example Body:
{

"ds_id": "sample data source",
"ds_name": "sample data source",
"ds_type": "Prometheus",
"access_type": "Server (Default)",
"auth_type": "no auth",
"basic_auth_password": "",
"basic_auth_username": "",
"ds_url": "https://demo.com:9090",
"http_method": "POST",
"project_id": "4c3d0513-5988-446e-8ce5-1a4c6fb274f3",
"query_timeout": "30",
"scrape_interval": "15",

}
datasource:

(no description)

Example

Request Content-Types: application/json
Query
mutation updateDataSource($datasource: DSInput!){
  updateDataSource(datasource: $datasource){
    ds_id
    ds_name
    ds_type
    ds_url
    access_type
    auth_type
    basic_auth_username
    basic_auth_password
    scrape_interval
    query_timeout
    http_method
    project_id
    health_status
    created_at
    updated_at
  }
}
Variables
{
  "datasource": {
    "ds_id": "string",
    "ds_name": "string",
    "ds_type": "string",
    "ds_url": "string",
    "access_type": "string",
    "auth_type": "string",
    "basic_auth_username": "string",
    "basic_auth_password": "string",
    "scrape_interval": "number",
    "query_timeout": "number",
    "http_method": "string",
    "project_id": "string"
  }
}
Try it now
200 OK

Successful operation

type
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateDataSource": {
      "ds_id": "string",
      "ds_name": "string",
      "ds_type": "string",
      "ds_url": "string",
      "access_type": "string",
      "auth_type": "string",
      "basic_auth_username": "string",
      "basic_auth_password": "string",
      "scrape_interval": "integer",
      "query_timeout": "integer",
      "http_method": "string",
      "project_id": "string",
      "health_status": "string",
      "created_at": "string",
      "updated_at": "string"
    }
  }
}
Analytics

Update Dashboard

This mutation is used to update a dashboard's information and details.

dashboard:

(no description)

chaosQueryUpdate:
boolean

(no description)

Example

Request Content-Types: application/json
Query
mutation updateDashboard($dashboard: updateDBInput!, $chaosQueryUpdate: Boolean!){
  updateDashboard(dashboard: $dashboard, chaosQueryUpdate: $chaosQueryUpdate)
}
Variables
{
  "dashboard": {
    "db_id": "string",
    "ds_id": "string",
    "db_name": "string",
    "db_type_name": "string",
    "db_type_id": "string",
    "db_information": "string",
    "chaos_event_query_template": "string",
    "chaos_verdict_query_template": "string",
    "application_metadata_map": [
      {
        "namespace": "string",
        "applications": [
          {
            "kind": "string",
            "names": [
              "string"
            ]
          }
        ]
      }
    ],
    "panel_groups": [
      {
        "panel_group_name": "string",
        "panel_group_id": "string",
        "panels": [
          {
            "panel_id": "string",
            "db_id": "string",
            "y_axis_left": "string",
            "y_axis_right": "string",
            "x_axis_down": "string",
            "unit": "string",
            "panel_group_id": "string",
            "created_at": "string",
            "prom_queries": [
              {
                "queryid": "string",
                "prom_query_name": "string",
                "legend": "string",
                "resolution": "string",
                "minstep": "string",
                "line": "boolean",
                "close_area": "boolean"
              }
            ],
            "panel_options": {
              "points": "boolean",
              "grids": "boolean",
              "left_axis": "boolean"
            },
            "panel_name": "string"
          }
        ]
      }
    ],
    "end_time": "string",
    "start_time": "string",
    "cluster_id": "object",
    "refresh_rate": "string"
  },
  "chaosQueryUpdate": "boolean"
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updateDashboard": "string"
  }
}
Analytics

Update Panel

This mutation is used to update prometheus queries and panel details for selected panels.

panelInput:
panel

(no description)

Example

Request Content-Types: application/json
Query
mutation updatePanel($panelInput: [panel]){
  updatePanel(panelInput: $panelInput)
}
Variables
{
  "panelInput": [
    {
      "panel_id": "string",
      "db_id": "string",
      "y_axis_left": "string",
      "y_axis_right": "string",
      "x_axis_down": "string",
      "unit": "string",
      "panel_group_id": "string",
      "created_at": "string",
      "prom_queries": [
        {
          "queryid": "string",
          "prom_query_name": "string",
          "legend": "string",
          "resolution": "string",
          "minstep": "string",
          "line": "boolean",
          "close_area": "boolean"
        }
      ],
      "panel_options": {
        "points": "boolean",
        "grids": "boolean",
        "left_axis": "boolean"
      },
      "panel_name": "string"
    }
  ]
}
Try it now
200 OK

Successful operation

type
string
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "updatePanel": "string"
  }
}
Analytics

Delete Dashboard

This mutation is used to delete a dashboard from a project.

Field Possible values Mandatory/Optional
db_id - Mandatory
db_id:
string

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteDashboard($db_id: String){
  deleteDashboard(db_id: $db_id)
}
Variables
{
  "db_id": "string"
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteDashboard": "boolean"
  }
}
Analytics

Delete DataSource

Disconnect a data source from a project

Field Possible values Mandatory/Optional
force_delete - Mandatory
ds_id - Mandatory
input:

(no description)

Example

Request Content-Types: application/json
Query
mutation deleteDataSource($input: deleteDSInput!){
  deleteDataSource(input: $input)
}
Variables
{
  "input": {
    "force_delete": "boolean",
    "ds_id": "object"
  }
}
Try it now
200 OK

Successful operation

type
boolean
Response Content-Types: application/json
Response Example (200 OK) 
{
  "data": {
    "deleteDataSource": "boolean"
  }
}

Schema Definitions

ActionPayload: object

request_type:
String
k8s_manifest:
String
namespace:
String
external_data:
String
Example
{
  "request_type": "string",
  "k8s_manifest": "string",
  "namespace": "string",
  "external_data": "string"
}

AgentStat: object

Ns:
Int
Cluster:
Int
Total:
Int
Active:
Int
Example
{
  "Ns": "number",
  "Cluster": "number",
  "Total": "number",
  "Active": "number"
}

Annotation: object

Categories:
String
Vendor:
String
CreatedAt:
String
Repository:
String
Support:
String
ChartDescription:
String
Example
{
  "Categories": "string",
  "Vendor": "string",
  "CreatedAt": "string",
  "Repository": "string",
  "Support": "string",
  "ChartDescription": "string"
}

AuthType: string

object
none
object
basic
object
token
object
ssh

Boolean: boolean

The Boolean scalar type represents true or false.

Example
boolean

ChaosWorkFlowInput: object

workflow_id:
String
workflow_manifest:
String
cronSyntax:
String
workflow_name:
String
workflow_description:
String
weightages:
WeightagesInput
isCustomWorkflow:
Boolean
project_id:
ID
cluster_id:
ID
Example
{
  "workflow_id": "string",
  "workflow_manifest": "string",
  "cronSyntax": "string",
  "workflow_name": "string",
  "workflow_description": "string",
  "weightages": [
    {
      "experiment_name": "string",
      "weightage": "number"
    }
  ],
  "isCustomWorkflow": "boolean",
  "project_id": "object",
  "cluster_id": "object"
}

ChaosWorkFlowResponse: object

workflow_id:
String
cronSyntax:
String
workflow_name:
String
workflow_description:
String
isCustomWorkflow:
Boolean
Example
{
  "workflow_id": "string",
  "cronSyntax": "string",
  "workflow_name": "string",
  "workflow_description": "string",
  "isCustomWorkflow": "boolean"
}

Chart: object

ApiVersion:
String
Kind:
String
Metadata:
Spec:
PackageInfo:
Example
{
  "ApiVersion": "string",
  "Kind": "string",
  "Metadata": {
    "Name": "string",
    "Version": "string",
    "Annotations": {
      "Categories": "string",
      "Vendor": "string",
      "CreatedAt": "string",
      "Repository": "string",
      "Support": "string",
      "ChartDescription": "string"
    }
  },
  "Spec": {
    "DisplayName": "string",
    "CategoryDescription": "string",
    "Keywords": [
      "string"
    ],
    "Maturity": "string",
    "Maintainers": [
      {
        "Name": "string",
        "Email": "string"
      }
    ],
    "MinKubeVersion": "string",
    "Provider": "string",
    "Links": [
      {
        "Name": "string",
        "Url": "string"
      }
    ],
    "Experiments": [
      "string"
    ],
    "ChaosExpCRDLink": "string",
    "Platforms": [
      "string"
    ],
    "ChaosType": "string"
  },
  "PackageInfo": {
    "PackageName": "string",
    "Experiments": [
      {
        "Name": "string",
        "CSV": "string",
        "Desc": "string"
      }
    ]
  }
}

Charts: object

Charts:
Chart
Example
{
  "Charts": [
    {
      "ApiVersion": "string",
      "Kind": "string",
      "Metadata": {
        "Name": "string",
        "Version": "string",
        "Annotations": {
          "Categories": "string",
          "Vendor": "string",
          "CreatedAt": "string",
          "Repository": "string",
          "Support": "string",
          "ChartDescription": "string"
        }
      },
      "Spec": {
        "DisplayName": "string",
        "CategoryDescription": "string",
        "Keywords": [
          "string"
        ],
        "Maturity": "string",
        "Maintainers": [
          {
            "Name": "string",
            "Email": "string"
          }
        ],
        "MinKubeVersion": "string",
        "Provider": "string",
        "Links": [
          {
            "Name": "string",
            "Url": "string"
          }
        ],
        "Experiments": [
          "string"
        ],
        "ChaosExpCRDLink": "string",
        "Platforms": [
          "string"
        ],
        "ChaosType": "string"
      },
      "PackageInfo": {
        "PackageName": "string",
        "Experiments": [
          {
            "Name": "string",
            "CSV": "string",
            "Desc": "string"
          }
        ]
      }
    }
  ]
}

CloningInput: object

HubName:
String
ProjectID:
String
RepoBranch:
String
RepoURL:
String
IsPrivate:
Boolean
AuthType:
Token:
String
UserName:
String
Password:
String
SSHPrivateKey:
String
Example
{
  "HubName": "string",
  "ProjectID": "string",
  "RepoBranch": "string",
  "RepoURL": "string",
  "IsPrivate": "boolean",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "SSHPrivateKey": "string"
}

Cluster: object

cluster_id:
ID
project_id:
ID
cluster_name:
String
description:
String
platform_name:
String
access_key:
String
is_registered:
Boolean
is_cluster_confirmed:
Boolean
is_active:
Boolean
updated_at:
String
created_at:
String
cluster_type:
String
no_of_schedules:
Int
no_of_workflows:
Int
token:
String
agent_namespace:
String
serviceaccount:
String
agent_scope:
String
agent_ns_exists:
Boolean
agent_sa_exists:
Boolean
last_workflow_timestamp:
String
start_time:
String
version:
String
Example
{
  "cluster_id": "object",
  "project_id": "object",
  "cluster_name": "string",
  "description": "string",
  "platform_name": "string",
  "access_key": "string",
  "is_registered": "boolean",
  "is_cluster_confirmed": "boolean",
  "is_active": "boolean",
  "updated_at": "string",
  "created_at": "string",
  "cluster_type": "string",
  "no_of_schedules": "number",
  "no_of_workflows": "number",
  "token": "string",
  "agent_namespace": "string",
  "serviceaccount": "string",
  "agent_scope": "string",
  "agent_ns_exists": "boolean",
  "agent_sa_exists": "boolean",
  "last_workflow_timestamp": "string",
  "start_time": "string",
  "version": "string"
}

ClusterAction: object

project_id:
ID
action:
Example
{
  "project_id": "object",
  "action": {
    "request_type": "string",
    "k8s_manifest": "string",
    "namespace": "string",
    "external_data": "string"
  }
}

ClusterActionInput: object

cluster_id:
ID
action:
String
Example
{
  "cluster_id": "object",
  "action": "string"
}

ClusterConfirmResponse: object

isClusterConfirmed:
Boolean
newAccessKey:
String
cluster_id:
String
Example
{
  "isClusterConfirmed": "boolean",
  "newAccessKey": "string",
  "cluster_id": "string"
}

ClusterEvent: object

event_id:
ID
event_type:
String
event_name:
String
description:
String
cluster:
Example
{
  "event_id": "object",
  "event_type": "string",
  "event_name": "string",
  "description": "string",
  "cluster": {
    "cluster_id": "object",
    "project_id": "object",
    "cluster_name": "string",
    "description": "string",
    "platform_name": "string",
    "access_key": "string",
    "is_registered": "boolean",
    "is_cluster_confirmed": "boolean",
    "is_active": "boolean",
    "updated_at": "string",
    "created_at": "string",
    "cluster_type": "string",
    "no_of_schedules": "number",
    "no_of_workflows": "number",
    "token": "string",
    "agent_namespace": "string",
    "serviceaccount": "string",
    "agent_scope": "string",
    "agent_ns_exists": "boolean",
    "agent_sa_exists": "boolean",
    "last_workflow_timestamp": "string",
    "start_time": "string",
    "version": "string"
  }
}

ClusterEventInput: object

event_name:
String
description:
String
cluster_id:
String
access_key:
String
Example
{
  "event_name": "string",
  "description": "string",
  "cluster_id": "string",
  "access_key": "string"
}

ClusterIdentity: object

cluster_id:
String
access_key:
String
version:
String
Example
{
  "cluster_id": "string",
  "access_key": "string",
  "version": "string"
}

ClusterInput: object

cluster_name:
String
description:
String
platform_name:
String
project_id:
ID
cluster_type:
String
agent_namespace:
String
serviceaccount:
String
agent_scope:
String
agent_ns_exists:
Boolean
agent_sa_exists:
Boolean
skip_ssl:
Boolean
node_selector:
String
tolerations:
Toleration
Example
{
  "cluster_name": "string",
  "description": "string",
  "platform_name": "string",
  "project_id": "object",
  "cluster_type": "string",
  "agent_namespace": "string",
  "serviceaccount": "string",
  "agent_scope": "string",
  "agent_ns_exists": "boolean",
  "agent_sa_exists": "boolean",
  "skip_ssl": "boolean",
  "node_selector": "string",
  "tolerations": [
    {
      "tolerationSeconds": "number",
      "key": "string",
      "operator": "string",
      "effect": "string",
      "value": "string"
    }
  ]
}

CreateMyHub: object

HubName:
String
RepoURL:
String
RepoBranch:
String
IsPrivate:
Boolean
AuthType:
Token:
String
UserName:
String
Password:
String
SSHPrivateKey:
String
SSHPublicKey:
String
Example
{
  "HubName": "string",
  "RepoURL": "string",
  "RepoBranch": "string",
  "IsPrivate": "boolean",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "SSHPrivateKey": "string",
  "SSHPublicKey": "string"
}

DSInput: object

ds_id:
String
ds_name:
String
ds_type:
String
ds_url:
String
access_type:
String
auth_type:
String
basic_auth_username:
String
basic_auth_password:
String
scrape_interval:
Int
query_timeout:
Int
http_method:
String
project_id:
String
Example
{
  "ds_id": "string",
  "ds_name": "string",
  "ds_type": "string",
  "ds_url": "string",
  "access_type": "string",
  "auth_type": "string",
  "basic_auth_username": "string",
  "basic_auth_password": "string",
  "scrape_interval": "number",
  "query_timeout": "number",
  "http_method": "string",
  "project_id": "string"
}

DSResponse: object

ds_id:
String
ds_name:
String
ds_type:
String
ds_url:
String
access_type:
String
auth_type:
String
basic_auth_username:
String
basic_auth_password:
String
scrape_interval:
Int
query_timeout:
Int
http_method:
String
project_id:
ID
health_status:
String
created_at:
String
updated_at:
String
Example
{
  "ds_id": "string",
  "ds_name": "string",
  "ds_type": "string",
  "ds_url": "string",
  "access_type": "string",
  "auth_type": "string",
  "basic_auth_username": "string",
  "basic_auth_password": "string",
  "scrape_interval": "number",
  "query_timeout": "number",
  "http_method": "string",
  "project_id": "object",
  "health_status": "string",
  "created_at": "string",
  "updated_at": "string"
}

DateRange: object

start_date:
String
end_date:
String
Example
{
  "start_date": "string",
  "end_date": "string"
}

ExperimentInput: object

ProjectID:
String
ChartName:
String
ExperimentName:
String
HubName:
String
FileType:
String
Example
{
  "ProjectID": "string",
  "ChartName": "string",
  "ExperimentName": "string",
  "HubName": "string",
  "FileType": "string"
}

Experiments: object

Name:
String
CSV:
String
Desc:
String
Example
{
  "Name": "string",
  "CSV": "string",
  "Desc": "string"
}

Float: number

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example
number

GetWorkflowRunsInput: object

project_id:
ID
workflow_run_ids:
ID
workflow_ids:
ID
pagination:
sort:
filter:
Example
{
  "project_id": "object",
  "workflow_run_ids": [
    "object"
  ],
  "workflow_ids": [
    "object"
  ],
  "pagination": {
    "page": "number",
    "limit": "number"
  },
  "sort": {
    "field": "string",
    "descending": "boolean"
  },
  "filter": {
    "workflow_name": "string",
    "cluster_name": "string",
    "workflow_status": "string",
    "date_range": {
      "start_date": "string",
      "end_date": "string"
    }
  }
}

GetWorkflowsOutput: object

total_no_of_workflow_runs:
Int
workflow_runs:
WorkflowRun
Example
{
  "total_no_of_workflow_runs": "number",
  "workflow_runs": [
    {
      "workflow_run_id": "object",
      "workflow_id": "object",
      "cluster_name": "string",
      "weightages": [
        {
          "experiment_name": "string",
          "weightage": "number"
        }
      ],
      "last_updated": "string",
      "project_id": "object",
      "cluster_id": "object",
      "workflow_name": "string",
      "cluster_type": "string",
      "phase": "string",
      "resiliency_score": "number",
      "experiments_passed": "number",
      "experiments_failed": "number",
      "experiments_awaited": "number",
      "experiments_stopped": "number",
      "experiments_na": "number",
      "total_experiments": "number",
      "execution_data": "string",
      "isRemoved": "boolean"
    }
  ]
}

GitConfig: object

ProjectID:
String
Branch:
String
RepoURL:
String
AuthType:
Token:
String
UserName:
String
Password:
String
SSHPrivateKey:
String
Example
{
  "ProjectID": "string",
  "Branch": "string",
  "RepoURL": "string",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "SSHPrivateKey": "string"
}

GitConfigResponse: object

Enabled:
Boolean
ProjectID:
String
Branch:
String
RepoURL:
String
AuthType:
Token:
String
UserName:
String
Password:
String
SSHPrivateKey:
String
Example
{
  "Enabled": "boolean",
  "ProjectID": "string",
  "Branch": "string",
  "RepoURL": "string",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "SSHPrivateKey": "string"
}

HeatmapData: object

bins:
WorkflowRunsData
Example
{
  "bins": [
    {
      "value": "number",
      "workflowRunDetail": {
        "no_of_runs": "number",
        "date_stamp": "number"
      }
    }
  ]
}

ID: object

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example
object

ImageRegistryResponse: object

is_default:
Boolean
image_registry_info:
image_registry_id:
String
project_id:
String
updated_at:
String
created_at:
String
is_removed:
Boolean
Example
{
  "is_default": "boolean",
  "image_registry_info": {
    "is_default": "boolean",
    "image_registry_name": "string",
    "image_repo_name": "string",
    "image_registry_type": "string",
    "secret_name": "string",
    "secret_namespace": "string",
    "enable_registry": "boolean"
  },
  "image_registry_id": "string",
  "project_id": "string",
  "updated_at": "string",
  "created_at": "string",
  "is_removed": "boolean"
}

Int: number

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example
number

Invitation: string

object
Accepted
object
Pending

KubeGVRRequest: object

group:
String
version:
String
resource:
String
Example
{
  "group": "string",
  "version": "string",
  "resource": "string"
}

KubeObjectData: object

request_id:
ID
cluster_id:
kube_obj:
String
Example
{
  "request_id": "object",
  "cluster_id": {
    "cluster_id": "string",
    "access_key": "string",
    "version": "string"
  },
  "kube_obj": "string"
}

KubeObjectRequest: object

cluster_id:
ID
object_type:
String
kube_obj_request:
Example
{
  "cluster_id": "object",
  "object_type": "string",
  "kube_obj_request": {
    "group": "string",
    "version": "string",
    "resource": "string"
  }
}

KubeObjectResponse: object

cluster_id:
ID
kube_obj:
String
Example
{
  "cluster_id": "object",
  "kube_obj": "string"
}

ListWorkflowsInput: object

project_id:
ID
workflow_ids:
ID
pagination:
sort:
filter:
Example
{
  "project_id": "object",
  "workflow_ids": [
    "object"
  ],
  "pagination": {
    "page": "number",
    "limit": "number"
  },
  "sort": {
    "field": "string",
    "descending": "boolean"
  },
  "filter": {
    "workflow_name": "string",
    "cluster_name": "string"
  }
}

ListWorkflowsOutput: object

total_no_of_workflows:
Int
workflows:
Workflow
Example
{
  "total_no_of_workflows": "number",
  "workflows": [
    {
      "workflow_id": "string",
      "workflow_manifest": "string",
      "cronSyntax": "string",
      "cluster_name": "string",
      "workflow_name": "string",
      "workflow_description": "string",
      "weightages": [
        {
          "experiment_name": "string",
          "weightage": "number"
        }
      ],
      "isCustomWorkflow": "boolean",
      "updated_at": "string",
      "created_at": "string",
      "project_id": "object",
      "cluster_id": "object",
      "cluster_type": "string",
      "isRemoved": "boolean"
    }
  ]
}

Maintainer: object

Name:
String
Email:
String
Example
{
  "Name": "string",
  "Email": "string"
}

ManifestTemplate: object

template_id:
ID
manifest:
String
template_name:
String
template_description:
String
project_id:
String
project_name:
String
created_at:
String
is_removed:
Boolean
isCustomWorkflow:
Boolean
Example
{
  "template_id": "object",
  "manifest": "string",
  "template_name": "string",
  "template_description": "string",
  "project_id": "string",
  "project_name": "string",
  "created_at": "string",
  "is_removed": "boolean",
  "isCustomWorkflow": "boolean"
}

MemberRole: string

object
Owner
object
Editor
object
Viewer

MemberStat: object

Owner:
Total:
Int
Example
{
  "Owner": {
    "UserId": "object",
    "Username": "string",
    "Name": "string"
  },
  "Total": "number"
}

Metadata: object

Name:
String
Version:
String
Annotations:
Example
{
  "Name": "string",
  "Version": "string",
  "Annotations": {
    "Categories": "string",
    "Vendor": "string",
    "CreatedAt": "string",
    "Repository": "string",
    "Support": "string",
    "ChartDescription": "string"
  }
}

MyHub: object

id:
ID
RepoURL:
String
RepoBranch:
String
ProjectID:
String
HubName:
String
IsPrivate:
Boolean
AuthType:
Token:
String
UserName:
String
Password:
String
SSHPrivateKey:
String
IsRemoved:
Boolean
CreatedAt:
String
UpdatedAt:
String
LastSyncedAt:
String
Example
{
  "id": "object",
  "RepoURL": "string",
  "RepoBranch": "string",
  "ProjectID": "string",
  "HubName": "string",
  "IsPrivate": "boolean",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "SSHPrivateKey": "string",
  "IsRemoved": "boolean",
  "CreatedAt": "string",
  "UpdatedAt": "string",
  "LastSyncedAt": "string"
}

MyHubStatus: object

id:
ID
RepoURL:
String
RepoBranch:
String
IsAvailable:
Boolean
TotalExp:
String
HubName:
String
IsPrivate:
Boolean
AuthType:
Token:
String
UserName:
String
Password:
String
IsRemoved:
Boolean
SSHPrivateKey:
String
SSHPublicKey:
String
LastSyncedAt:
String
Example
{
  "id": "object",
  "RepoURL": "string",
  "RepoBranch": "string",
  "IsAvailable": "boolean",
  "TotalExp": "string",
  "HubName": "string",
  "IsPrivate": "boolean",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "IsRemoved": "boolean",
  "SSHPrivateKey": "string",
  "SSHPublicKey": "string",
  "LastSyncedAt": "string"
}

Owner: object

UserId:
ID
Username:
String
Name:
String
Example
{
  "UserId": "object",
  "Username": "string",
  "Name": "string"
}

PackageInformation: object

PackageName:
String
Experiments:
Experiments
Example
{
  "PackageName": "string",
  "Experiments": [
    {
      "Name": "string",
      "CSV": "string",
      "Desc": "string"
    }
  ]
}

Pagination: object

page:
Int
limit:
Int
Example
{
  "page": "number",
  "limit": "number"
}

PodLog: object

cluster_id:
request_id:
ID
workflow_run_id:
ID
pod_name:
String
pod_type:
String
log:
String
Example
{
  "cluster_id": {
    "cluster_id": "string",
    "access_key": "string",
    "version": "string"
  },
  "request_id": "object",
  "workflow_run_id": "object",
  "pod_name": "string",
  "pod_type": "string",
  "log": "string"
}

PodLogRequest: object

cluster_id:
ID
workflow_run_id:
ID
pod_name:
String
pod_namespace:
String
pod_type:
String
exp_pod:
String
runner_pod:
String
chaos_namespace:
String
Example
{
  "cluster_id": "object",
  "workflow_run_id": "object",
  "pod_name": "string",
  "pod_namespace": "string",
  "pod_type": "string",
  "exp_pod": "string",
  "runner_pod": "string",
  "chaos_namespace": "string"
}

PodLogResponse: object

workflow_run_id:
ID
pod_name:
String
pod_type:
String
log:
String
Example
{
  "workflow_run_id": "object",
  "pod_name": "string",
  "pod_type": "string",
  "log": "string"
}

PortalDashboardData: object

name:
String
dashboard_data:
String
Example
{
  "name": "string",
  "dashboard_data": "string"
}

ProjectData: object

Workflows:
Agents:
ProjectId:
String
Example
{
  "Workflows": {
    "Schedules": "number",
    "Runs": "number",
    "ExpRuns": "number"
  },
  "Agents": {
    "Ns": "number",
    "Cluster": "number",
    "Total": "number",
    "Active": "number"
  },
  "ProjectId": "string"
}

Provider: object

Name:
String
Example
{
  "Name": "string"
}

SSHKey: object

publicKey:
String
privateKey:
String
Example
{
  "publicKey": "string",
  "privateKey": "string"
}

Spec: object

DisplayName:
String
CategoryDescription:
String
Keywords:
String
Maturity:
String
Maintainers:
Maintainer
MinKubeVersion:
String
Provider:
String
Links:
Link
Experiments:
String
ChaosExpCRDLink:
String
Platforms:
String
ChaosType:
String
Example
{
  "DisplayName": "string",
  "CategoryDescription": "string",
  "Keywords": [
    "string"
  ],
  "Maturity": "string",
  "Maintainers": [
    {
      "Name": "string",
      "Email": "string"
    }
  ],
  "MinKubeVersion": "string",
  "Provider": "string",
  "Links": [
    {
      "Name": "string",
      "Url": "string"
    }
  ],
  "Experiments": [
    "string"
  ],
  "ChaosExpCRDLink": "string",
  "Platforms": [
    "string"
  ],
  "ChaosType": "string"
}

String: string

The Stringscalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Subscription: object

clusterEventListener:
workflowEventListener:
getPodLog:
clusterConnect:
getKubeObject:
viewDashboard:
Example
{
  "clusterEventListener": {
    "event_id": "object",
    "event_type": "string",
    "event_name": "string",
    "description": "string",
    "cluster": {
      "cluster_id": "object",
      "project_id": "object",
      "cluster_name": "string",
      "description": "string",
      "platform_name": "string",
      "access_key": "string",
      "is_registered": "boolean",
      "is_cluster_confirmed": "boolean",
      "is_active": "boolean",
      "updated_at": "string",
      "created_at": "string",
      "cluster_type": "string",
      "no_of_schedules": "number",
      "no_of_workflows": "number",
      "token": "string",
      "agent_namespace": "string",
      "serviceaccount": "string",
      "agent_scope": "string",
      "agent_ns_exists": "boolean",
      "agent_sa_exists": "boolean",
      "last_workflow_timestamp": "string",
      "start_time": "string",
      "version": "string"
    }
  },
  "workflowEventListener": {
    "workflow_run_id": "object",
    "workflow_id": "object",
    "cluster_name": "string",
    "weightages": [
      {
        "experiment_name": "string",
        "weightage": "number"
      }
    ],
    "last_updated": "string",
    "project_id": "object",
    "cluster_id": "object",
    "workflow_name": "string",
    "cluster_type": "string",
    "phase": "string",
    "resiliency_score": "number",
    "experiments_passed": "number",
    "experiments_failed": "number",
    "experiments_awaited": "number",
    "experiments_stopped": "number",
    "experiments_na": "number",
    "total_experiments": "number"
  }
}

TemplateInput: object

manifest:
String
template_name:
String
template_description:
String
project_id:
String
isCustomWorkflow:
Boolean
Example
{
  "manifest": "string",
  "template_name": "string",
  "template_description": "string",
  "project_id": "string",
  "isCustomWorkflow": "boolean"
}

TimeFrequency: string

object
Monthly
object
Daily
object
Hourly

Toleration: object

tolerationSeconds:
Int
key:
String
operator:
String
effect:
String
value:
String
Example
{
  "tolerationSeconds": "number",
  "key": "string",
  "operator": "string",
  "effect": "string",
  "value": "string"
}

TotalCount: object

Projects:
Int
Users:
Int
Agents:
Workflows:
Example
{
  "Projects": "number",
  "Users": "number",
  "Agents": {
    "Ns": "number",
    "Cluster": "number",
    "Total": "number",
    "Active": "number"
  },
  "Workflows": {
    "Schedules": "number",
    "Runs": "number",
    "ExpRuns": "number"
  }
}

UpdateMyHub: object

id:
String
HubName:
String
RepoURL:
String
RepoBranch:
String
IsPrivate:
Boolean
AuthType:
Token:
String
UserName:
String
Password:
String
SSHPrivateKey:
String
SSHPublicKey:
String
Example
{
  "id": "string",
  "HubName": "string",
  "RepoURL": "string",
  "RepoBranch": "string",
  "IsPrivate": "boolean",
  "AuthType": "string",
  "Token": "string",
  "UserName": "string",
  "Password": "string",
  "SSHPrivateKey": "string",
  "SSHPublicKey": "string"
}

UsageData: object

Projects:
ProjectData
TotalEntries:
Int
TotalCount:
Example
{
  "Projects": [
    {
      "Workflows": {
        "Schedules": "number",
        "Runs": "number",
        "ExpRuns": "number"
      },
      "Agents": {
        "Ns": "number",
        "Cluster": "number",
        "Total": "number",
        "Active": "number"
      },
      "ProjectId": "string"
    }
  ],
  "TotalEntries": "number",
  "TotalCount": {
    "Projects": "number",
    "Users": "number",
    "Agents": {
      "Ns": "number",
      "Cluster": "number",
      "Total": "number",
      "Active": "number"
    },
    "Workflows": {
      "Schedules": "number",
      "Runs": "number",
      "ExpRuns": "number"
    }
  }
}

UsageQuery: object

Pagination:
DateRange:
Sort:
SearchProject:
String
Example
{
  "Pagination": {
    "page": "number",
    "limit": "number"
  },
  "DateRange": {
    "start_date": "string",
    "end_date": "string"
  },
  "Sort": {
    "Field": "string",
    "Descending": "boolean"
  },
  "SearchProject": "string"
}

UsageSort: string

object
Project
object
Owner
object
Agents
object
Schedules
object
WorkflowRuns
object
ExperimentRuns
object
TeamMembers

UsageSortInput: object

Field:
Descending:
Boolean
Example
{
  "Field": "string",
  "Descending": "boolean"
}

WeightagesInput: object

experiment_name:
String
weightage:
Int
Example
{
  "experiment_name": "string",
  "weightage": "number"
}

Workflow: object

workflow_id:
String
workflow_manifest:
String
cronSyntax:
String
cluster_name:
String
workflow_name:
String
workflow_description:
String
weightages:
weightages
isCustomWorkflow:
Boolean
updated_at:
String
created_at:
String
project_id:
ID
cluster_id:
ID
cluster_type:
String
isRemoved:
Boolean
Example
{
  "workflow_id": "string",
  "workflow_manifest": "string",
  "cronSyntax": "string",
  "cluster_name": "string",
  "workflow_name": "string",
  "workflow_description": "string",
  "weightages": [
    {
      "experiment_name": "string",
      "weightage": "number"
    }
  ],
  "isCustomWorkflow": "boolean",
  "updated_at": "string",
  "created_at": "string",
  "project_id": "object",
  "cluster_id": "object",
  "cluster_type": "string",
  "isRemoved": "boolean"
}

WorkflowFilterInput: object

workflow_name:
String
cluster_name:
String
Example
{
  "workflow_name": "string",
  "cluster_name": "string"
}

WorkflowRun: object

workflow_run_id:
ID
workflow_id:
ID
cluster_name:
String
weightages:
weightages
last_updated:
String
project_id:
ID
cluster_id:
ID
workflow_name:
String
cluster_type:
String
phase:
String
resiliency_score:
Float
experiments_passed:
Int
experiments_failed:
Int
experiments_awaited:
Int
experiments_stopped:
Int
experiments_na:
Int
total_experiments:
Int
execution_data:
String
isRemoved:
Boolean
Example
{
  "workflow_run_id": "object",
  "workflow_id": "object",
  "cluster_name": "string",
  "weightages": [
    {
      "experiment_name": "string",
      "weightage": "number"
    }
  ],
  "last_updated": "string",
  "project_id": "object",
  "cluster_id": "object",
  "workflow_name": "string",
  "cluster_type": "string",
  "phase": "string",
  "resiliency_score": "number",
  "experiments_passed": "number",
  "experiments_failed": "number",
  "experiments_awaited": "number",
  "experiments_stopped": "number",
  "experiments_na": "number",
  "total_experiments": "number",
  "execution_data": "string",
  "isRemoved": "boolean"
}

WorkflowRunDetails: object

no_of_runs:
Int
date_stamp:
Float
Example
{
  "no_of_runs": "number",
  "date_stamp": "number"
}

WorkflowRunFilterInput: object

workflow_name:
String
cluster_name:
String
workflow_status:
date_range:
Example
{
  "workflow_name": "string",
  "cluster_name": "string",
  "workflow_status": "string",
  "date_range": {
    "start_date": "string",
    "end_date": "string"
  }
}

WorkflowRunInput: object

workflow_id:
ID
workflow_run_id:
ID
workflow_name:
String
execution_data:
String
cluster_id:
completed:
Boolean
isRemoved:
Boolean
Example
{
  "workflow_id": "object",
  "workflow_run_id": "object",
  "workflow_name": "string",
  "execution_data": "string",
  "cluster_id": {
    "cluster_id": "string",
    "access_key": "string",
    "version": "string"
  },
  "completed": "boolean",
  "isRemoved": "boolean"
}

WorkflowRunSortInput: object

field:
descending:
Boolean
Example
{
  "field": "string",
  "descending": "boolean"
}

WorkflowRunStatsRequest: object

project_id:
ID
workflow_ids:
ID
Example
{
  "project_id": "object",
  "workflow_ids": [
    "object"
  ]
}

WorkflowRunStatsResponse: object

total_workflow_runs:
Int
succeeded_workflow_runs:
Int
failed_workflow_runs:
Int
running_workflow_runs:
Int
average_resiliency_score:
Float
total_experiments:
Int
experiments_passed:
Int
experiments_failed:
Int
experiments_awaited:
Int
experiments_stopped:
Int
experiments_na:
Int
passed_percentage:
Float
failed_percentage:
Float
workflow_run_succeeded_percentage:
Float
workflow_run_failed_percentage:
Float
Example
{
  "total_workflow_runs": "number",
  "succeeded_workflow_runs": "number",
  "failed_workflow_runs": "number",
  "running_workflow_runs": "number",
  "average_resiliency_score": "number",
  "total_experiments": "number",
  "experiments_passed": "number",
  "experiments_failed": "number",
  "experiments_awaited": "number",
  "experiments_stopped": "number",
  "experiments_na": "number",
  "passed_percentage": "number",
  "failed_percentage": "number",
  "workflow_run_succeeded_percentage": "number",
  "workflow_run_failed_percentage": "number"
}

WorkflowRunStatus: string

object
All
object
Failed
object
Running
object
Succeeded
object
Terminated

WorkflowRunsData: object

value:
Float
workflowRunDetail:
Example
{
  "value": "number",
  "workflowRunDetail": {
    "no_of_runs": "number",
    "date_stamp": "number"
  }
}

WorkflowSortInput: object

field:
descending:
Boolean
Example
{
  "field": "string",
  "descending": "boolean"
}

WorkflowSortingField: string

object
Name
object
Time

WorkflowStat: object

Schedules:
Int
Runs:
Int
ExpRuns:
Int
Example
{
  "Schedules": "number",
  "Runs": "number",
  "ExpRuns": "number"
}

WorkflowStats: object

date:
Float
value:
Int
Example
{
  "date": "number",
  "value": "number"
}

annotationsPromResponse: object

queryid:
String
legends:
String
tsvs:
object[][]
subDataArray:
object[][]
Example
{
  "queryid": "string",
  "legends": [
    "string"
  ],
  "tsvs": [
    [
      {
        "date": "number",
        "value": "number"
      }
    ]
  ],
  "subDataArray": [
    [
      {
        "date": "number",
        "value": "string",
        "subDataName": "string"
      }
    ]
  ]
}

annotationsTimeStampValue: object

date:
Float
value:
Int
Example
{
  "date": "number",
  "value": "number"
}

applicationMetadata: object

namespace:
String
applications:
resource
Example
{
  "namespace": "string",
  "applications": [
    {
      "kind": "string",
      "names": [
        "string"
      ]
    }
  ]
}

applicationMetadataResponse: object

namespace:
String
applications:
resourceResponse
Example
{
  "namespace": "string",
  "applications": [
    {
      "kind": "string",
      "names": [
        "string"
      ]
    }
  ]
}

clusterRegResponse: object

token:
String
cluster_id:
String
cluster_name:
String
Example
{
  "token": "string",
  "cluster_id": "string",
  "cluster_name": "string"
}

createDBInput: object

ds_id:
String
db_name:
String
db_type_name:
String
db_type_id:
String
db_information:
String
chaos_event_query_template:
String
chaos_verdict_query_template:
String
application_metadata_map:
applicationMetadata
panel_groups:
panelGroup
end_time:
String
start_time:
String
project_id:
ID
cluster_id:
ID
refresh_rate:
String
Example
{
  "ds_id": "string",
  "db_name": "string",
  "db_type_name": "string",
  "db_type_id": "string",
  "db_information": "string",
  "chaos_event_query_template": "string",
  "chaos_verdict_query_template": "string",
  "application_metadata_map": [
    {
      "namespace": "string",
      "applications": [
        {
          "kind": "string",
          "names": [
            "string"
          ]
        }
      ]
    }
  ],
  "panel_groups": [
    {
      "panels": [
        {
          "panel_id": "string",
          "db_id": "string",
          "y_axis_left": "string",
          "y_axis_right": "string",
          "x_axis_down": "string",
          "unit": "string",
          "panel_group_id": "string",
          "created_at": "string",
          "prom_queries": [
            {
              "queryid": "string",
              "prom_query_name": "string",
              "legend": "string",
              "resolution": "string",
              "minstep": "string",
              "line": "boolean",
              "close_area": "boolean"
            }
          ],
          "panel_options": {
            "points": "boolean",
            "grids": "boolean",
            "left_axis": "boolean"
          },
          "panel_name": "string"
        }
      ],
      "panel_group_name": "string"
    }
  ],
  "end_time": "string",
  "start_time": "string",
  "project_id": "object",
  "cluster_id": "object",
  "refresh_rate": "string"
}

dashboardPromResponse: object

dashboardMetricsResponse:
metricDataForPanelGroup
annotationsResponse:
annotationsPromResponse
Example
{
  "dashboardMetricsResponse": [
    {
      "panelGroupID": "string",
      "panelGroupMetricsResponse": [
        {
          "panelID": "string",
          "PanelMetricsResponse": [
            {
              "queryid": "string",
              "legends": [
                "string"
              ],
              "tsvs": [
                [
                  {
                    "date": "number",
                    "value": "number"
                  }
                ]
              ]
            }
          ]
        }
      ]
    }
  ],
  "annotationsResponse": [
    {
      "queryid": "string",
      "legends": [
        "string"
      ],
      "tsvs": [
        [
          {
            "date": "number",
            "value": "number"
          }
        ]
      ],
      "subDataArray": [
        [
          {
            "date": "number",
            "value": "string",
            "subDataName": "string"
          }
        ]
      ]
    }
  ]
}

dataVars: object

url:
String
start:
String
end:
String
relative_time:
Int
refresh_interval:
Int
Example
{
  "url": "string",
  "start": "string",
  "end": "string",
  "relative_time": "number",
  "refresh_interval": "number"
}

deleteDSInput: object

force_delete:
Boolean
ds_id:
ID
Example
{
  "force_delete": "boolean",
  "ds_id": "object"
}

dsDetails: object

url:
String
start:
String
end:
String
Example
{
  "url": "string",
  "start": "string",
  "end": "string"
}

imageRegistry: object

is_default:
Boolean
image_registry_name:
String
image_repo_name:
String
image_registry_type:
String
secret_name:
String
secret_namespace:
String
enable_registry:
Boolean
Example
{
  "is_default": "boolean",
  "image_registry_name": "string",
  "image_repo_name": "string",
  "image_registry_type": "string",
  "secret_name": "string",
  "secret_namespace": "string",
  "enable_registry": "boolean"
}

imageRegistryInput: object

is_default:
Boolean
image_registry_name:
String
image_repo_name:
String
image_registry_type:
String
secret_name:
String
secret_namespace:
String
enable_registry:
Boolean
Example
{
  "is_default": "boolean",
  "image_registry_name": "string",
  "image_repo_name": "string",
  "image_registry_type": "string",
  "secret_name": "string",
  "secret_namespace": "string",
  "enable_registry": "boolean"
}

labelValue: object

label:
String
values:
option
Example
{
  "label": "string",
  "values": [
    {
      "name": "string"
    }
  ]
}

listDashboardResponse: object

ds_id:
String
db_id:
String
db_name:
String
db_type_id:
String
db_type_name:
String
db_information:
String
chaos_event_query_template:
String
chaos_verdict_query_template:
String
application_metadata_map:
applicationMetadataResponse
cluster_name:
String
ds_name:
String
ds_type:
String
ds_url:
String
ds_health_status:
String
panel_groups:
panelGroupResponse
end_time:
String
start_time:
String
refresh_rate:
String
project_id:
ID
cluster_id:
ID
created_at:
String
updated_at:
String
viewed_at:
String
Example
{
  "ds_id": "string",
  "db_id": "string",
  "db_name": "string",
  "db_type_id": "string",
  "db_type_name": "string",
  "db_information": "string",
  "chaos_event_query_template": "string",
  "chaos_verdict_query_template": "string",
  "application_metadata_map": [
    {
      "namespace": "string",
      "applications": [
        {
          "kind": "string",
          "names": [
            "string"
          ]
        }
      ]
    }
  ],
  "cluster_name": "string",
  "ds_name": "string",
  "ds_type": "string",
  "ds_url": "string",
  "ds_health_status": "string",
  "panel_groups": [
    {
      "panels": [
        {
          "panel_id": "string",
          "y_axis_left": "string",
          "y_axis_right": "string",
          "x_axis_down": "string",
          "unit": "string",
          "prom_queries": [
            {
              "queryid": "object",
              "prom_query_name": "string",
              "legend": "string",
              "resolution": "string",
              "minstep": "string",
              "line": "boolean",
              "close_area": "boolean"
            }
          ],
          "panel_options": {
            "points": "boolean",
            "grids": "boolean",
            "left_axis": "boolean"
          },
          "panel_name": "string",
          "created_at": "string"
        }
      ],
      "panel_group_name": "string",
      "panel_group_id": "string"
    }
  ],
  "end_time": "string",
  "start_time": "string",
  "refresh_rate": "string",
  "project_id": "object",
  "cluster_id": "object"
}

metricDataForPanel: object

panelID:
String
PanelMetricsResponse:
metricsPromResponse
Example
{
  "panelID": "string",
  "PanelMetricsResponse": [
    {
      "queryid": "string",
      "legends": [
        "string"
      ],
      "tsvs": [
        [
          {
            "date": "number",
            "value": "number"
          }
        ]
      ]
    }
  ]
}

metricDataForPanelGroup: object

panelGroupID:
String
panelGroupMetricsResponse:
metricDataForPanel
Example
{
  "panelGroupID": "string",
  "panelGroupMetricsResponse": [
    {
      "panelID": "string",
      "PanelMetricsResponse": [
        {
          "queryid": "string",
          "legends": [
            "string"
          ],
          "tsvs": [
            [
              {
                "date": "number",
                "value": "number"
              }
            ]
          ]
        }
      ]
    }
  ]
}

metricsPromResponse: object

queryid:
String
legends:
String
tsvs:
object[][]
Example
{
  "queryid": "string",
  "legends": [
    "string"
  ],
  "tsvs": [
    [
      {
        "date": "number",
        "value": "number"
      }
    ]
  ]
}

metricsTimeStampValue: object

date:
Float
value:
Float
Example
{
  "date": "number",
  "value": "number"
}

option: object

name:
String
Example
{
  "name": "string"
}

panel: object

panel_id:
String
db_id:
String
y_axis_left:
String
y_axis_right:
String
x_axis_down:
String
unit:
String
panel_group_id:
String
created_at:
String
prom_queries:
promQuery
panel_options:
panel_name:
String
Example
{
  "panel_id": "string",
  "db_id": "string",
  "y_axis_left": "string",
  "y_axis_right": "string",
  "x_axis_down": "string",
  "unit": "string",
  "panel_group_id": "string",
  "created_at": "string",
  "prom_queries": [
    {
      "queryid": "string",
      "prom_query_name": "string",
      "legend": "string",
      "resolution": "string",
      "minstep": "string",
      "line": "boolean",
      "close_area": "boolean"
    }
  ],
  "panel_options": {
    "points": "boolean",
    "grids": "boolean",
    "left_axis": "boolean"
  },
  "panel_name": "string"
}

panelGroup: object

panels:
panel
panel_group_name:
String
Example
{
  "panels": [
    {
      "panel_id": "string",
      "db_id": "string",
      "y_axis_left": "string",
      "y_axis_right": "string",
      "x_axis_down": "string",
      "unit": "string",
      "panel_group_id": "string",
      "created_at": "string",
      "prom_queries": [
        {
          "queryid": "string",
          "prom_query_name": "string",
          "legend": "string",
          "resolution": "string",
          "minstep": "string",
          "line": "boolean",
          "close_area": "boolean"
        }
      ],
      "panel_options": {
        "points": "boolean",
        "grids": "boolean",
        "left_axis": "boolean"
      },
      "panel_name": "string"
    }
  ],
  "panel_group_name": "string"
}

panelGroupResponse: object

panels:
panelResponse
panel_group_name:
String
panel_group_id:
String
Example
{
  "panels": [
    {
      "panel_id": "string",
      "y_axis_left": "string",
      "y_axis_right": "string",
      "x_axis_down": "string",
      "unit": "string",
      "prom_queries": [
        {
          "queryid": "object",
          "prom_query_name": "string",
          "legend": "string",
          "resolution": "string",
          "minstep": "string",
          "line": "boolean",
          "close_area": "boolean"
        }
      ],
      "panel_options": {
        "points": "boolean",
        "grids": "boolean",
        "left_axis": "boolean"
      },
      "panel_name": "string",
      "created_at": "string"
    }
  ],
  "panel_group_name": "string",
  "panel_group_id": "string"
}

panelOption: object

points:
Boolean
grids:
Boolean
left_axis:
Boolean
Example
{
  "points": "boolean",
  "grids": "boolean",
  "left_axis": "boolean"
}

panelOptionResponse: object

points:
Boolean
grids:
Boolean
left_axis:
Boolean
Example
{
  "points": "boolean",
  "grids": "boolean",
  "left_axis": "boolean"
}

panelResponse: object

panel_id:
String
y_axis_left:
String
y_axis_right:
String
x_axis_down:
String
unit:
String
prom_queries:
promQueryResponse
panel_options:
panel_name:
String
created_at:
String
Example
{
  "panel_id": "string",
  "y_axis_left": "string",
  "y_axis_right": "string",
  "x_axis_down": "string",
  "unit": "string",
  "prom_queries": [
    {
      "queryid": "object",
      "prom_query_name": "string",
      "legend": "string",
      "resolution": "string",
      "minstep": "string",
      "line": "boolean",
      "close_area": "boolean"
    }
  ],
  "panel_options": {
    "points": "boolean",
    "grids": "boolean",
    "left_axis": "boolean"
  },
  "panel_name": "string",
  "created_at": "string"
}

promInput: object

queries:
promQueryInput
ds_details:
Example
{
  "queries": [
    {
      "queryid": "string",
      "query": "string",
      "legend": "string",
      "resolution": "string",
      "minstep": "number"
    }
  ],
  "ds_details": {
    "url": "string",
    "start": "string",
    "end": "string"
  }
}

promQuery: object

queryid:
String
prom_query_name:
String
legend:
String
resolution:
String
minstep:
String
line:
Boolean
close_area:
Boolean
Example
{
  "queryid": "string",
  "prom_query_name": "string",
  "legend": "string",
  "resolution": "string",
  "minstep": "string",
  "line": "boolean",
  "close_area": "boolean"
}

promQueryInput: object

queryid:
String
query:
String
legend:
String
resolution:
String
minstep:
Int
Example
{
  "queryid": "string",
  "query": "string",
  "legend": "string",
  "resolution": "string",
  "minstep": "number"
}

promQueryResponse: object

queryid:
ID
prom_query_name:
String
legend:
String
resolution:
String
minstep:
String
line:
Boolean
close_area:
Boolean
Example
{
  "queryid": "object",
  "prom_query_name": "string",
  "legend": "string",
  "resolution": "string",
  "minstep": "string",
  "line": "boolean",
  "close_area": "boolean"
}

promResponse: object

metricsResponse:
metricsPromResponse
annotationsResponse:
annotationsPromResponse
Example
{
  "metricsResponse": [
    {
      "queryid": "string",
      "legends": [
        "string"
      ],
      "tsvs": [
        [
          {
            "date": "number",
            "value": "number"
          }
        ]
      ]
    }
  ],
  "annotationsResponse": [
    {
      "queryid": "string",
      "legends": [
        "string"
      ],
      "tsvs": [
        [
          {
            "date": "number",
            "value": "number"
          }
        ]
      ],
      "subDataArray": [
        [
          {
            "date": "number",
            "value": "string",
            "subDataName": "string"
          }
        ]
      ]
    }
  ]
}

promSeriesInput: object

series:
String
ds_details:
Example
{
  "series": "string",
  "ds_details": {
    "url": "string",
    "start": "string",
    "end": "string"
  }
}

promSeriesListResponse: object

seriesList:
String
Example
{
  "seriesList": [
    "string"
  ]
}

promSeriesResponse: object

series:
String
labelValues:
labelValue
Example
{
  "series": "string",
  "labelValues": [
    {
      "label": "string",
      "values": [
        {
          "name": "string"
        }
      ]
    }
  ]
}

queryMapForPanel: object

panelID:
String
queryIDs:
String
Example
{
  "panelID": "string",
  "queryIDs": [
    "string"
  ]
}

queryMapForPanelGroup: object

panelGroupID:
String
panelQueryMap:
queryMapForPanel
Example
{
  "panelGroupID": "string",
  "panelQueryMap": [
    {
      "panelID": "string",
      "queryIDs": [
        "string"
      ]
    }
  ]
}

resource: object

kind:
String
names:
String
Example
{
  "kind": "string",
  "names": [
    "string"
  ]
}

resourceResponse: object

kind:
String
names:
String
Example
{
  "kind": "string",
  "names": [
    "string"
  ]
}

subData: object

date:
Float
value:
String
subDataName:
String
Example
{
  "date": "number",
  "value": "string",
  "subDataName": "string"
}

updateDBInput: object

db_id:
String
ds_id:
String
db_name:
String
db_type_name:
String
db_type_id:
String
db_information:
String
chaos_event_query_template:
String
chaos_verdict_query_template:
String
application_metadata_map:
applicationMetadata
panel_groups:
updatePanelGroupInput
end_time:
String
start_time:
String
cluster_id:
ID
refresh_rate:
String
Example
{
  "db_id": "string",
  "ds_id": "string",
  "db_name": "string",
  "db_type_name": "string",
  "db_type_id": "string",
  "db_information": "string",
  "chaos_event_query_template": "string",
  "chaos_verdict_query_template": "string",
  "application_metadata_map": [
    {
      "namespace": "string",
      "applications": [
        {
          "kind": "string",
          "names": [
            "string"
          ]
        }
      ]
    }
  ],
  "panel_groups": [
    {
      "panel_group_name": "string",
      "panel_group_id": "string",
      "panels": [
        {
          "panel_id": "string",
          "db_id": "string",
          "y_axis_left": "string",
          "y_axis_right": "string",
          "x_axis_down": "string",
          "unit": "string",
          "panel_group_id": "string",
          "created_at": "string",
          "prom_queries": [
            {
              "queryid": "string",
              "prom_query_name": "string",
              "legend": "string",
              "resolution": "string",
              "minstep": "string",
              "line": "boolean",
              "close_area": "boolean"
            }
          ],
          "panel_options": {
            "points": "boolean",
            "grids": "boolean",
            "left_axis": "boolean"
          },
          "panel_name": "string"
        }
      ]
    }
  ],
  "end_time": "string",
  "start_time": "string",
  "cluster_id": "object",
  "refresh_rate": "string"
}

updatePanelGroupInput: object

panel_group_name:
String
panel_group_id:
String
panels:
panel
Example
{
  "panel_group_name": "string",
  "panel_group_id": "string",
  "panels": [
    {
      "panel_id": "string",
      "db_id": "string",
      "y_axis_left": "string",
      "y_axis_right": "string",
      "x_axis_down": "string",
      "unit": "string",
      "panel_group_id": "string",
      "created_at": "string",
      "prom_queries": [
        {
          "queryid": "string",
          "prom_query_name": "string",
          "legend": "string",
          "resolution": "string",
          "minstep": "string",
          "line": "boolean",
          "close_area": "boolean"
        }
      ],
      "panel_options": {
        "points": "boolean",
        "grids": "boolean",
        "left_axis": "boolean"
      },
      "panel_name": "string"
    }
  ]
}

weightages: object

experiment_name:
String
weightage:
Int
Example
{
  "experiment_name": "string",
  "weightage": "number"
}
Documentation by DociQL