---
title: "Detail a definition"
method: GET
path: "/api/v1/definitions/{definitionName}"
tags: ["definition"]
---

# Detail a definition

`GET /api/v1/definitions/{definitionName}`

## Path parameters

- `definitionName` string, required

## Query parameters

- `type` string

## Response `200`

create successfully

- V1DetailDefinitionResponse
  - `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
  - `schema` string, required
  - `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
  - `uiSchema` SchemaUIParameter[], required
    - `additional` boolean
    - `additionalParameter` SchemaUIParameter — recursive
    - `conditions` SchemaCondition[]
      - `action` string
      - `jsonKey` string, required
      - `op` string
      - `value` unknown, required
    - `description` string, required
    - `disable` boolean
    - `jsonKey` string, required
    - `label` string, required
    - `sort` integer, required
    - `style` SchemaStyle
      - `colSpan` integer, required
    - `subParameterGroupOption` SchemaGroupOption[]
      - `keys` string[], required
      - `label` string, required
    - `subParameters` SchemaUIParameter[]
    - `uiType` string, required
    - `validate` SchemaValidate
      - `defaultValue` unknown
      - `immutable` boolean, required
      - `max` number, double
      - `maxLength` integer
      - `min` number, double
      - `minLength` integer
      - `options` SchemaOption[]
        - `label` string, required
        - `value` unknown, required
      - `pattern` string
      - `required` boolean
  - `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)