---
title: "Get dependencies for preview sql."
method: POST
path: "/preview/dependencies"
tags: ["Preview Operations"]
---

# Get dependencies for preview sql.

`POST /preview/dependencies`

## Request

- Base URL: `https://replace-with-account.api.decodable.co/v1alpha2`
- URL: `https://replace-with-account.api.decodable.co/v1alpha2/preview/dependencies`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://auth.decodable.co/authorize?audience=https://api.decodable.co/`
    - Token URL: `https://auth.decodable.co/oauth/token` scopes: `write:preview`
- TypeScript: <https://skmtc.dev/decodable/apis/decodable-control-plane/docs/preview/dependencies/post.ts> (a function with typed inputs; its response is checked against the schema)

Requires permission matching: `preview:write:default.<name>`, where `name` is that of _each_ stream referenced as input in the given `sql`.

## Request body

- object
  - `sql` string, required: The sql to get dependencies for.

## Response `200`

A list of resource dependencies.

- object
  - `inputs` DependencyItem[], required: A list of resource dependencies.
    - union: A dependency item.
      - ConnectionDependency: A dependency item.
        - `resource_type` 'connection' | 'pipeline' | 'stream', required: A resource type.
        - `resource_id` string, required
        - `resource_name` string, required
        - `connector` string, required
      - PipelineDependency: A dependency item.
        - `resource_type` 'connection' | 'pipeline' | 'stream', required: A resource type.
        - `resource_id` string, required
        - `resource_name` string, required
        - `version` integer, required
      - StreamDependency: A dependency item.
        - `resource_type` 'connection' | 'pipeline' | 'stream', required: A resource type.
        - `resource_id` string, required
        - `resource_name` string, required
  - `outputs` DependencyItem[], required: An array of resource dependencies.
    - union: A dependency item.
      - ConnectionDependency: A dependency item.
        - `resource_type` 'connection' | 'pipeline' | 'stream', required: A resource type.
        - `resource_id` string, required
        - `resource_name` string, required
        - `connector` string, required
      - PipelineDependency: A dependency item.
        - `resource_type` 'connection' | 'pipeline' | 'stream', required: A resource type.
        - `resource_id` string, required
        - `resource_name` string, required
        - `version` integer, required
      - StreamDependency: A dependency item.
        - `resource_type` 'connection' | 'pipeline' | 'stream', required: A resource type.
        - `resource_id` string, required
        - `resource_name` string, required

## Other responses

- `400`: An invalid request was received.
- `403`: Access denied: requesting user lacks a required permission.
- `default`: An error has occurred.

---

[API](https://skmtc.dev/decodable/apis/decodable-control-plane.md) - [All operations](https://skmtc.dev/decodable/apis/decodable-control-plane/llms.txt) - [OpenAPI document](https://skmtc.dev/decodable/apis/decodable-control-plane/revisions/9718a3019da8?raw)