definition

list all definitions

get/api/v1/definitions

Request

The document declares no server URL.
Auth
none declared
TypeScript
https://skmtc.dev/kubevela/apis/kubevela-api-doc/docs/api/v1/definitions/get.ts
A function with typed inputs. Its response is checked against the schema.

type'component' | 'trait' | 'workflowstep' | 'policy' required

query the definition type

queryAllboolean

query all definitions include hidden in UI

appliedWorkloadstring

if specified, query the trait definition applied to the workload

ownerAddonstring

query by which addon created the definition

scopestring

query by the specified scope like WorkflowRun or Application

namespacesstring

comma-separated namespaces to report each definition's usability in, as unusableIn

Oct 16, 2026626bfe2029ed Revision changes
- info
  added the new optional query request parameter namespaces