---
title: "list all definitions"
method: GET
path: "/api/v1/definitions"
tags: ["definition"]
---

# list all definitions

`GET /api/v1/definitions`

## Query parameters

- `type` 'component' | 'trait' | 'workflowstep' | 'policy', required
- `queryAll` boolean
- `appliedWorkload` string
- `ownerAddon` string
- `scope` string

## Response `200`

OK

- V1ListDefinitionResponse
  - `definitions` V1DefinitionBase[], required
    - `alias` string, required
    - `category` string, required
    - `component` V1beta1ComponentDefinitionSpec
      - `childResourceKinds` CommonChildResourceKind[]
        - `apiVersion` string, required
        - `kind` string, required
        - `selector` object
      - `extension` string
      - `podSpecPath` string
      - `revisionLabel` string
      - `schematic` CommonSchematic
        - `cue` CommonCUE
          - `template` string, required
        - `terraform` CommonTerraform
          - `configuration` string, required
          - `customRegion` string
          - `deleteResource` boolean
          - `gitCredentialsSecretReference` V1SecretReference — SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
            - `name` string — name is unique within a namespace to reference a secret resource.
            - `namespace` string — namespace defines the space within which the secret name must be unique.
          - `path` string
          - `providerRef` TypesReference
            - `name` string, required
            - `namespace` string
          - `type` string
          - `writeConnectionSecretToRef` TypesSecretReference
            - `name` string, required
            - `namespace` string
      - `status` CommonStatus
        - `customStatus` string
        - `healthPolicy` string
      - `workload` CommonWorkloadTypeDescriptor, required
        - `definition` CommonWorkloadGVK
          - `apiVersion` string, required
          - `kind` string, required
        - `type` string
    - `description` string, required
    - `icon` string, required
    - `labels` object, required
    - `name` string, required
    - `ownerAddon` string, required
    - `policy` V1beta1PolicyDefinitionSpec
      - `definitionRef` CommonDefinitionReference
        - `name` string, required
        - `version` string
      - `manageHealthCheck` boolean
      - `schematic` CommonSchematic
        - `cue` CommonCUE
          - `template` string, required
        - `terraform` CommonTerraform
          - `configuration` string, required
          - `customRegion` string
          - `deleteResource` boolean
          - `gitCredentialsSecretReference` V1SecretReference — SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
            - `name` string — name is unique within a namespace to reference a secret resource.
            - `namespace` string — namespace defines the space within which the secret name must be unique.
          - `path` string
          - `providerRef` TypesReference
            - `name` string, required
            - `namespace` string
          - `type` string
          - `writeConnectionSecretToRef` TypesSecretReference
            - `name` string, required
            - `namespace` string
    - `status` string, required
    - `trait` V1beta1TraitDefinitionSpec
      - `appliesToWorkloads` string[]
      - `conflictsWith` string[]
      - `controlPlaneOnly` boolean
      - `definitionRef` CommonDefinitionReference
        - `name` string, required
        - `version` string
      - `extension` string
      - `manageWorkload` boolean
      - `podDisruptive` boolean
      - `revisionEnabled` boolean
      - `schematic` CommonSchematic
        - `cue` CommonCUE
          - `template` string, required
        - `terraform` CommonTerraform
          - `configuration` string, required
          - `customRegion` string
          - `deleteResource` boolean
          - `gitCredentialsSecretReference` V1SecretReference — SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
            - `name` string — name is unique within a namespace to reference a secret resource.
            - `namespace` string — namespace defines the space within which the secret name must be unique.
          - `path` string
          - `providerRef` TypesReference
            - `name` string, required
            - `namespace` string
          - `type` string
          - `writeConnectionSecretToRef` TypesSecretReference
            - `name` string, required
            - `namespace` string
      - `stage` string
      - `status` CommonStatus
        - `customStatus` string
        - `healthPolicy` string
      - `workloadRefPath` string
    - `workflowStep` V1beta1WorkflowStepDefinitionSpec
      - `definitionRef` CommonDefinitionReference
        - `name` string, required
        - `version` string
      - `schematic` CommonSchematic
        - `cue` CommonCUE
          - `template` string, required
        - `terraform` CommonTerraform
          - `configuration` string, required
          - `customRegion` string
          - `deleteResource` boolean
          - `gitCredentialsSecretReference` V1SecretReference — SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
            - `name` string — name is unique within a namespace to reference a secret resource.
            - `namespace` string — namespace defines the space within which the secret name must be unique.
          - `path` string
          - `providerRef` TypesReference
            - `name` string, required
            - `namespace` string
          - `type` string
          - `writeConnectionSecretToRef` TypesSecretReference
            - `name` string, required
            - `namespace` string
    - `workloadType` string

## Other responses

- `500` — Bummer, something went wrong

---

[API](https://skmtc.net/kubevela/apis/kubevela-api-doc.md) · [All operations](https://skmtc.net/kubevela/apis/kubevela-api-doc/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kubevela/kubevela-api-doc/revisions/8e41615b25d5/schema)