Skip to content

Output Port Types

Every output port carries a type, such as Snowflake, Kafka or API. An organization owner configures the types under Settings → Customization → Data Product Types, in the Output Port Types section below the data product types. For each type you set its label and icon, whether the output port forms offer it, and how consumers request access to output ports of that type.

A type's id is stored on every output port of that type. It never changes once created, so relabelling a type does not touch any output port.

Default output port types

An organization that has not changed anything uses the default output port types: the platform types Entropy Data supports, all enabled, plus Other for entering any type. The section shows them and can be edited right away. The first change stores the types in effect together with your change. From then on, types that Entropy Data adds later start disabled, so the type dropdown only changes when you enable them.

Use default output port types deletes everything stored in this section, including your own types and the output port types selected on data product types. The previous rules apply again.

Output ports whose type id has no definition keep working. The section lists the id as Used, not defined, with a Define action that turns it into a type of your own.

Fields of a type

FieldDescription
IdLetters, digits, hyphens and underscores ([A-Za-z0-9][A-Za-z0-9_-]{0,63}), matched exactly, including case. Immutable once created.
LabelShown in the type dropdown and on the output port. One label for every language. A default type without a label uses the platform's label.
IconPicked from the platform logos. Empty uses the icon of the type id.
EnabledOffered in the type dropdown of output ports. Output ports that already use a disabled type keep it, and its access request rules still apply.
Access requestsIn Entropy Data: consumers request access here. Disabled: the request access button is shown disabled, with your explanation in Markdown, and requests are refused. External link: the request access button opens an external page.
Output port statuses that can be requestedAccess can only be requested for output ports in one of the selected statuses. An output port without a status of its own counts as having the status of its data contract, as shown on the data product page. None selected: output ports in any status can be requested.

The list order is the order of the type dropdown. Default types can be disabled but not deleted. A type of your own can be deleted while no output port uses it.

The link of an External link can contain the placeholders {dataProductId}, {outputPortId} and {dataContractId}. A link without placeholders gets the ids added as query parameters.

Note: Access requests for a disabled type are refused in the web UI, through the MCP server, for agents and when copying access. The REST API still accepts them, so integrations can create access agreements for such output ports.

Which rules apply to an output port

An output port follows the rules of its stored type. An output port without a type follows the server type of its data contract. An output port whose type has no definition follows the default rules: access is requested in Entropy Data, in any status.

Allow only the enabled types

One switch above the list decides which types output ports may use. Off, the type dropdown ends with Other, which takes any text, and the API, the MCP server and the YAML editor accept any type. On, only the enabled types are allowed: the output port forms offer no Other, and ODPS data products with an output port of any other type are rejected. Existing data products are not changed.

Supported output port types

A data product type can limit which output port types its data products offer. Open the data product type and select the types under Supported output port types. The selection applies when adding and when editing output ports of data products of that type. An existing output port keeps its current type. With every type selected there is no limit, and types you enable later are offered too.

Migrating existing rules

Some organizations get their output port types from the customization YAML or from rules that Entropy Data set up for them. The section then shows the types in effect and a Migrate button. Migrate stores the types in effect without a change, and you manage them in this section from then on. Any other change in the section does the same before it applies your change.

After the first change, the output port type list in the customization YAML no longer applies. The section says so and links to the customization YAML, where you can remove the list. A list without other turns on Allow only the enabled types, because ODPS data products could only use the listed types before. Use default output port types brings the previous rules back.

API

The same settings are available at /api/settings/output-port-types as JSON or YAML, for organizations that keep configuration in git. GET returns the settings in effect, with legacy: true while nothing is stored. PUT replaces the whole document. Default types that the document leaves out stay, but disabled. DELETE goes back to the default output port types. Writing needs an API key with the organization admin permission.

onlyListedTypes: false
outputPortTypes:
  - id: "snowflake"
    accessRequests:
      mode: "default"
      statuses:
        - "active"
  - id: "kafka"
    label: "Kafka Topics"
    accessRequests:
      mode: "external-link"
      link: "https://access.example.com/kafka?port={outputPortId}"
  - id: "lakehouse-share"
    label: "Lakehouse Share"
    icon: "databricks"
    accessRequests:
      mode: "disabled"
      disabledText: "Access is granted by the **platform team**."
  - id: "s3"
    enabled: false
supportedOutputPortTypes:
  - dataProductType: "source-aligned"
    outputPortTypes:
      - "snowflake"
      - "kafka"

mode is default (In Entropy Data), disabled or external-link. A default type without label uses the platform's label.

curl -H "x-api-key: $API_KEY" -H "Accept: application/yaml" https://app.entropy-data.com/api/settings/output-port-types
curl -X PUT -H "x-api-key: $API_KEY" -H "Content-Type: application/yaml" --data-binary @output-port-types.yaml https://app.entropy-data.com/api/settings/output-port-types

A document that fails validation (a type of your own without a label, two ids that differ only in case, an unknown mode, a link that does not start with https:// or http://) is rejected with 422 and nothing is written.