> For the complete documentation index, see [llms.txt](https://v2.dataos.info/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://v2.dataos.info/references/interfaces/command-line-interface/resource.md).

# Resource commands

Reference for dataos-ctl resource commands.

The `resource` command group manages every DataOS® Resource type (services, workflows, workers, depots, computes, and others) from manifest apply through runtime lifecycle control. A Data Engineer or Platform Administrator uses these commands to create, inspect, run, and remove Resources without leaving the terminal.

## Quick reference

| Command                               | Description                                                   |
| ------------------------------------- | ------------------------------------------------------------- |
| `dataos-ctl resource apply`           | Apply DataOS® Resources                                       |
| `dataos-ctl resource create`          | Create DataOS® Resources                                      |
| `dataos-ctl resource delete`          | Delete DataOS® Resources                                      |
| `dataos-ctl resource deps`            | Get inbound and outbound dependencies of the DataOS® resource |
| `dataos-ctl resource get`             | Get DataOS® Resources                                         |
| `dataos-ctl resource get runtime`     | Get DataOS® Runtime Details                                   |
| `dataos-ctl resource log`             | Get DataOS® Resource Logs                                     |
| `dataos-ctl resource run`             | Run DataOS® Resource                                          |
| `dataos-ctl resource runtime get`     | Get DataOS® Runnable Resources                                |
| `dataos-ctl resource runtime log`     | Get DataOS® Resource Logs                                     |
| `dataos-ctl resource runtime pause`   | Pause DataOS® Runnable Resources                              |
| `dataos-ctl resource runtime re-run`  | Re-run DataOS® Runnable Resources                             |
| `dataos-ctl resource runtime resume`  | Resume DataOS® Runnable Resources                             |
| `dataos-ctl resource runtime run`     | Run DataOS® Runnable Resources                                |
| `dataos-ctl resource runtime stop`    | Stop DataOS® Runnable Resources                               |
| `dataos-ctl resource runtime suspend` | Suspend DataOS® Runnable Resources                            |
| `dataos-ctl resource tcp-stream`      | Open a tcp stream for DataOS® Resources                       |
| `dataos-ctl resource update`          | Update DataOS® Resources                                      |
| `dataos-ctl resource unquarantine`    | Unquarantine Resources in the current tenant                  |

{% hint style="info" %}
`resource` accepts the aliases `resources`, `rs`, and `re`.
{% endhint %}

## Identifying a resource

Most commands in this group accept the same set of flags to target a Resource. Use whichever form fits the context:

| Flag                                                | Description                                                                                                                                       |
| --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--id`                                              | A single string in the form `type:version:name`, for example `depot:v1:icebase`.                                                                  |
| `-i`, `--identifier`                                | Same as `--id`, or the pipe-delimited form `name\|version\|type`.                                                                                 |
| `-t`, `--type` / `-n`, `--name` / `-v`, `--version` | The type, name, and version as separate flags. Version defaults to `v1` if not passed. Pass `-v` explicitly for `v1alpha` or `v2alpha` Resources. |
| `-f`, `--manifestFile`                              | A manifest file describing the target Resource.                                                                                                   |

## dataos-ctl resource apply

Create or update Resources from a manifest file, a URL, or stdin.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource apply \
  -f ${{manifest-file-path}} \
  [--lint] \
  [--de-ref] \
  [--re-run] \
  [--recursive]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource apply -f ./service.yaml
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                      | Description                                                                                                                                       | Type    | Required                  |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------- |
| `-f`, `--manifestFile`    | Path to the manifest file to apply.                                                                                                               | string  | One of `-f`, `-u`, `--in` |
| `-u`, `--manifestUrl`     | URL to fetch the manifest file from.                                                                                                              | string  | One of `-f`, `-u`, `--in` |
| `--manifestUrlHeaders`    | Headers to send with `--manifestUrl`, as `key=value,key2=value2`.                                                                                 | strings | No                        |
| `--in`                    | Read the manifest file from stdin.                                                                                                                | boolean | One of `-f`, `-u`, `--in` |
| `-R`, `--recursive`       | Apply every manifest file found recursively under the given directory.                                                                            | boolean | No                        |
| `-l`, `--lint`            | Validate the manifest without applying it.                                                                                                        | boolean | No                        |
| `-d`, `--de-ref`          | De-reference the manifest without applying it.                                                                                                    | boolean | No                        |
| `-r`, `--re-run`          | Re-run the Resource immediately after apply. For a Data Product, this updates the deployed Resource in place and re-runs it, without deleting it. | boolean | No                        |
| `--unquarantine`          | Unquarantine quarantined Resources after the update. See [dataos-ctl resource unquarantine](#dataos-ctl-resource-unquarantine).                   | boolean | No                        |
| `--disable-interpolation` | Do not interpolate `$ENV` or `${ENV}` references in the manifest.                                                                                 | boolean | No                        |
| `--disable-resolve-stack` | Do not resolve the stack for the manifest.                                                                                                        | boolean | No                        |
| `-h`, `--help`            | Display help for this command.                                                                                                                    | boolean | No                        |

## dataos-ctl resource create

Create a new Resource from a local manifest file. Fails if the Resource already exists; use `apply` or `update` instead.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource create -f ${{manifest-file-path}}
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource create -f ./service.yaml
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                      | Description                                                             | Type    | Required |
| ------------------------- | ----------------------------------------------------------------------- | ------- | -------- |
| `-f`, `--manifestFile`    | Path to the manifest file.                                              | string  | Yes      |
| `-R`, `--recursive`       | Create every manifest file found recursively under the given directory. | boolean | No       |
| `--disable-interpolation` | Do not interpolate `$ENV` or `${ENV}` references in the manifest.       | boolean | No       |
| `--disable-resolve-stack` | Do not resolve the stack for the manifest.                              | boolean | No       |
| `-h`, `--help`            | Display help for this command.                                          | boolean | No       |

## dataos-ctl resource update

Update an existing Resource from a manifest file. Requires the Resource to already exist.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource update -f ${{manifest-file-path}}
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource update -f ./service.yaml
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                      | Description                                                                                                                     | Type    | Required |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------- | -------- |
| `-f`, `--manifestFile`    | Path to the manifest file.                                                                                                      | string  | Yes      |
| `-R`, `--recursive`       | Update every manifest file found recursively under the given directory.                                                         | boolean | No       |
| `--unquarantine`          | Unquarantine quarantined Resources after the update. See [dataos-ctl resource unquarantine](#dataos-ctl-resource-unquarantine). | boolean | No       |
| `--disable-interpolation` | Do not interpolate `$ENV` or `${ENV}` references in the manifest.                                                               | boolean | No       |
| `--disable-resolve-stack` | Do not resolve the stack for the manifest.                                                                                      | boolean | No       |
| `-h`, `--help`            | Display help for this command.                                                                                                  | boolean | No       |

## dataos-ctl resource delete

Delete one or more Resources.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource delete \
  -t ${{resource-type}} -n ${{resource-name}} -v ${{resource-version}} \
  [--cascade] [--force]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource delete -t service -n orders-api -v v1
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                          | Description                                                   | Type    | Required                                              |
| ----------------------------- | ------------------------------------------------------------- | ------- | ----------------------------------------------------- |
| `-t`, `--type`                | Type of the Resource.                                         | string  | See [Identifying a resource](#identifying-a-resource) |
| `-n`, `--name`                | Name of the Resource. Accepts multiple space-separated names. | string  | See [Identifying a resource](#identifying-a-resource) |
| `-v`, `--version`             | Version of the Resource.                                      | string  | No, default `v1`                                      |
| `--id` / `-i`, `--identifier` | Alternative single-flag targeting forms.                      | string  | See [Identifying a resource](#identifying-a-resource) |
| `-f`, `--manifestFile`        | Delete the Resource described by this manifest file.          | string  | See [Identifying a resource](#identifying-a-resource) |
| `--cascade`                   | Also delete Resources that depend on this one.                | boolean | No                                                    |
| `--force`                     | Delete even if dependencies would otherwise block it.         | boolean | No                                                    |
| `-h`, `--help`                | Display help for this command.                                | boolean | No                                                    |

{% hint style="danger" %}
`resource delete` is irreversible, and `--cascade` extends it to every dependent Resource. Run [`dataos-ctl resource deps`](#dataos-ctl-resource-deps) first to review what depends on the target.
{% endhint %}

{% hint style="info" %}
Deleting a Resource depends on ownership, not on `runAsUser`. If you applied a Resource with `runAsUser` set to another user, you are still its owner and can delete it with this command, with no extra flag or grant required. Only an explicit `owner` field naming someone else changes who can delete it. See [RunAsUser permissions](https://v2.dataos.info/operate/access-control/roles-and-permissions/runasuser-permissions#what-does-it-enable) in Operate.
{% endhint %}

## dataos-ctl resource get

Get one Resource, or every Resource matching a filter.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource get \
  [-t ${{resource-type}}] [-n ${{resource-name}}] [-v ${{resource-version}}] \
  [--all] [--details]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource get -t service -n orders-api -v v1 --details
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                           | Description                                                                                                             | Type    | Required         |
| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------- | ------- | ---------------- |
| `-t`, `--type`                 | Type to query.                                                                                                          | string  | No               |
| `--types`                      | Multiple types to query.                                                                                                | strings | No               |
| `-n`, `--name`                 | Name to query.                                                                                                          | string  | No               |
| `-v`, `--version`              | Version to query.                                                                                                       | string  | No, default `v1` |
| `-a`, `--all`                  | Get Resources for every owner, not just the caller.                                                                     | boolean | No               |
| `-o`, `--owner`                | Get Resources for a specific owner ID.                                                                                  | string  | No               |
| `--tags`                       | Filter by a comma-separated list of tags.                                                                               | string  | No               |
| `--runnable`                   | Get only the primary runnable types: `service`, `worker`, `workflow`.                                                   | boolean | No               |
| `-d`, `--details`              | Include the full Resource manifest in the result.                                                                       | boolean | No               |
| `-i`, `--identifier`           | Resource identifier, as `TYPE:VERSION:NAME` or `NAME\|VERSION\|TYPE`.                                                   | string  | No               |
| `--id`                         | Resource ID, as `TYPE:VERSION:NAME`.                                                                                    | string  | No               |
| `-f`, `--manifestFile`         | Manifest file location.                                                                                                 | string  | No               |
| `-p`, `--activeProperties`     | Include active properties in specific columns of the result.                                                            | boolean | No               |
| `--dependencies`               | Include Resource dependencies in the result.                                                                            | boolean | No               |
| `-b`, `--buildResourceDetails` | Include build Resource details in the result.                                                                           | boolean | No               |
| `--errorDetails`               | Include error details in specific columns of the result.                                                                | boolean | No               |
| `--idDetails`, `--ids`         | Include ID details in specific columns of the result.                                                                   | boolean | No               |
| `--tagDetails`                 | Include tags in specific columns of the result.                                                                         | boolean | No               |
| `--workflowDetails`            | Include workflow details in specific columns of the result.                                                             | boolean | No               |
| `--unSanitize`                 | Include sensitive fields, unmasked, in the result. For use by the DataOS Operator (or an equivalent role) for RCA only. | boolean | No               |
| `-r`, `--refresh`              | Auto-refresh the result.                                                                                                | boolean | No               |
| `--refreshRate`                | Refresh interval in seconds.                                                                                            | int     | No, default `5`  |
| `-h`, `--help`                 | Display help for this command.                                                                                          | boolean | No               |

{% hint style="info" %}
`get` accepts the aliases `ls` and `list`. Sensitive fields such as API keys are masked by default.
{% endhint %}

{% hint style="warning" %}
`--unSanitize` reveals sensitive fields unmasked. It is intended to be used only by the DataOS Operator or an equivalent role, and only for root cause analysis (RCA) purposes. Do not use it for routine inspection, and do not share or store its output.
{% endhint %}

### Example

```bash
dataos-ctl resource get --all
```

```
              NAME               | VERSION |   TYPE    |  STATUS   |               RUNTIME                |     OWNER
---------------------------------+---------+-----------+-----------+--------------------------------------+---------------
 orders-api                      | v1      | service   | active    | running:1                             | jane.doe
 icebase                         | v1      | depot     | active    |                                        | jane.doe
 default-compute                 | v1      | compute   | active    |                                        | jane.doe
 sales-lakehouse                 | v1alpha | lakehouse | active    | rest-catalog:running:1                | jane.doe
                                 |         |           |           | sherpa-server:running:1               |
                                 |         |           |           | spark-cluster:running:1               |
```

Default columns are `NAME`, `VERSION`, `TYPE`, `STATUS`, `RUNTIME`, and `OWNER`. Resources with more than one container group, such as `lakehouse` or `service` stacks, print one `RUNTIME` line per container group under the same row.

## dataos-ctl resource get runtime

Get detailed runtime status for a single Resource: replica counts, conditions, and container groups.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource get runtime -t ${{resource-type}} -n ${{resource-name}} -v ${{resource-version}}
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource get runtime -t service -n orders-api -v v1
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                   | Description                                                           | Type    | Required                                              |
| ---------------------- | --------------------------------------------------------------------- | ------- | ----------------------------------------------------- |
| `-t`, `--type`         | Type of the Resource.                                                 | string  | See [Identifying a resource](#identifying-a-resource) |
| `-n`, `--name`         | Name of the Resource.                                                 | string  | See [Identifying a resource](#identifying-a-resource) |
| `-v`, `--version`      | Version of the Resource.                                              | string  | No, default `v1`                                      |
| `-i`, `--identifier`   | Resource identifier, as `TYPE:VERSION:NAME` or `NAME\|VERSION\|TYPE`. | string  | No                                                    |
| `--id`                 | Resource ID, as `TYPE:VERSION:NAME`.                                  | string  | No                                                    |
| `-f`, `--manifestFile` | Manifest file location.                                               | string  | No                                                    |
| `--container-group`    | Limit the result to one container group.                              | string  | No                                                    |
| `-d`, `--details`      | Include additional container group details.                           | boolean | No                                                    |
| `-y`, `--yaml`         | Print the full container group as YAML.                               | boolean | No                                                    |
| `-r`, `--refresh`      | Auto-refresh the result.                                              | boolean | No                                                    |
| `--refreshRate`        | Refresh interval in seconds.                                          | int     | No, default `5`                                       |
| `-h`, `--help`         | Display help for this command.                                        | boolean | No                                                    |

### Example

```bash
dataos-ctl resource get runtime -t service -n orders-api -v v1
```

```
    NAME    | VERSION |  TYPE   | TITLE |   STACK   |   OWNER
------------+---------+---------+-------+-----------+-----------
 orders-api | v1      | service |       | container | jane.doe


  RUNTIME  | READY REPLICAS COUNT | REPLICAS COUNT
-----------+----------------------+----------------
 running:1 | 1                    | 1


          REASON          |    TYPE     |                 MESSAGE
--------------------------+-------------+------------------------------------------
 MinimumReplicasAvailable | Available   | Deployment has minimum availability.
```

{% hint style="info" %}
**Enhanced runtime failure and scheduling error messages**

Enhanced CLI resource descriptions with granular runtime failure and scheduling error messages. Runtime diagnostics information such as container crashes, pod restart loops, and unscheduled pod failures (for example, insufficient CPU or memory) are now captured in `runtimeStatus` under `property["message"]`. This provides immediate visibility into failure root causes directly within the CLI rather than showing an opaque status.

No configuration changes are required; users can view these detailed error messages by running the resource describe command with the `-d` flag. This helps developers reduce the time it takes to identify runtime failures caused by the infrastructure layer.
{% endhint %}

{% hint style="info" %}
`dataos-ctl resource runtime get` (with the flag order reversed) is functionally identical to `dataos-ctl resource get runtime`.
{% endhint %}

## dataos-ctl resource deps

Get a Resource's inbound dependents and outbound dependencies.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource deps \
  -t ${{resource-type}} -n ${{resource-name}} -v ${{resource-version}} \
  [--inbound] [--outbound] [--filter-type ${{peer-type}}]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource deps -t service -n orders-api -v v1
```

{% endtab %}
{% endtabs %}

### Flags

| Flag              | Description                                                                | Type    | Required                                              |
| ----------------- | -------------------------------------------------------------------------- | ------- | ----------------------------------------------------- |
| `-t`, `--type`    | Type of the Resource.                                                      | string  | See [Identifying a resource](#identifying-a-resource) |
| `-n`, `--name`    | Name of the Resource.                                                      | string  | See [Identifying a resource](#identifying-a-resource) |
| `-v`, `--version` | Version of the Resource.                                                   | string  | No                                                    |
| `--inbound`       | Show only inbound dependents.                                              | boolean | No                                                    |
| `--outbound`      | Show only outbound dependencies.                                           | boolean | No                                                    |
| `--filter-type`   | Show only rows whose peer matches this Resource type, for example `depot`. | string  | No                                                    |
| `-h`, `--help`    | Display help for this command.                                             | boolean | No                                                    |

### Example

```bash
dataos-ctl resource deps -t service -n orders-api -v v1
```

```
Resource Dependencies
===================

Resource:

service:v1:orders-api

Dependencies (outbound)
-----------------------

        SOURCE          | RELATION |          TARGET
-------------------------+----------+---------------------------
 service:v1:orders-api   | direct   | compute:v1:default-compute
```

## dataos-ctl resource log

Get the logs for a Resource's container groups.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource log \
  -t ${{resource-type}} -n ${{resource-name}} -v ${{resource-version}} \
  [--tailLines ${{line-count}}] [--follow]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource log -t service -n orders-api -v v1 --tailLines 100
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                     | Description                                                    | Type    | Required                                              |
| ------------------------ | -------------------------------------------------------------- | ------- | ----------------------------------------------------- |
| `-t`, `--type`           | Type of the Resource.                                          | string  | See [Identifying a resource](#identifying-a-resource) |
| `-n`, `--name`           | Name of the Resource.                                          | string  | See [Identifying a resource](#identifying-a-resource) |
| `-v`, `--version`        | Version of the Resource.                                       | string  | No                                                    |
| `-c`, `--container`      | Filter logs by container name.                                 | string  | No                                                    |
| `--container-group`      | Filter logs by container group name.                           | string  | No                                                    |
| `--containerType`        | Filter logs by container type.                                 | string  | No                                                    |
| `-l`, `--tailLines`      | Number of tail lines to retrieve.                              | int     | No, default `40`                                      |
| `-f`, `--follow`         | Stream logs continuously.                                      | boolean | No                                                    |
| `--test-peer-connection` | Test the peer connection before following logs.                | boolean | No                                                    |
| `--tls-mode`             | TLS mode for the peer connection: `tls`, `mtls`, or `disable`. | string  | No, default `tls`                                     |
| `-h`, `--help`           | Display help for this command.                                 | boolean | No                                                    |

{% hint style="info" %}
`log` accepts the alias `logs`. `dataos-ctl resource runtime log` is functionally identical to `dataos-ctl resource log`.
{% endhint %}

### Example

```bash
dataos-ctl resource log -t service -n orders-api -v v1 --tailLines 10
```

```
            CONTAINER GROUP NAME            │           CONTAINER NAME           │ CONTAINER TYPE │ ERROR
─────────────────────────────────────────────┼─────────────────────────────────────┼────────────────┼───────
 d99e76e08e31f84187887da31bbf43e45c7627cb-0 │ orders-api                          │ primary        │

-------------------LOGS-------------------
2026-07-14 10:56:41 INFO orders-api-server client.py:236 request received
INFO:     10.0.5.13:48318 - "POST /orders-api/v1 HTTP/1.1" 200 OK
```

## dataos-ctl resource run

Create and run a Resource from a manifest file in one step, waiting for it to reach a success or failure state.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource run \
  -f ${{manifest-file-path}} \
  [--stream-logs] \
  [--run-timeout-duration ${{duration}}]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource run -f ./workflow.yaml --stream-logs
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                           | Description                                                       | Type     | Required                |
| ------------------------------ | ----------------------------------------------------------------- | -------- | ----------------------- |
| `-f`, `--manifestFile`         | Path to the manifest file.                                        | string   | Yes                     |
| `-c`, `--configFile`           | Path to a run-time config file, separate from the manifest.       | string   | No                      |
| `-n`, `--runName`              | Name for this run.                                                | string   | No                      |
| `--run-start-timeout-duration` | Timeout for the Resource to start running.                        | duration | No, default `2m0s`      |
| `--run-timeout-duration`       | Timeout for the run to complete.                                  | duration | No, default `5m0s`      |
| `--run-string`                 | Runtime string that indicates the Resource is running.            | string   | No, default `running`   |
| `--success-strings`            | Runtime strings that indicate the run succeeded.                  | strings  | No, default `succeeded` |
| `--failure-strings`            | Runtime strings that indicate the run failed.                     | strings  | No, default `failed`    |
| `--do-not-delete-on-success`   | Keep the Resource after a successful run instead of deleting it.  | boolean  | No                      |
| `--do-not-delete-on-failure`   | Keep the Resource after a failed run instead of deleting it.      | boolean  | No, default `true`      |
| `--stream-logs`                | Stream logs from the primary container group to stdout.           | boolean  | No                      |
| `--test-peer-connection`       | Test the peer connection before streaming logs.                   | boolean  | No                      |
| `--tls-mode`                   | TLS mode for the peer connection: `tls`, `mtls`, or `disable`.    | string   | No, default `tls`       |
| `--disable-interpolation`      | Do not interpolate `$ENV` or `${ENV}` references in the manifest. | boolean  | No                      |
| `-h`, `--help`                 | Display help for this command.                                    | boolean  | No                      |

## dataos-ctl resource runtime commands

The `runtime` subcommand group controls the lifecycle of runnable Resources: `service`, `worker`, and `workflow`, and dynamic Resources such as `vulcan` that run nested services, workers, or workflows. Each command below takes the same [resource-identifying flags](#identifying-a-resource) (`-t`/`-n`/`-v`, `--id`, `-i`/`--identifier`, or `-f`). For a dynamic Resource, also pass [`--sub-resource-id`](#dynamic-resources-and-sub-resource-id) to choose the nested workload.

| Command                               | Description                                                        |
| ------------------------------------- | ------------------------------------------------------------------ |
| `dataos-ctl resource runtime run`     | Trigger a run of an existing runnable Resource.                    |
| `dataos-ctl resource runtime re-run`  | Re-run a runnable Resource.                                        |
| `dataos-ctl resource runtime stop`    | Stop a running Resource.                                           |
| `dataos-ctl resource runtime pause`   | Pause a scheduled runnable Resource, such as a scheduled workflow. |
| `dataos-ctl resource runtime resume`  | Resume a paused runnable Resource.                                 |
| `dataos-ctl resource runtime suspend` | Suspend a runnable Resource.                                       |

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource runtime ${{action}} -t ${{resource-type}} -n ${{resource-name}} -v ${{resource-version}}
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource runtime stop -t service -n orders-api -v v1
```

{% endtab %}
{% endtabs %}

{% hint style="warning" %}
`dataos-ctl resource runtime run` triggers a run on an existing Resource. `dataos-ctl resource run` creates a new Resource from a manifest and runs it in one step. Use the one that matches your starting point.
{% endhint %}

### Supported actions by Resource type

| Resource type                                                                  | Supported actions                                                                                      |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `workflow`                                                                     | `stop`, `pause`, `resume`, `re-run`, `run`, `suspend` (`suspend` applies to scheduled workflows only)  |
| `service`                                                                      | `stop`, `resume`, `re-run`                                                                             |
| `worker`                                                                       | `stop`, `resume`, `re-run`                                                                             |
| Dynamic Resource, such as `vulcan`                                             | The actions of the nested `service`, `worker`, or `workflow` you target. Requires `--sub-resource-id`. |
| `secret`, `depot`, `volume`, `compute`, `policy`, and other non-runnable types | None                                                                                                   |

Runtime actions on `service`, `worker`, and dynamic Resources need `dataos-ctl` 3.24.0 or later. If a dynamic Resource is in `error`, every runtime action on its nested workloads is blocked until the error is fixed.

### Dynamic Resources and `--sub-resource-id`

| Flag                | Description                                                    | Type   | Required                   |
| ------------------- | -------------------------------------------------------------- | ------ | -------------------------- |
| `--sub-resource-id` | ID of the nested workload to act on inside a dynamic Resource. | string | Yes, for dynamic Resources |

For a Data Product, the sub-resource IDs are `vulcan-plan` (plan workflow), `vulcan-run` (scheduled run workflow), and `vulcan-api` (API service).

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource runtime ${{action}} -t ${{resource-type}} -n ${{resource-name}} -v ${{resource-version}} --sub-resource-id ${{sub-resource-id}}
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource runtime re-run -t vulcan -n orders-analytics -v v1alpha --sub-resource-id vulcan-plan
```

{% endtab %}
{% endtabs %}

### Order of actions and errors

Runtime actions depend on the workload's current state. Check it with `dataos-ctl resource get runtime` after each action.

| Error                                                               | Cause                                              | Fix                             |
| ------------------------------------------------------------------- | -------------------------------------------------- | ------------------------------- |
| `... does not support directive command '<action>'; supported: ...` | The action isn't supported for this Resource type. | Use one of the listed actions.  |
| `... is not stopped, cannot resume.`                                | `resume` was run on a workload that's running.     | Run `resume` only after `stop`. |
| `... resource is stopped, cannot re-run; resume first`              | `re-run` was run on a stopped workload.            | Run `resume`, then `re-run`.    |

## dataos-ctl resource tcp-stream

Open a local TCP tunnel to a Resource's service port.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource tcp-stream \
  -t ${{resource-type}} -n ${{resource-name}} \
  [--listenPort ${{local-port}}] [--servicePort ${{remote-port}}]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource tcp-stream -t service -n orders-api --listenPort 14040 --servicePort 4040
```

{% endtab %}
{% endtabs %}

### Flags

| Flag                     | Description                                                    | Type    | Required                                              |
| ------------------------ | -------------------------------------------------------------- | ------- | ----------------------------------------------------- |
| `-t`, `--type`           | Type of the Resource.                                          | string  | See [Identifying a resource](#identifying-a-resource) |
| `-n`, `--name`           | Name of the Resource.                                          | string  | See [Identifying a resource](#identifying-a-resource) |
| `-i`, `--identifier`     | Alternative single-flag targeting form.                        | string  | See [Identifying a resource](#identifying-a-resource) |
| `--dataplane`            | Dataplane the Resource runs on.                                | string  | No, default `hub`                                     |
| `--container-group`      | Container group to open the stream in.                         | string  | No                                                    |
| `--listenPort`           | Local port the client listens on.                              | int     | No, default `14040`                                   |
| `--servicePort`          | Remote service port to forward.                                | int     | No, default `4040`                                    |
| `--serviceSuffix`        | Override the default service name suffix.                      | string  | No, default `ui-svc`                                  |
| `--test-peer-connection` | Test the peer connection before opening the stream.            | boolean | No                                                    |
| `--tls-mode`             | TLS mode for the peer connection: `tls`, `mtls`, or `disable`. | string  | No, default `tls`                                     |
| `-h`, `--help`           | Display help for this command.                                 | boolean | No                                                    |

## dataos-ctl resource unquarantine

Unquarantine Resources in the current tenant.

### Syntax

{% tabs %}
{% tab title="Syntax" %}

```bash
dataos-ctl resource unquarantine [--ids ${{type:version:name}}] [--all]
```

{% endtab %}

{% tab title="Example" %}

```bash
dataos-ctl resource unquarantine --ids service:v1:orders-api
```

{% endtab %}
{% endtabs %}

### Flags

| Flag           | Description                                                                                                 | Type    | Required                |
| -------------- | ----------------------------------------------------------------------------------------------------------- | ------- | ----------------------- |
| `--ids`        | Resource IDs to unquarantine, each as `TYPE:VERSION:NAME`, `TYPE\|VERSION\|NAME`, or `NAME\|VERSION\|TYPE`. | strings | One of `--ids`, `--all` |
| `--all`        | Unquarantine all quarantined Resources in the current tenant.                                               | boolean | One of `--ids`, `--all` |
| `-h`, `--help` | Display help for this command.                                                                              | boolean | No                      |

{% hint style="info" %}
`unquarantine` accepts the Resource ID in any of the three formats above and validates that the Resource exists before proceeding.
{% endhint %}

{% hint style="info" %}
To unquarantine Resources while applying or updating a manifest, pass `--unquarantine` to `dataos-ctl resource apply` or `dataos-ctl resource update`.
{% endhint %}

## Validation rules

* Pass `-v`/`--version` explicitly for any Resource that is not `v1`; the flag defaults to `v1` even though many DataOS® Resources use `v1alpha` or `v2alpha`.
* `resource delete --cascade` also removes every Resource that depends on the target. Run `dataos-ctl resource deps` first to review the blast radius.
* `resource get --details` masks sensitive manifest fields, such as API keys, unless `--unSanitize` is also passed. `--unSanitize` is reserved for the DataOS Operator (or an equivalent role) for RCA purposes only.

## Related commands

* [Lakehouse commands](https://v2.dataos.info/references/interfaces/command-line-interface/lakehouse.md): manage tables inside a `lakehouse`-type Resource.
* Depot commands: discover the Depot types referenced in a Resource manifest.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://v2.dataos.info/references/interfaces/command-line-interface/resource.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
