Onepanel API Reference

Onepanel API

API Endpoint
https://localhost:8888
Request Content-Types: application/json
Response Content-Types: application/json, application/octet-stream
Schemes: http, https
Version: 1.0.2

Authentication

Bearer

description

Authentication token, prefixed by Bearer

name
authorization
in
header

ServiceService

GET /apis/v1beta/service/{name}

name

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "hasService": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/service

namespace

(no description)

type
string
in
path
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "services": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/service/{name}

namespace

(no description)

type
string
in
path
name

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "name": "string",
  "url": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

WorkflowService

GET /apis/v1beta/{namespace}/field/workflow_executions/{fieldName}

namespace

(no description)

type
string
in
path
fieldName

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "values": [
    "string"
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_execution/statistics

namespace

(no description)

type
string
in
path

An unexpected error response.

Response Example (200 OK)
{
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_executions

namespace

(no description)

type
string
in
path
workflowTemplateUid

(no description)

type
string
in
query
workflowTemplateVersion

(no description)

type
string
in
query
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query
order

(no description)

type
string
in
query
labels

(no description)

type
string
in
query
phase

(no description)

type
string
in
query
includeSystem

(no description)

type
boolean
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "workflowExecutions": [
    {
      "createdAt": "string",
      "uid": "string",
      "name": "string",
      "phase": "string",
      "startedAt": "string",
      "finishedAt": "string",
      "manifest": "string",
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "isArchived": "boolean",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "stats": {
          "total": "integer (int32)",
          "lastExecuted": "string",
          "running": "integer (int32)",
          "completed": "integer (int32)",
          "failed": "integer (int32)",
          "terminated": "integer (int32)"
        },
        "cronStats": {
          "total": "integer (int32)"
        },
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "description": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "metadata": {
        "url": "string"
      },
      "metrics": [
        {
          "name": "string",
          "value": "number (double)",
          "format": "string"
        }
      ]
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)",
  "totalAvailableCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Creates a Workflow

POST /apis/v1beta1/{namespace}/workflow_executions
namespace

(no description)

type
string
in
path
Request Example
{
  "workflowTemplateUid": "string",
  "workflowTemplateVersion": "string (int64)",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "uid": "string",
  "name": "string",
  "phase": "string",
  "startedAt": "string",
  "finishedAt": "string",
  "manifest": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "metadata": {
    "url": "string"
  },
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_executions/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "uid": "string",
  "name": "string",
  "phase": "string",
  "startedAt": "string",
  "finishedAt": "string",
  "manifest": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "metadata": {
    "url": "string"
  },
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Clone a Workflow. This is the same as running it again.

POST /apis/v1beta1/{namespace}/workflow_executions/{uid}
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "uid": "string",
  "name": "string",
  "phase": "string",
  "startedAt": "string",
  "finishedAt": "string",
  "manifest": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "metadata": {
    "url": "string"
  },
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/workflow_executions/{uid}/cron_start_statistics

undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "workflowStatus": "string",
  "workflowTemplateId": "string (int64)"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/workflow_executions/{uid}/metric

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "namespace": "string",
  "uid": "string",
  "override": "boolean",
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workflow_executions/{uid}/metric

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "namespace": "string",
  "uid": "string",
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_executions/{uid}/pods/{podName}/containers/{containerName}/logs

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
podName

(no description)

type
string
in
path
containerName

(no description)

type
string
in
path
200 OK

A successful response.(streaming responses)

An unexpected error response.

Response Example (200 OK)
{
  "result": {
    "logEntries": [
      {
        "timestamp": "string",
        "content": "string"
      }
    ]
  },
  "error": {
    "code": "integer (int32)",
    "message": "string",
    "details": [
      {
        "typeUrl": "string",
        "value": "string (byte)"
      }
    ]
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_executions/{uid}/pods/{podName}/metrics

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
podName

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workflow_executions/{uid}/resubmit

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "uid": "string",
  "name": "string",
  "phase": "string",
  "startedAt": "string",
  "finishedAt": "string",
  "manifest": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "metadata": {
    "url": "string"
  },
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/workflow_executions/{uid}/statistics

undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "workflowStatus": "string",
  "workflowTemplateId": "string (int64)"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workflow_executions/{uid}/status

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "phase": "string"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workflow_executions/{uid}/terminate

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_executions/{uid}/watch

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.(streaming responses)

An unexpected error response.

Response Example (200 OK)
{
  "result": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "error": {
    "code": "integer (int32)",
    "message": "string",
    "details": [
      {
        "typeUrl": "string",
        "value": "string (byte)"
      }
    ]
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

WorkflowTemplateService

GET /apis/v1beta/{namespace}/field/workflow_templates/{fieldName}

namespace

(no description)

type
string
in
path
fieldName

(no description)

type
string
in
path
isSystem

(no description)

type
boolean
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "values": [
    "string"
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_templates

namespace

(no description)

type
string
in
path
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query
labels

(no description)

type
string
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "workflowTemplates": [
    {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)",
  "totalAvailableCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/workflow_templates

undefined
namespace

(no description)

type
string
in
path
Request Example
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_templates/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
version

(no description)

type
string (int64)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workflow_templates/{uid}/archive

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_templates/{uid}/clone/{name}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
name

(no description)

type
string
in
path
version

(no description)

type
string (int64)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_templates/{uid}/clone/{name}/{version}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
name

(no description)

type
string
in
path
version

(no description)

type
string (int64)
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Get the generated WorkflowTemplate, applying any modifications based on the content

POST /apis/v1beta1/{namespace}/workflow_templates/{uid}/generate
undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_templates/{uid}/versions

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "workflowTemplates": [
    {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workflow_templates/{uid}/versions/{version}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
version

(no description)

type
string (int64)
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/workflow_templates/{workflowTemplate.uid}/versions

undefined
namespace

(no description)

type
string
in
path
workflowTemplate.uid

(no description)

type
string
in
path
Request Example
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

WorkspaceTemplateService

GET /apis/v1beta/{namespace}/field/workspace_templates/{fieldName}

namespace

(no description)

type
string
in
path
fieldName

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "values": [
    "string"
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workspace_templates

namespace

(no description)

type
string
in
path
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query
order

(no description)

type
string
in
query
labels

(no description)

type
string
in
query
uid

(no description)

type
string
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "workspaceTemplates": [
    {
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "isArchived": "boolean",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "stats": {
          "total": "integer (int32)",
          "lastExecuted": "string",
          "running": "integer (int32)",
          "completed": "integer (int32)",
          "failed": "integer (int32)",
          "terminated": "integer (int32)"
        },
        "cronStats": {
          "total": "integer (int32)"
        },
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "description": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean",
      "description": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Creates a WorkspaceTemplate

POST /apis/v1beta1/{namespace}/workspace_templates
undefined
namespace

(no description)

type
string
in
path
Request Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Get a WorkspaceTemplate

GET /apis/v1beta1/{namespace}/workspace_templates/{uid}
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
version

(no description)

type
string (int64)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Updates a WorkspaceTemplate

PUT /apis/v1beta1/{namespace}/workspace_templates/{uid}
undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Archives a WorkspaceTemplate

PUT /apis/v1beta1/{namespace}/workspace_templates/{uid}/archive
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workspace_templates/{uid}/versions

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "workspaceTemplates": [
    {
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "isArchived": "boolean",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "stats": {
          "total": "integer (int32)",
          "lastExecuted": "string",
          "running": "integer (int32)",
          "completed": "integer (int32)",
          "failed": "integer (int32)",
          "terminated": "integer (int32)"
        },
        "cronStats": {
          "total": "integer (int32)"
        },
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "description": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean",
      "description": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Get the generated WorkflowTemplate for a WorkspaceTemplate

POST /apis/v1beta1/{namespace}/workspace_templates/{uid}/workflow_template
undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

WorkspaceService

GET /apis/v1beta/{namespace}/field/workspaces/{fieldName}

namespace

(no description)

type
string
in
path
fieldName

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "values": [
    "string"
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workspace/statistics

namespace

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "stats": {
    "total": "integer (int32)",
    "lastCreated": "string",
    "launching": "integer (int32)",
    "running": "integer (int32)",
    "updating": "integer (int32)",
    "pausing": "integer (int32)",
    "paused": "integer (int32)",
    "terminating": "integer (int32)",
    "terminated": "integer (int32)",
    "failedToPause": "integer (int32)",
    "failedToResume": "integer (int32)",
    "failedToTerminate": "integer (int32)",
    "failedToLaunch": "integer (int32)",
    "failedToUpdate": "integer (int32)",
    "failed": "integer (int32)"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workspaces

namespace

(no description)

type
string
in
path
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query
order

(no description)

type
string
in
query
labels

(no description)

type
string
in
query
phase

(no description)

type
string
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "workspaces": [
    {
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "createdAt": "string",
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workspaceTemplate": {
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "createdAt": "string",
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean",
          "isArchived": "boolean",
          "labels": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "stats": {
            "total": "integer (int32)",
            "lastExecuted": "string",
            "running": "integer (int32)",
            "completed": "integer (int32)",
            "failed": "integer (int32)",
            "terminated": "integer (int32)"
          },
          "cronStats": {
            "total": "integer (int32)"
          },
          "parameters": [
            {
              "name": "string",
              "value": "string",
              "type": "string",
              "displayName": "string",
              "hint": "string",
              "required": "boolean",
              "visibility": "string",
              "options": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "description": "string"
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "isArchived": "boolean",
        "description": "string"
      },
      "status": {
        "phase": "string",
        "startedAt": "string",
        "pausedAt": "string",
        "terminatedAt": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "url": "string",
      "templateParameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workspaceComponents": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "machineType": {
        "name": "string",
        "value": "string"
      }
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)",
  "totalAvailableCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/workspaces

namespace

(no description)

type
string
in
path
Request Example
{
  "workspaceTemplateUid": "string",
  "workspaceTemplateVersion": "string (int64)",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "captureNode": "boolean"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "createdAt": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceTemplate": {
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "createdAt": "string",
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "isArchived": "boolean",
    "description": "string"
  },
  "status": {
    "phase": "string",
    "startedAt": "string",
    "pausedAt": "string",
    "terminatedAt": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "url": "string",
  "templateParameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceComponents": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "machineType": {
    "name": "string",
    "value": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workspaces/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "createdAt": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceTemplate": {
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "createdAt": "string",
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "isArchived": "boolean",
    "description": "string"
  },
  "status": {
    "phase": "string",
    "startedAt": "string",
    "pausedAt": "string",
    "terminatedAt": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "url": "string",
  "templateParameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceComponents": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "machineType": {
    "name": "string",
    "value": "string"
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

DELETE /apis/v1beta1/{namespace}/workspaces/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workspaces/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/workspaces/{uid}/containers/{containerName}/logs

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
containerName

(no description)

type
string
in
path
sinceTime

(no description)

type
string (int64)
in
query
200 OK

A successful response.(streaming responses)

An unexpected error response.

Response Example (200 OK)
{
  "result": {
    "logEntries": [
      {
        "timestamp": "string",
        "content": "string"
      }
    ]
  },
  "error": {
    "code": "integer (int32)",
    "message": "string",
    "details": [
      {
        "typeUrl": "string",
        "value": "string (byte)"
      }
    ]
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workspaces/{uid}/pause

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workspaces/{uid}/resume

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workspaces/{uid}/retry

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workspaces/{uid}/status

undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "phase": "string",
  "startedAt": "string",
  "pausedAt": "string",
  "terminatedAt": "string"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

AuthService

POST /apis/v1beta1/auth

undefined
Request Example
{
  "namespace": "string",
  "verb": "string",
  "group": "string",
  "resource": "string",
  "resourceName": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "authorized": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/auth/get_access_token

Request Example
{
  "username": "string",
  "token": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "domain": "string",
  "accessToken": "string",
  "username": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/auth/token

Request Example
{
  "username": "string",
  "token": "string"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "domain": "string",
  "token": "string",
  "username": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

ConfigService

GET /apis/v1beta1/config

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "apiUrl": "string",
  "domain": "string",
  "fqdn": "string",
  "nodePool": {
    "label": "string",
    "options": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/config

namespace

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "bucket": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

NamespaceService

GET /apis/v1beta1/namespaces

pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query
query

(no description)

type
string
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "namespaces": [
    {
      "name": "string",
      "sourceName": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/namespaces

undefined
Request Example
{
  "name": "string",
  "sourceName": "string"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "name": "string",
  "sourceName": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

CronWorkflowService

POST /apis/v1beta1/{namespace}/cron_workflow

undefined
namespace

(no description)

type
string
in
path
Request Example
{
  "name": "string",
  "uid": "string",
  "manifest": "string",
  "workflowExecution": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "name": "string",
  "uid": "string",
  "manifest": "string",
  "workflowExecution": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/cron_workflow/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "name": "string",
  "uid": "string",
  "manifest": "string",
  "workflowExecution": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/cron_workflow/{uid}

undefined
namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "name": "string",
  "uid": "string",
  "manifest": "string",
  "workflowExecution": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "name": "string",
  "uid": "string",
  "manifest": "string",
  "workflowExecution": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/cron_workflows

namespace

(no description)

type
string
in
path
workflowTemplateName

(no description)

type
string
in
query
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "cronWorkflows": [
    {
      "name": "string",
      "uid": "string",
      "manifest": "string",
      "workflowExecution": {
        "createdAt": "string",
        "uid": "string",
        "name": "string",
        "phase": "string",
        "startedAt": "string",
        "finishedAt": "string",
        "manifest": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean",
          "isArchived": "boolean",
          "labels": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "stats": {
            "total": "integer (int32)",
            "lastExecuted": "string",
            "running": "integer (int32)",
            "completed": "integer (int32)",
            "failed": "integer (int32)",
            "terminated": "integer (int32)"
          },
          "cronStats": {
            "total": "integer (int32)"
          },
          "parameters": [
            {
              "name": "string",
              "value": "string",
              "type": "string",
              "displayName": "string",
              "hint": "string",
              "required": "boolean",
              "visibility": "string",
              "options": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "description": "string"
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "metadata": {
          "url": "string"
        },
        "metrics": [
          {
            "name": "string",
            "value": "number (double)",
            "format": "string"
          }
        ]
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "namespace": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

DELETE /apis/v1beta1/{namespace}/cron_workflows/{uid}

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/cron_workflows/{workflowTemplateName}

namespace

(no description)

type
string
in
path
workflowTemplateName

(no description)

type
string
in
path
pageSize

(no description)

type
integer (int32)
in
query
page

(no description)

type
integer (int32)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "cronWorkflows": [
    {
      "name": "string",
      "uid": "string",
      "manifest": "string",
      "workflowExecution": {
        "createdAt": "string",
        "uid": "string",
        "name": "string",
        "phase": "string",
        "startedAt": "string",
        "finishedAt": "string",
        "manifest": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean",
          "isArchived": "boolean",
          "labels": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "stats": {
            "total": "integer (int32)",
            "lastExecuted": "string",
            "running": "integer (int32)",
            "completed": "integer (int32)",
            "failed": "integer (int32)",
            "terminated": "integer (int32)"
          },
          "cronStats": {
            "total": "integer (int32)"
          },
          "parameters": [
            {
              "name": "string",
              "value": "string",
              "type": "string",
              "displayName": "string",
              "hint": "string",
              "required": "boolean",
              "visibility": "string",
              "options": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "description": "string"
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "metadata": {
          "url": "string"
        },
        "metrics": [
          {
            "name": "string",
            "value": "number (double)",
            "format": "string"
          }
        ]
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "namespace": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

FileService

GET /apis/v1beta1/{namespace}/files/list/{path}

namespace

(no description)

type
string
in
path
path

(no description)

type
string
in
path
page

(no description)

type
integer (int32)
in
query
perPage

(no description)

type
integer (int32)
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "totalCount": "integer (int32)",
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "files": [
    {
      "path": "string",
      "name": "string",
      "extension": "string",
      "size": "string (int64)",
      "contentType": "string",
      "lastModified": "string",
      "directory": "boolean"
    }
  ],
  "parentPath": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/files/presigned-url/{key}

namespace

(no description)

type
string
in
path
key

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "url": "string",
  "size": "string (int64)"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

InferenceService

POST /apis/v1beta1/{namespace}/inferenceservice

namespace

(no description)

type
string
in
path
Request Example
{
  "namespace": "string",
  "name": "string",
  "defaultTransformerImage": "string",
  "predictor": {
    "name": "string",
    "runtimeVersion": "string",
    "storageUri": "string",
    "nodeSelector": "string",
    "minCpu": "string",
    "minMemory": "string",
    "maxCpu": "string",
    "maxMemory": "string"
  },
  "transformer": {
    "containers": [
      {
        "image": "string",
        "name": "string",
        "env": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "minCpu": "string",
    "minMemory": "string",
    "maxCpu": "string",
    "maxMemory": "string"
  }
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "ready": "boolean",
  "conditions": [
    {
      "lastTransitionTime": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "predictUrl": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/inferenceservice/{name}

namespace

(no description)

type
string
in
path
name

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "ready": "boolean",
  "conditions": [
    {
      "lastTransitionTime": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "predictUrl": "string"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

DELETE /apis/v1beta1/{namespace}/inferenceservice/{name}

namespace

(no description)

type
string
in
path
name

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

SecretService

GET /apis/v1beta1/{namespace}/secrets

namespace

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "count": "integer (int32)",
  "secrets": [
    {
      "name": "string",
      "data": "object"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/secrets

undefined
namespace

(no description)

type
string
in
path
Request Example
{
  "name": "string",
  "data": "object"
}
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/secrets/{name}

namespace

(no description)

type
string
in
path
name

(no description)

type
string
in
path
200 OK

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "name": "string",
  "data": "object"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

DELETE /apis/v1beta1/{namespace}/secrets/{name}

namespace

(no description)

type
string
in
path
name

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "deleted": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/secrets/{name}/exists

namespace

(no description)

type
string
in
path
name

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "exists": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/secrets/{secret.name}

undefined
namespace

(no description)

type
string
in
path
secret.name

(no description)

type
string
in
path
Request Example
{
  "name": "string",
  "data": "object"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "inserted": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PATCH /apis/v1beta1/{namespace}/secrets/{secret.name}

undefined
namespace

(no description)

type
string
in
path
secret.name

(no description)

type
string
in
path
Request Example
{
  "name": "string",
  "data": "object"
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "updated": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

DELETE /apis/v1beta1/{namespace}/secrets/{secretName}/keys/{key}

namespace

(no description)

type
string
in
path
secretName

(no description)

type
string
in
path
key

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "deleted": "boolean"
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

LabelService

GET /apis/v1beta1/{namespace}/{resource}/labels

namespace

(no description)

type
string
in
path
resource

(no description)

type
string
in
path
keyLike

(no description)

type
string
in
query
skipKeys

(no description)

type
string
in
query

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/{resource}/{uid}/labels

namespace

(no description)

type
string
in
path
resource

(no description)

type
string
in
path
uid

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/{namespace}/{resource}/{uid}/labels

undefined
namespace

(no description)

type
string
in
path
resource

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "items": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/{resource}/{uid}/labels

undefined
namespace

(no description)

type
string
in
path
resource

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
Request Example
{
  "items": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

DELETE /apis/v1beta1/{namespace}/{resource}/{uid}/labels/{key}

namespace

(no description)

type
string
in
path
resource

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
key

(no description)

type
string
in
path

A successful response.

An unexpected error response.

Response Example (200 OK)
{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}

Schema Definitions

AddSecretKeyValueResponse: object

inserted: boolean
Example
{
  "inserted": "boolean"
}

AddWorkflowExecutionsMetricsRequest: object

namespace: string
uid: string
override: boolean
metrics: object[]
Example
{
  "namespace": "string",
  "uid": "string",
  "override": "boolean",
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

ArchiveWorkflowTemplateResponse: object

workflowTemplate: WorkflowTemplate
Example
{
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  }
}

Container: object

image: string
name: string
env: object[]
Example
{
  "image": "string",
  "name": "string",
  "env": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

CreateInferenceServiceRequest: object

namespace: string
name: string
defaultTransformerImage: string
predictor: InferenceServicePredictor
transformer: InferenceServiceTransformer
Example
{
  "namespace": "string",
  "name": "string",
  "defaultTransformerImage": "string",
  "predictor": {
    "name": "string",
    "runtimeVersion": "string",
    "storageUri": "string",
    "nodeSelector": "string",
    "minCpu": "string",
    "minMemory": "string",
    "maxCpu": "string",
    "maxMemory": "string"
  },
  "transformer": {
    "containers": [
      {
        "image": "string",
        "name": "string",
        "env": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "minCpu": "string",
    "minMemory": "string",
    "maxCpu": "string",
    "maxMemory": "string"
  }
}

CreateWorkflowExecutionBody: object

workflowTemplateUid: string
workflowTemplateVersion: string (int64)
parameters: object[]
labels: object[]
Example
{
  "workflowTemplateUid": "string",
  "workflowTemplateVersion": "string (int64)",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

CreateWorkspaceBody: object

workspaceTemplateUid: string
workspaceTemplateVersion: string (int64)
parameters: object[]
labels: object[]
captureNode: boolean
Example
{
  "workspaceTemplateUid": "string",
  "workspaceTemplateVersion": "string (int64)",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "captureNode": "boolean"
}

CronWorkflow: object

name: string
uid: string
manifest: string
workflowExecution: WorkflowExecution
labels: object[]
namespace: string
Example
{
  "name": "string",
  "uid": "string",
  "manifest": "string",
  "workflowExecution": {
    "createdAt": "string",
    "uid": "string",
    "name": "string",
    "phase": "string",
    "startedAt": "string",
    "finishedAt": "string",
    "manifest": "string",
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "metadata": {
      "url": "string"
    },
    "metrics": [
      {
        "name": "string",
        "value": "number (double)",
        "format": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}

CronWorkflowStatisticsReport: object

total: integer (int32)
Example
{
  "total": "integer (int32)"
}

DeleteSecretKeyResponse: object

deleted: boolean
Example
{
  "deleted": "boolean"
}

DeleteSecretResponse: object

deleted: boolean
Example
{
  "deleted": "boolean"
}

Env: object

name: string
value: string
Example
{
  "name": "string",
  "value": "string"
}

File: object

path: string
name: string
extension: string
size: string (int64)
contentType: string
lastModified: string
directory: boolean
Example
{
  "path": "string",
  "name": "string",
  "extension": "string",
  "size": "string (int64)",
  "contentType": "string",
  "lastModified": "string",
  "directory": "boolean"
}

GetAccessTokenRequest: object

username: string
token: string
Example
{
  "username": "string",
  "token": "string"
}

GetAccessTokenResponse: object

domain: string
accessToken: string
username: string
Example
{
  "domain": "string",
  "accessToken": "string",
  "username": "string"
}

GetConfigResponse: object

apiUrl: string
domain: string
fqdn: string
nodePool: NodePool
Example
{
  "apiUrl": "string",
  "domain": "string",
  "fqdn": "string",
  "nodePool": {
    "label": "string",
    "options": [
      {
        "name": "string",
        "value": "string"
      }
    ]
  }
}

GetInferenceServiceResponse: object

ready: boolean
conditions: object[]
predictUrl: string
Example
{
  "ready": "boolean",
  "conditions": [
    {
      "lastTransitionTime": "string",
      "status": "string",
      "type": "string"
    }
  ],
  "predictUrl": "string"
}

GetLabelsResponse: object

labels: object[]
Example
{
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

GetNamespaceConfigResponse: object

bucket: string
Example
{
  "bucket": "string"
}

GetPresignedUrlResponse: object

url: string
size: string (int64)
Example
{
  "url": "string",
  "size": "string (int64)"
}

GetWorkflowExecutionMetricsResponse: object

metrics: object[]
Example
{
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

GetWorkflowExecutionStatisticsForNamespaceResponse: object

Example
{
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  }
}

GetWorkspaceStatisticsForNamespaceResponse: object

Example
{
  "stats": {
    "total": "integer (int32)",
    "lastCreated": "string",
    "launching": "integer (int32)",
    "running": "integer (int32)",
    "updating": "integer (int32)",
    "pausing": "integer (int32)",
    "paused": "integer (int32)",
    "terminating": "integer (int32)",
    "terminated": "integer (int32)",
    "failedToPause": "integer (int32)",
    "failedToResume": "integer (int32)",
    "failedToTerminate": "integer (int32)",
    "failedToLaunch": "integer (int32)",
    "failedToUpdate": "integer (int32)",
    "failed": "integer (int32)"
  }
}

HasServiceResponse: object

hasService: boolean
Example
{
  "hasService": "boolean"
}

InferenceServiceCondition: object

lastTransitionTime: string
status: string
type: string
Example
{
  "lastTransitionTime": "string",
  "status": "string",
  "type": "string"
}

InferenceServicePredictor: object

name: string
runtimeVersion: string
storageUri: string
nodeSelector: string
minCpu: string
minMemory: string
maxCpu: string
maxMemory: string
Example
{
  "name": "string",
  "runtimeVersion": "string",
  "storageUri": "string",
  "nodeSelector": "string",
  "minCpu": "string",
  "minMemory": "string",
  "maxCpu": "string",
  "maxMemory": "string"
}

InferenceServiceTransformer: object

containers: object[]
minCpu: string
minMemory: string
maxCpu: string
maxMemory: string
Example
{
  "containers": [
    {
      "image": "string",
      "name": "string",
      "env": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "minCpu": "string",
  "minMemory": "string",
  "maxCpu": "string",
  "maxMemory": "string"
}

IsAuthorized: object

namespace: string
verb: string
group: string
resource: string
resourceName: string
Example
{
  "namespace": "string",
  "verb": "string",
  "group": "string",
  "resource": "string",
  "resourceName": "string"
}

IsAuthorizedResponse: object

authorized: boolean
Example
{
  "authorized": "boolean"
}

IsValidTokenRequest: object

username: string
token: string
Example
{
  "username": "string",
  "token": "string"
}

IsValidTokenResponse: object

domain: string
token: string
username: string
Example
{
  "domain": "string",
  "token": "string",
  "username": "string"
}

KeyValue: object

key: string
value: string
Example
{
  "key": "string",
  "value": "string"
}

Labels: object

items: object[]
Example
{
  "items": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

ListCronWorkflowsResponse: object

count: integer (int32)
cronWorkflows: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "cronWorkflows": [
    {
      "name": "string",
      "uid": "string",
      "manifest": "string",
      "workflowExecution": {
        "createdAt": "string",
        "uid": "string",
        "name": "string",
        "phase": "string",
        "startedAt": "string",
        "finishedAt": "string",
        "manifest": "string",
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean",
          "isArchived": "boolean",
          "labels": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "stats": {
            "total": "integer (int32)",
            "lastExecuted": "string",
            "running": "integer (int32)",
            "completed": "integer (int32)",
            "failed": "integer (int32)",
            "terminated": "integer (int32)"
          },
          "cronStats": {
            "total": "integer (int32)"
          },
          "parameters": [
            {
              "name": "string",
              "value": "string",
              "type": "string",
              "displayName": "string",
              "hint": "string",
              "required": "boolean",
              "visibility": "string",
              "options": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "description": "string"
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "metadata": {
          "url": "string"
        },
        "metrics": [
          {
            "name": "string",
            "value": "number (double)",
            "format": "string"
          }
        ]
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "namespace": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

ListFilesResponse: object

count: integer (int32)
totalCount: integer (int32)
page: integer (int32)
pages: integer (int32)
files: object[]
parentPath: string
Example
{
  "count": "integer (int32)",
  "totalCount": "integer (int32)",
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "files": [
    {
      "path": "string",
      "name": "string",
      "extension": "string",
      "size": "string (int64)",
      "contentType": "string",
      "lastModified": "string",
      "directory": "boolean"
    }
  ],
  "parentPath": "string"
}

ListNamespacesResponse: object

count: integer (int32)
namespaces: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "namespaces": [
    {
      "name": "string",
      "sourceName": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

ListSecretsResponse: object

count: integer (int32)
secrets: object[]
Example
{
  "count": "integer (int32)",
  "secrets": [
    {
      "name": "string",
      "data": "object"
    }
  ]
}

ListServicesResponse: object

count: integer (int32)
services: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "services": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

ListWorkflowExecutionsFieldResponse: object

values: string[]
Example
{
  "values": [
    "string"
  ]
}

ListWorkflowExecutionsResponse: object

count: integer (int32)
workflowExecutions: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
totalAvailableCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "workflowExecutions": [
    {
      "createdAt": "string",
      "uid": "string",
      "name": "string",
      "phase": "string",
      "startedAt": "string",
      "finishedAt": "string",
      "manifest": "string",
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "isArchived": "boolean",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "stats": {
          "total": "integer (int32)",
          "lastExecuted": "string",
          "running": "integer (int32)",
          "completed": "integer (int32)",
          "failed": "integer (int32)",
          "terminated": "integer (int32)"
        },
        "cronStats": {
          "total": "integer (int32)"
        },
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "description": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "metadata": {
        "url": "string"
      },
      "metrics": [
        {
          "name": "string",
          "value": "number (double)",
          "format": "string"
        }
      ]
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)",
  "totalAvailableCount": "integer (int32)"
}

ListWorkflowTemplateVersionsResponse: object

count: integer (int32)
workflowTemplates: object[]
Example
{
  "count": "integer (int32)",
  "workflowTemplates": [
    {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    }
  ]
}

ListWorkflowTemplatesFieldResponse: object

values: string[]
Example
{
  "values": [
    "string"
  ]
}

ListWorkflowTemplatesResponse: object

count: integer (int32)
workflowTemplates: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
totalAvailableCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "workflowTemplates": [
    {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)",
  "totalAvailableCount": "integer (int32)"
}

ListWorkspaceResponse: object

count: integer (int32)
workspaces: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
totalAvailableCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "workspaces": [
    {
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "createdAt": "string",
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workspaceTemplate": {
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "createdAt": "string",
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean",
          "isArchived": "boolean",
          "labels": [
            {
              "key": "string",
              "value": "string"
            }
          ],
          "stats": {
            "total": "integer (int32)",
            "lastExecuted": "string",
            "running": "integer (int32)",
            "completed": "integer (int32)",
            "failed": "integer (int32)",
            "terminated": "integer (int32)"
          },
          "cronStats": {
            "total": "integer (int32)"
          },
          "parameters": [
            {
              "name": "string",
              "value": "string",
              "type": "string",
              "displayName": "string",
              "hint": "string",
              "required": "boolean",
              "visibility": "string",
              "options": [
                {
                  "name": "string",
                  "value": "string"
                }
              ]
            }
          ],
          "description": "string"
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "isArchived": "boolean",
        "description": "string"
      },
      "status": {
        "phase": "string",
        "startedAt": "string",
        "pausedAt": "string",
        "terminatedAt": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "url": "string",
      "templateParameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workspaceComponents": [
        {
          "name": "string",
          "url": "string"
        }
      ],
      "machineType": {
        "name": "string",
        "value": "string"
      }
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)",
  "totalAvailableCount": "integer (int32)"
}

ListWorkspaceTemplateVersionsResponse: object

count: integer (int32)
workspaceTemplates: object[]
Example
{
  "count": "integer (int32)",
  "workspaceTemplates": [
    {
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "isArchived": "boolean",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "stats": {
          "total": "integer (int32)",
          "lastExecuted": "string",
          "running": "integer (int32)",
          "completed": "integer (int32)",
          "failed": "integer (int32)",
          "terminated": "integer (int32)"
        },
        "cronStats": {
          "total": "integer (int32)"
        },
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "description": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean",
      "description": "string"
    }
  ]
}

ListWorkspaceTemplatesFieldResponse: object

values: string[]
Example
{
  "values": [
    "string"
  ]
}

ListWorkspaceTemplatesResponse: object

count: integer (int32)
workspaceTemplates: object[]
page: integer (int32)
pages: integer (int32)
totalCount: integer (int32)
Example
{
  "count": "integer (int32)",
  "workspaceTemplates": [
    {
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean",
        "isArchived": "boolean",
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "stats": {
          "total": "integer (int32)",
          "lastExecuted": "string",
          "running": "integer (int32)",
          "completed": "integer (int32)",
          "failed": "integer (int32)",
          "terminated": "integer (int32)"
        },
        "cronStats": {
          "total": "integer (int32)"
        },
        "parameters": [
          {
            "name": "string",
            "value": "string",
            "type": "string",
            "displayName": "string",
            "hint": "string",
            "required": "boolean",
            "visibility": "string",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "description": "string"
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean",
      "description": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

ListWorkspacesFieldResponse: object

values: string[]
Example
{
  "values": [
    "string"
  ]
}

LogEntry: object

timestamp: string
content: string
Example
{
  "timestamp": "string",
  "content": "string"
}

LogStreamResponse: object

logEntries: object[]
Example
{
  "logEntries": [
    {
      "timestamp": "string",
      "content": "string"
    }
  ]
}

MachineType: object

name: string
value: string
Example
{
  "name": "string",
  "value": "string"
}

Metric: object

name: string
value: number (double)
format: string
Example
{
  "name": "string",
  "value": "number (double)",
  "format": "string"
}

Namespace: object

name: string
sourceName: string
Example
{
  "name": "string",
  "sourceName": "string"
}

NodePool: object

label: string
options: object[]
Example
{
  "label": "string",
  "options": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

NodePoolOption: object

name: string
value: string
Example
{
  "name": "string",
  "value": "string"
}

Parameter: object

name: string
value: string
type: string
displayName: string
hint: string
required: boolean
visibility: string
options: object[]
Example
{
  "name": "string",
  "value": "string",
  "type": "string",
  "displayName": "string",
  "hint": "string",
  "required": "boolean",
  "visibility": "string",
  "options": [
    {
      "name": "string",
      "value": "string"
    }
  ]
}

ParameterOption: object

name: string
value: string
Example
{
  "name": "string",
  "value": "string"
}

Secret: object

name: string
data: object
Example
{
  "name": "string",
  "data": "object"
}

SecretExistsResponse: object

exists: boolean
Example
{
  "exists": "boolean"
}

Service: object

name: string
url: string
Example
{
  "name": "string",
  "url": "string"
}

Statistics: object

workflowStatus: string
workflowTemplateId: string (int64)
Example
{
  "workflowStatus": "string",
  "workflowTemplateId": "string (int64)"
}

UpdateSecretKeyValueResponse: object

updated: boolean
Example
{
  "updated": "boolean"
}

UpdateWorkflowExecutionsMetricsRequest: object

namespace: string
uid: string
metrics: object[]
Example
{
  "namespace": "string",
  "uid": "string",
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

UpdateWorkspaceBody: object

parameters: object[]
labels: object[]
Example
{
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

WorkflowExecution: object

createdAt: string
uid: string
name: string
phase: string
startedAt: string
finishedAt: string
manifest: string
parameters: object[]
workflowTemplate: WorkflowTemplate
labels: object[]
metadata: WorkflowExecutionMetadata
metrics: object[]
Example
{
  "createdAt": "string",
  "uid": "string",
  "name": "string",
  "phase": "string",
  "startedAt": "string",
  "finishedAt": "string",
  "manifest": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "metadata": {
    "url": "string"
  },
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

WorkflowExecutionMetadata: object

url: string
Example
{
  "url": "string"
}

WorkflowExecutionStatisticReport: object

total: integer (int32)
lastExecuted: string
running: integer (int32)
completed: integer (int32)
failed: integer (int32)
terminated: integer (int32)
Example
{
  "total": "integer (int32)",
  "lastExecuted": "string",
  "running": "integer (int32)",
  "completed": "integer (int32)",
  "failed": "integer (int32)",
  "terminated": "integer (int32)"
}

WorkflowExecutionStatus: object

phase: string
Example
{
  "phase": "string"
}

WorkflowExecutionsMetricsResponse: object

metrics: object[]
Example
{
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "string"
    }
  ]
}

WorkflowTemplate: object

createdAt: string
modifiedAt: string
uid: string
name: string
version: string (int64)
versions: string (int64)
manifest: string
isLatest: boolean
isArchived: boolean
labels: object[]
stats: WorkflowExecutionStatisticReport
cronStats: CronWorkflowStatisticsReport
parameters: object[]
description: string
Example
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "isArchived": "boolean",
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "stats": {
    "total": "integer (int32)",
    "lastExecuted": "string",
    "running": "integer (int32)",
    "completed": "integer (int32)",
    "failed": "integer (int32)",
    "terminated": "integer (int32)"
  },
  "cronStats": {
    "total": "integer (int32)"
  },
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "description": "string"
}

Workspace: object

uid: string
name: string
version: string (int64)
createdAt: string
parameters: object[]
workspaceTemplate: WorkspaceTemplate
status: WorkspaceStatus
labels: object[]
url: string
templateParameters: object[]
workspaceComponents: object[]
machineType: MachineType
Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "createdAt": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceTemplate": {
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "createdAt": "string",
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean",
      "isArchived": "boolean",
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "stats": {
        "total": "integer (int32)",
        "lastExecuted": "string",
        "running": "integer (int32)",
        "completed": "integer (int32)",
        "failed": "integer (int32)",
        "terminated": "integer (int32)"
      },
      "cronStats": {
        "total": "integer (int32)"
      },
      "parameters": [
        {
          "name": "string",
          "value": "string",
          "type": "string",
          "displayName": "string",
          "hint": "string",
          "required": "boolean",
          "visibility": "string",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "description": "string"
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "isArchived": "boolean",
    "description": "string"
  },
  "status": {
    "phase": "string",
    "startedAt": "string",
    "pausedAt": "string",
    "terminatedAt": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "url": "string",
  "templateParameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean",
      "visibility": "string",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceComponents": [
    {
      "name": "string",
      "url": "string"
    }
  ],
  "machineType": {
    "name": "string",
    "value": "string"
  }
}

WorkspaceComponent: object

name: string
url: string
Example
{
  "name": "string",
  "url": "string"
}

WorkspaceStatisticReport: object

total: integer (int32)
lastCreated: string
launching: integer (int32)
running: integer (int32)
updating: integer (int32)
pausing: integer (int32)
paused: integer (int32)
terminating: integer (int32)
terminated: integer (int32)
failedToPause: integer (int32)
failedToResume: integer (int32)
failedToTerminate: integer (int32)
failedToLaunch: integer (int32)
failedToUpdate: integer (int32)
failed: integer (int32)
Example
{
  "total": "integer (int32)",
  "lastCreated": "string",
  "launching": "integer (int32)",
  "running": "integer (int32)",
  "updating": "integer (int32)",
  "pausing": "integer (int32)",
  "paused": "integer (int32)",
  "terminating": "integer (int32)",
  "terminated": "integer (int32)",
  "failedToPause": "integer (int32)",
  "failedToResume": "integer (int32)",
  "failedToTerminate": "integer (int32)",
  "failedToLaunch": "integer (int32)",
  "failedToUpdate": "integer (int32)",
  "failed": "integer (int32)"
}

WorkspaceStatus: object

phase: string
startedAt: string
pausedAt: string
terminatedAt: string
Example
{
  "phase": "string",
  "startedAt": "string",
  "pausedAt": "string",
  "terminatedAt": "string"
}

WorkspaceTemplate: object

uid: string
name: string
version: string (int64)
manifest: string
isLatest: boolean
createdAt: string
workflowTemplate: WorkflowTemplate
labels: object[]
isArchived: boolean
description: string
Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean",
    "isArchived": "boolean",
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "stats": {
      "total": "integer (int32)",
      "lastExecuted": "string",
      "running": "integer (int32)",
      "completed": "integer (int32)",
      "failed": "integer (int32)",
      "terminated": "integer (int32)"
    },
    "cronStats": {
      "total": "integer (int32)"
    },
    "parameters": [
      {
        "name": "string",
        "value": "string",
        "type": "string",
        "displayName": "string",
        "hint": "string",
        "required": "boolean",
        "visibility": "string",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "description": "string"
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean",
  "description": "string"
}

google.protobuf.Any: object

typeUrl: string
value: string (byte)
Example
{
  "typeUrl": "string",
  "value": "string (byte)"
}

google.rpc.Status: object

code: integer (int32)
message: string
details: object[]
Example
{
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "typeUrl": "string",
      "value": "string (byte)"
    }
  ]
}