Onepanel API Reference

Onepanel API

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

Authentication

Bearer

description

Authentication token, prefixed by Bearer

name
authorization
in
header

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 (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/auth/token

undefined
Request Example
{
  "token": "string"
}

A successful response.

An unexpected error response

Response Example (200 OK)
{
  "domain": "string"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

POST /apis/v1beta1/namespaces

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

A successful response.

An unexpected error response

Response Example (200 OK)
{
  "name": "string"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

GET /apis/v1beta1/{namespace}/cron_workflows

namespace

(no description)

type
string
in
path
workflow_template_name

(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 (boolean)",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean (boolean)",
          "isArchived": "boolean (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)"
          }
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "namespace": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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

namespace

(no description)

type
string
in
path
workflow_template_name

(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 (boolean)",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean (boolean)",
          "isArchived": "boolean (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)"
          }
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "namespace": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

WorkflowService

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

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 (boolean)",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "isArchived": "boolean (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)"
        }
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
      "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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

namespace

(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)
{
  "data": "string (byte)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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

namespace

(no description)

type
string
in
path
uid

(no description)

type
string
in
path
path

(no description)

type
string
in
path

A successful response.

An unexpected error response

Response Example (200 OK)
{
  "files": [
    {
      "path": "string",
      "name": "string",
      "extension": "string",
      "size": "string (int64)",
      "contentType": "string",
      "lastModified": "string",
      "directory": "boolean (boolean)"
    }
  ],
  "parentPath": "string"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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": {
    "timestamp": "string",
    "content": "string"
  },
  "error": {
    "grpc_code": "integer (int32)",
    "http_code": "integer (int32)",
    "message": "string",
    "http_status": "string",
    "details": [
      {
        "type_url": "string",
        "value": "string (byte)"
      }
    ]
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "error": {
    "grpc_code": "integer (int32)",
    "http_code": "integer (int32)",
    "message": "string",
    "http_status": "string",
    "details": [
      {
        "type_url": "string",
        "value": "string (byte)"
      }
    ]
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

WorkflowTemplateService

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

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 (boolean)",
      "isArchived": "boolean (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)"
      }
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
  "isArchived": "boolean (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)"
  }
}

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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
    "isArchived": "boolean (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)"
    }
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "isArchived": "boolean (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)"
      }
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
  "isArchived": "boolean (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)"
  }
}

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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

PUT /apis/v1beta1/{namespace}/workflow_templates/{workflowTemplate.uid}/versions/{workflowTemplate.version}

undefined
namespace

(no description)

type
string
in
path
workflowTemplate.uid

(no description)

type
string
in
path
workflowTemplate.version

(no description)

type
string (int64)
in
path
Request Example
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean (boolean)",
  "isArchived": "boolean (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)"
  }
}

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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

WorkspaceTemplateService

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

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 (boolean)",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "isArchived": "boolean (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)"
        }
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean (boolean)"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}

A successful response.

An unexpected error response

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}

A successful response.

An unexpected error response

Response Example (200 OK)
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "isArchived": "boolean (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)"
        }
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean (boolean)"
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

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 (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}

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 (boolean)",
  "isArchived": "boolean (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)"
  }
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

WorkspaceService

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

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 (boolean)",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workspaceTemplate": {
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "createdAt": "string",
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean (boolean)",
          "isArchived": "boolean (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)"
          }
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "isArchived": "boolean (boolean)"
      },
      "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 (boolean)",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}
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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceTemplate": {
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "createdAt": "string",
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "isArchived": "boolean (boolean)"
  },
  "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceTemplate": {
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "createdAt": "string",
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "isArchived": "boolean (boolean)"
  },
  "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 (boolean)",
      "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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
200 OK

A successful response.

An unexpected error response

Response Example (200 OK)
{}
Response Example (default )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

LabelService

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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "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 )
{
  "error": "string",
  "code": "integer (int32)",
  "message": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}

Schema Definitions

AddSecretKeyValueResponse: object

inserted: boolean (boolean)
Example
{
  "inserted": "boolean (boolean)"
}

ArchiveWorkflowTemplateResponse: object

workflowTemplate: WorkflowTemplate
Example
{
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  }
}

ArtifactResponse: object

data: string (byte)
Example
{
  "data": "string (byte)"
}

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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ]
}

CreateWorkspaceBody: object

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

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 (boolean)",
        "options": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      }
    ],
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "namespace": "string"
}

CronWorkflowStatisticsReport: object

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

DeleteSecretKeyResponse: object

deleted: boolean (boolean)
Example
{
  "deleted": "boolean (boolean)"
}

DeleteSecretResponse: object

deleted: boolean (boolean)
Example
{
  "deleted": "boolean (boolean)"
}

File: object

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

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"
      }
    ]
  }
}

GetLabelsResponse: object

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

GetWorkflowExecutionMetricsResponse: object

metrics: object[]
Example
{
  "metrics": [
    {
      "name": "string",
      "value": "number (double)",
      "format": "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 (boolean)
Example
{
  "authorized": "boolean (boolean)"
}

IsValidTokenResponse: object

domain: string
Example
{
  "domain": "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 (boolean)",
            "options": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          }
        ],
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean (boolean)",
          "isArchived": "boolean (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)"
          }
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ]
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "namespace": "string"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

ListFilesResponse: object

files: object[]
parentPath: string
Example
{
  "files": [
    {
      "path": "string",
      "name": "string",
      "extension": "string",
      "size": "string (int64)",
      "contentType": "string",
      "lastModified": "string",
      "directory": "boolean (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"
    }
  ],
  "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"
    }
  ]
}

ListWorkflowExecutionsResponse: object

count: integer (int32)
workflowExecutions: object[]
page: integer (int32)
pages: integer (int32)
totalCount: 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 (boolean)",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "isArchived": "boolean (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)"
        }
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ]
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "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 (boolean)",
      "isArchived": "boolean (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)"
      }
    }
  ]
}

ListWorkflowTemplatesResponse: object

count: integer (int32)
workflowTemplates: object[]
page: integer (int32)
pages: integer (int32)
totalCount: 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 (boolean)",
      "isArchived": "boolean (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)"
      }
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

ListWorkspaceResponse: object

count: integer (int32)
workspaces: object[]
page: integer (int32)
pages: integer (int32)
totalCount: 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 (boolean)",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ],
      "workspaceTemplate": {
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "createdAt": "string",
        "workflowTemplate": {
          "createdAt": "string",
          "modifiedAt": "string",
          "uid": "string",
          "name": "string",
          "version": "string (int64)",
          "versions": "string (int64)",
          "manifest": "string",
          "isLatest": "boolean (boolean)",
          "isArchived": "boolean (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)"
          }
        },
        "labels": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "isArchived": "boolean (boolean)"
      },
      "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 (boolean)",
          "options": [
            {
              "name": "string",
              "value": "string"
            }
          ]
        }
      ]
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "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 (boolean)",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "isArchived": "boolean (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)"
        }
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean (boolean)"
    }
  ]
}

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 (boolean)",
      "createdAt": "string",
      "workflowTemplate": {
        "createdAt": "string",
        "modifiedAt": "string",
        "uid": "string",
        "name": "string",
        "version": "string (int64)",
        "versions": "string (int64)",
        "manifest": "string",
        "isLatest": "boolean (boolean)",
        "isArchived": "boolean (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)"
        }
      },
      "labels": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "isArchived": "boolean (boolean)"
    }
  ],
  "page": "integer (int32)",
  "pages": "integer (int32)",
  "totalCount": "integer (int32)"
}

LogEntry: object

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

Metric: object

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

Namespace: object

name: string
Example
{
  "name": "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 (boolean)
options: object[]
Example
{
  "name": "string",
  "value": "string",
  "type": "string",
  "displayName": "string",
  "hint": "string",
  "required": "boolean (boolean)",
  "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 (boolean)
Example
{
  "exists": "boolean (boolean)"
}

Statistics: object

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

TokenWrapper: object

token: string
Example
{
  "token": "string"
}

UpdateSecretKeyValueResponse: object

updated: boolean (boolean)
Example
{
  "updated": "boolean (boolean)"
}

UpdateWorkspaceBody: object

parameters: object[]
labels: object[]
Example
{
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean (boolean)",
      "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[]
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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "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"
}

WorkflowTemplate: object

createdAt: string
modifiedAt: string
uid: string
name: string
version: string (int64)
versions: string (int64)
manifest: string
isLatest: boolean (boolean)
isArchived: boolean (boolean)
labels: object[]
stats: WorkflowExecutionStatisticReport
cronStats: CronWorkflowStatisticsReport
Example
{
  "createdAt": "string",
  "modifiedAt": "string",
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "versions": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean (boolean)",
  "isArchived": "boolean (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)"
  }
}

Workspace: object

uid: string
name: string
version: string (int64)
createdAt: string
parameters: object[]
workspaceTemplate: WorkspaceTemplate
status: WorkspaceStatus
labels: object[]
url: string
templateParameters: object[]
Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "createdAt": "string",
  "parameters": [
    {
      "name": "string",
      "value": "string",
      "type": "string",
      "displayName": "string",
      "hint": "string",
      "required": "boolean (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "workspaceTemplate": {
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "createdAt": "string",
    "workflowTemplate": {
      "createdAt": "string",
      "modifiedAt": "string",
      "uid": "string",
      "name": "string",
      "version": "string (int64)",
      "versions": "string (int64)",
      "manifest": "string",
      "isLatest": "boolean (boolean)",
      "isArchived": "boolean (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)"
      }
    },
    "labels": [
      {
        "key": "string",
        "value": "string"
      }
    ],
    "isArchived": "boolean (boolean)"
  },
  "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 (boolean)",
      "options": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ]
}

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 (boolean)
createdAt: string
workflowTemplate: WorkflowTemplate
labels: object[]
isArchived: boolean (boolean)
Example
{
  "uid": "string",
  "name": "string",
  "version": "string (int64)",
  "manifest": "string",
  "isLatest": "boolean (boolean)",
  "createdAt": "string",
  "workflowTemplate": {
    "createdAt": "string",
    "modifiedAt": "string",
    "uid": "string",
    "name": "string",
    "version": "string (int64)",
    "versions": "string (int64)",
    "manifest": "string",
    "isLatest": "boolean (boolean)",
    "isArchived": "boolean (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)"
    }
  },
  "labels": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "isArchived": "boolean (boolean)"
}

google.protobuf.Any: object

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

Example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

 foo := &pb.Foo{...}
 any, err := ptypes.MarshalAny(foo)
 ...
 foo := &pb.Foo{}
 if err := ptypes.UnmarshalAny(any, foo); err != nil {
   ...
 }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile;
                      message Person {
                        string first_name = 1;
                        string last_name = 2;
                      }
                      
                      {
                        "@type": "type.googleapis.com/google.profile.Person",
                        "firstName": <string>,
                        "lastName": <string>
                      }
                      

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
type_url: string

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).

In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:

  • If no scheme is provided, https is assumed.
  • An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
  • Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)

Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.

Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

value: string (byte)

Must be a valid serialized protocol buffer of the above specified type.

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

grpc.gateway.runtime.Error: object

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

grpc.gateway.runtime.StreamError: object

grpc_code: integer (int32)
http_code: integer (int32)
message: string
http_status: string
details: object[]
Example
{
  "grpc_code": "integer (int32)",
  "http_code": "integer (int32)",
  "message": "string",
  "http_status": "string",
  "details": [
    {
      "type_url": "string",
      "value": "string (byte)"
    }
  ]
}