# Convert Entity Format

Converts entity YAML between Backstage and Harness formats. This is useful when  migrating entities between systems or when standardizing entity definitions across different platforms. The conversion preserves all semantic information while adapting to the target format conventions.

Endpoint: POST /v1/entities/convert/{option}
Version: 1.0
Security: x-api-key

## Header parameters:

  - `Harness-Account` (string)
    Identifier field of the account the resource is scoped to.

## Path parameters:

  - `option` (string, required)
    Conversion direction - either convert from Backstage to Harness format or vice versa
    Enum: "backstage-to-harness", "harness-to-backstage"

## Request fields (application/json):

  - `yaml` (string, required)
    Entity YAML definition as a string. Should conform to either the Harness entity format or the Backstage entity format, depending on the operation.

## Response 200 fields (application/json):

  - `yaml` (string, required)
    Converted entity YAML definition in the target format