dg api reference

dg api

Make REST-like API calls to Dagster Plus.

dg api [OPTIONS] COMMAND [ARGS]...

agent

Manage agents in Dagster Plus.

dg api agent [OPTIONS] COMMAND [ARGS]...

get

Get detailed information about a specific agent.

dg api agent get [OPTIONS] AGENT_ID

Example:

$ dg api agent get c0b1ab17-1d2e-4f5b-9c8a-3e8d2c5f7a91
Label:          analytics-prod-1
ID:             c0b1ab17-1d2e-4f5b-9c8a-3e8d2c5f7a91
Status:         RUNNING
Last Heartbeat: 2026-05-06 18:42:11 UTC

Metadata:
  version: 1.12.0
  dagster_cloud_version: 1.12.0

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

AGENT_ID: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List all agents in the organization.

dg api agent list [OPTIONS]

Example:

$ dg api agent list
LABEL              ID                                    STATUS   LAST HEARTBEAT
analytics-prod-1   c0b1ab17-1d2e-4f5b-9c8a-3e8d2c5f7a91  RUNNING  2026-05-06 18:42:11 UTC
ingest-prod        7e2c44b9-8f1a-4d6e-b0c3-2a5f9d4e6b18  RUNNING  2026-05-06 18:42:08 UTC
Agent ad9c7f2e     ad9c7f2e-3b15-4a87-9d61-5c8b3e2f1a04  STOPPED  2026-05-05 22:17:35 UTC

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

alert-policy

Manage alert policies in Dagster Plus.

dg api alert-policy [OPTIONS] COMMAND [ARGS]...

list

List alert policies for a deployment.

dg api alert-policy list [OPTIONS]

Example:

$ dg api alert-policy list
alert_policies:
- name: failed_run_alert
  description: Alert on failed runs
  enabled: true
  alert_targets:
  - email_target:
      email_addresses:
      - oncall@example.com
  event_types:
  - JOB_FAILURE
- name: long_running_alert
  description: Alert when runs exceed 1 hour
  enabled: true
  alert_targets:
  - slack_target:
      channel: '#data-alerts'
  event_types:
  - JOB_LONG_RUNNING

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

sync

Sync alert policies from a YAML file.

dg api alert-policy sync [OPTIONS] FILE_PATH

Example:

$ dg api alert-policy sync alert_policies.yaml
Synced alert policies: failed_run_alert, long_running_alert

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

FILE_PATH: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

artifact

Upload and download artifacts in Dagster Plus.

dg api artifact [OPTIONS] COMMAND [ARGS]...

download

Download an artifact from Dagster Plus.

KEY is the artifact key (e.g. “my-model/latest”). PATH is the local file path to save to.

dg api artifact download [OPTIONS] KEY PATH

Example:

$ dg api artifact download my-model/latest ./model.pkl --deployment prod
Downloaded artifact 'my-model/latest' from deployment 'prod' to model.pkl.

Options:

--deployment <deployment>: Deployment name for deployment-scoped artifacts. If omitted, artifact is organization-scoped.

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

KEY: Required argument

PATH: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

upload

Upload an artifact to Dagster Plus.

KEY is the artifact key (e.g. “my-model/latest”). PATH is the local file path to upload.

dg api artifact upload [OPTIONS] KEY PATH

Example:

$ dg api artifact upload my-model/latest ./model.pkl --deployment prod
Uploaded artifact 'my-model/latest' to deployment 'prod'.

Options:

--deployment <deployment>: Deployment name for deployment-scoped artifacts. If omitted, artifact is organization-scoped.

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

KEY: Required argument

PATH: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

asset

Manage assets in Dagster Plus.

dg api asset [OPTIONS] COMMAND [ARGS]...

get

Get specific asset details.

dg api asset get [OPTIONS] ASSET_KEY

Example:

$ dg api asset get dim_customers
Asset Key: dim_customers
ID: 7e4c8b2a-1f3d-4e6b-9c5a-8d2f1e3b4c7d
Description: Customer dimension table
Group: marts
Kinds: dbt, snowflake
Deps: stg_customers

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ASSET_KEY: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-evaluations

Get automation condition evaluation records for an asset.

Evaluations are only recorded when at least one subcondition has a different value than the previous evaluation.

dg api asset get-evaluations [OPTIONS] ASSET_KEY

Example:

$ dg api asset get-evaluations dim_customers --limit 2
EVAL ID  TIMESTAMP                NUM REQUESTED  RUN IDS
4218     2026-05-06 18:00:00 UTC  1              5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
4196     2026-05-05 18:00:00 UTC  1              2a1f7b3c-9d8e-4c5b-8a6d-3f1e2b9c4d7a

Options:

--limit <limit>: Max evaluations to return (default: 50, max: 1000)

--cursor <cursor>: Cursor for pagination (evaluation ID)

--include-nodes: Include the condition evaluation node tree (verbose)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ASSET_KEY: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-events

Get materialization and observation events for an asset.

dg api asset get-events [OPTIONS] ASSET_KEY

Example:

$ dg api asset get-events dim_customers --limit 3
TIMESTAMP                LEVEL  TYPE                    RUN ID                                PARTITION
2026-05-06 18:00:12 UTC  INFO   ASSET_MATERIALIZATION   5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
2026-05-05 18:00:08 UTC  INFO   ASSET_MATERIALIZATION   2a1f7b3c-9d8e-4c5b-8a6d-3f1e2b9c4d7a
2026-05-04 18:00:15 UTC  INFO   ASSET_MATERIALIZATION   8c4d2e7f-1a9b-4e3d-7c5b-9f2a1d8e3b6c

Options:

--event-type <event_type>

Filter by event type (default: both)

Options: ASSET_MATERIALIZATION | ASSET_OBSERVATION

--limit <limit>: Max events to return (default: 50, max: 1000)

--before <before>: Events before this ISO timestamp (e.g. 2024-01-15T00:00:00)

--partition <partitions>: Filter by partition key (repeatable)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ASSET_KEY: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-health

Get health and runtime status for an asset.

dg api asset get-health [OPTIONS] ASSET_KEY

Example:

$ dg api asset get-health dim_customers
Asset Key: dim_customers

Asset Health: HEALTHY
Materialization Status: MATERIALIZED
Freshness Status: PASSING
Asset Checks Status: PASSED
Last Materialized: 2026-05-06 18:00:12 UTC
Latest Materialization: 2026-05-06 18:00:12 UTC
Latest Run ID: 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Total Checks: 3
Failed Checks: 0
Warning Checks: 0

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ASSET_KEY: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-partition-status

Get partition materialization stats for an asset.

dg api asset get-partition-status [OPTIONS] ASSET_KEY

Example:

$ dg api asset get-partition-status daily_orders
Materialized: 364
Failed:       1
In Progress:  0
Total:        365

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ASSET_KEY: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List assets with pagination.

dg api asset list [OPTIONS]

Example:

$ dg api asset list
ASSET KEY        GROUP      DESCRIPTION                        KINDS
raw_customers    ingestion  Customer records from Snowflake    snowflake
stg_customers    staging    Cleaned customer records           dbt, snowflake
dim_customers    marts      Customer dimension table           dbt, snowflake
daily_orders     marts      Daily order aggregates             dbt, snowflake

Options:

--limit <limit>: Number of assets to return (default: 50, max: 1000)

--cursor <cursor>: Cursor for pagination

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

asset-check

Manage asset checks in Dagster Plus.

dg api asset-check [OPTIONS] COMMAND [ARGS]...

get-executions

Get execution history for an asset check.

dg api asset-check get-executions [OPTIONS]

Example:

$ dg api asset-check get-executions --asset-key dim_customers --check-name not_null --limit 3
STATUS    RUN_ID                                TIMESTAMP                PARTITION
SUCCEEDED 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a  2026-05-06 18:00:14 UTC
SUCCEEDED 2a1f7b3c-9d8e-4c5b-8a6d-3f1e2b9c4d7a  2026-05-05 18:00:09 UTC
FAILED    8c4d2e7f-1a9b-4e3d-7c5b-9f2a1d8e3b6c  2026-05-04 18:00:16 UTC

Options:

--asset-key <asset_key>: Required Slash-separated asset key (e.g., my/asset)

--check-name <check_name>: Required Name of the asset check

--limit <limit>: Maximum number of executions to return (default: 25)

--cursor <cursor>: Pagination cursor

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List asset checks for an asset.

dg api asset-check list [OPTIONS]

Example:

$ dg api asset-check list --asset-key dim_customers
NAME                BLOCKING  DESCRIPTION
not_null            Yes       Customer ID must not be null
unique_customer_id  Yes       Customer ID must be unique
valid_email         No        Email must match RFC 5322

Options:

--asset-key <asset_key>: Required Slash-separated asset key (e.g., my/asset)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

code-location

Manage code locations in Dagster Plus.

dg api code-location [OPTIONS] COMMAND [ARGS]...

add

Add or update a code location in the deployment.

dg api code-location add [OPTIONS] LOCATION_NAME

Example:

$ dg api code-location add ingestion --image dagster/ingestion:1.12.0 --module-name ingestion.definitions
Added or updated code location 'ingestion'.

Options:

--image <image>: Docker image for the code location

-m, --module-name <module_name>: Python module name

-p, --package-name <package_name>: Python package name

-f, --python-file <python_file>: Python file path

-w, --working-directory <working_directory>: Working directory

--executable-path <executable_path>: Python executable path

-a, --attribute <attribute>: Attribute to load definitions from

--commit-hash <commit_hash>: Git commit hash

--git-url <git_url>: Git repository URL

--location-file, --from <location_file>: YAML file with location configuration

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

LOCATION_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

delete

Delete a code location from the deployment.

dg api code-location delete [OPTIONS] LOCATION_NAME

Example:

$ dg api code-location delete ingestion
Deleted code location 'ingestion'.

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

LOCATION_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get

Get detailed information about a specific code location.

dg api code-location get [OPTIONS] LOCATION_NAME

Example:

$ dg api code-location get ingestion
Name:   ingestion
Image:  dagster/ingestion:1.12.0
Module: ingestion.definitions

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

LOCATION_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List code locations in the deployment.

dg api code-location list [OPTIONS]

Example:

$ dg api code-location list
NAME       IMAGE                       STATUS
ingestion  dagster/ingestion:1.12.0    LOADED
analytics  dagster/analytics:1.12.0    LOADED
marts      dagster/marts:1.11.5        LOAD_ERROR

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

deployment

Manage deployments in Dagster Plus.

dg api deployment [OPTIONS] COMMAND [ARGS]...

delete

Delete a deployment by name.

dg api deployment delete [OPTIONS] NAME

Example:

$ dg api deployment delete pr-123-feature-branch
Name: pr-123-feature-branch
ID:   42
Type: BRANCH

Options:

--allow-delete-full-deployment: Allow deleting a production (full) deployment

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

NAME: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get

Show detailed information about a specific deployment.

dg api deployment get [OPTIONS] NAME

Example:

$ dg api deployment get prod
Name: prod
ID:   1
Type: PRODUCTION

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

NAME: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List deployments in the organization.

dg api deployment list [OPTIONS]

Example:

$ dg api deployment list
NAME     ID  TYPE
prod     1   PRODUCTION
staging  2   PRODUCTION

Options:

--json: Output in JSON format for machine readability

--type <deployment_type>

Type of deployments to list (default: production)

Options: production | branch | all

--pr-status <pr_status>

Filter branch deployments by pull request status (only applies with –type branch or all)

Options: OPEN | CLOSED | MERGED

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

settings

Manage deployment settings.

dg api deployment settings [OPTIONS] COMMAND [ARGS]...

get

Get settings for a deployment.

dg api deployment settings get [OPTIONS]

Example:

$ dg api deployment settings get
run_queue:
  max_concurrent_runs: 10
  tag_concurrency_limits: []
run_retries:
  max_retries: 3
sso_default_role: VIEWER

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

set

Set deployment settings from a YAML file.

dg api deployment settings set [OPTIONS] FILE_PATH

Example:

$ dg api deployment settings set deployment-settings.yaml
run_queue:
  max_concurrent_runs: 25
  tag_concurrency_limits: []
run_retries:
  max_retries: 3
sso_default_role: VIEWER

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

FILE_PATH: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

issue

Manage issues in Dagster Plus.

dg api issue [OPTIONS] COMMAND [ARGS]...

add-link

Add a run or asset link to an issue.

dg api issue add-link [OPTIONS] ISSUE_ID

Example:

$ dg api issue add-link 7e2c44b9-8f1a-4d6e-b0c3-2a5f9d4e6b18 --run-id 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Title:       Snowflake load failed for daily_orders
Status:      OPEN
Created By:  oncall@example.com
Run IDs:     5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Description: Snowflake permission denied while loading partition 2026-05-06

Options:

--run-id <run_id>: Run ID to link to the issue

--asset-key <asset_key>: Asset key to link to the issue (slash-separated path, e.g. ‘my/asset’)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ISSUE_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

create

Create a new issue.

dg api issue create [OPTIONS]

Example:

$ dg api issue create --title "Snowflake load failed" --description "Permission denied loading daily_orders"
Title:       Snowflake load failed
Status:      OPEN
Created By:  oncall@example.com
Description: Permission denied loading daily_orders

Options:

--title <title>: Required Title of the issue

--description <description>: Required Description of the issue

--status <status>

Status of the issue. Defaults to ‘OPEN’

Options: OPEN | CLOSED | TRIAGE | CANCELED

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get

Get an issue by ID.

dg api issue get [OPTIONS] ISSUE_ID

Example:

$ dg api issue get 7e2c44b9-8f1a-4d6e-b0c3-2a5f9d4e6b18
Title:       Snowflake load failed for daily_orders
Status:      OPEN
Created By:  oncall@example.com
Run IDs:     5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Asset Keys:  daily_orders
Description: Snowflake permission denied while loading partition 2026-05-06

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ISSUE_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List issues with pagination and optional filtering.

dg api issue list [OPTIONS]

Example:

$ dg api issue list --limit 3 --status OPEN
STATUS  TITLE                                       ID                                    CREATED BY
OPEN    Snowflake load failed for daily_orders      7e2c44b9-8f1a-4d6e-b0c3-2a5f9d4e6b18  oncall@example.com
OPEN    Stale freshness on stg_customers            ad9c7f2e-3b15-4a87-9d61-5c8b3e2f1a04  alice@example.com
OPEN    dbt test failure: unique_customer_id        c0b1ab17-1d2e-4f5b-9c8a-3e8d2c5f7a91  bob@example.com

Options:

--limit <limit>: Number of issues to return (default: 10)

--cursor <cursor>: Cursor for pagination

--status <statuses>

Filter by issue status. Repeatable.

Options: OPEN | CLOSED | TRIAGE | CANCELED

--created-after <created_after>: Filter issues created after this date (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)

--created-before <created_before>: Filter issues created before this date (YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

remove-link

Remove a run or asset link from an issue.

dg api issue remove-link [OPTIONS] ISSUE_ID

Example:

$ dg api issue remove-link 7e2c44b9-8f1a-4d6e-b0c3-2a5f9d4e6b18 --run-id 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Title:       Snowflake load failed for daily_orders
Status:      OPEN
Created By:  oncall@example.com
Description: Snowflake permission denied while loading partition 2026-05-06

Options:

--run-id <run_id>: Run ID to unlink from the issue

--asset-key <asset_key>: Asset key to unlink from the issue (slash-separated path, e.g. ‘my/asset’)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ISSUE_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

update

Update an existing issue.

dg api issue update [OPTIONS] ISSUE_ID

Example:

$ dg api issue update 7e2c44b9-8f1a-4d6e-b0c3-2a5f9d4e6b18 --status RESOLVED
Title:       Snowflake load failed for daily_orders
Status:      RESOLVED
Created By:  oncall@example.com
Description: Snowflake permission denied while loading partition 2026-05-06

Options:

--status <status>

New status for the issue

Options: OPEN | CLOSED | TRIAGE | CANCELED

--title <title>: New title for the issue

--description <description>: New description for the issue

--context <context>: Additional context for the issue

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

ISSUE_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

job

Manage jobs in Dagster Plus.

dg api job [OPTIONS] COMMAND [ARGS]...

get

Get specific job details.

dg api job get [OPTIONS] JOB_NAME

Example:

$ dg api job get ingest_customers
Name:        ingest_customers
Description: Daily customer ingest
Asset Job:   No
Tags:        team=data-platform
Schedule:    daily_customer_ingest (0 6 * * *) [RUNNING]

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

JOB_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List jobs in the deployment.

dg api job list [OPTIONS]

Example:

$ dg api job list
NAME                          DESCRIPTION              SCHEDULES  SENSORS  ASSET JOB
__ASSET_JOB                                            1          0        Yes
ingest_customers              Daily customer ingest    1          0        No
retrain_recommendation_model  Weekly model retrain     0          1        No

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

organization

Manage organization in Dagster Plus.

dg api organization [OPTIONS] COMMAND [ARGS]...

saml

Manage SAML SSO configuration.

dg api organization saml [OPTIONS] COMMAND [ARGS]...

remove

Remove identity provider SAML metadata to disable SSO.

dg api organization saml remove [OPTIONS]

Example:

$ dg api organization saml remove
The identity provider metadata was successfully removed.

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

upload

Upload identity provider SAML metadata to enable SSO.

dg api organization saml upload [OPTIONS] METADATA_FILE_PATH

Example:

$ dg api organization saml upload idp-metadata.xml
The identity provider metadata was successfully uploaded.

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

METADATA_FILE_PATH: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

settings

Manage organization settings.

dg api organization settings [OPTIONS] COMMAND [ARGS]...

get

Get settings for the organization.

dg api organization settings get [OPTIONS]

Example:

$ dg api organization settings get
sso_default_role: VIEWER
domain_allowlist:
- example.com

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

set

Set organization settings from a YAML file.

dg api organization settings set [OPTIONS] FILE_PATH

Example:

$ dg api organization settings set organization-settings.yaml
sso_default_role: EDITOR
domain_allowlist:
- example.com

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

FILE_PATH: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

run

Manage runs in Dagster Plus.

dg api run [OPTIONS] COMMAND [ARGS]...

get

Get run metadata by ID.

dg api run get [OPTIONS] RUN_ID

Example:

$ dg api run get 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Run ID:   5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
Status:   SUCCESS
Created:  2026-05-06 18:00:12 UTC
Started:  2026-05-06 18:00:14 UTC
Ended:    2026-05-06 18:04:42 UTC
Pipeline: ingest_customers

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

RUN_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-events

Get execution log events for a specific run ID.

dg api run get-events [OPTIONS] RUN_ID

Example:

$ dg api run get-events 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a --limit 4
Logs for run 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a:

TIMESTAMP            LEVEL    STEP_KEY                  MESSAGE
--------------------------------------------------------------------------------
2026-05-06 18:00:14  INFO                               Started execution of run for "ingest_customers".
2026-05-06 18:00:14  INFO     ingest_files              Started execution of step "ingest_files".
2026-05-06 18:04:40  INFO     ingest_files              Finished execution of step "ingest_files" in 4m26s.
2026-05-06 18:04:42  INFO                               Finished execution of run for "ingest_customers".

Total log entries: 4

Options:

--level <levels>: Filter by log level (DEBUG, INFO, WARNING, ERROR, CRITICAL). Repeatable.

--event-type <event_types>: Filter by event type (e.g. STEP_FAILURE, RUN_START). Repeatable.

--step <step_keys>: Filter by step key (partial matching). Repeatable.

--limit <limit>: Maximum number of log entries to return

--cursor <after_cursor>: Pagination cursor for retrieving more logs

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

RUN_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-logs

Get stdout/stderr compute logs for a specific run.

dg api run get-logs [OPTIONS] RUN_ID

Example:

$ dg api run get-logs 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a --step-key ingest_files
Compute logs for run 5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a:

--- ingest_files [ingest_files] ---
STDOUT:
Loading 1,432 rows into raw_customers
Done.
STDERR:
(no errors)

Total steps with logs: 1

Options:

--step-key <step_key>: Filter to a specific step

--link-only: Return download URLs instead of log content

--max-bytes <max_bytes>: Maximum bytes of log content per step

--cursor <cursor>: Cursor for paginating log content

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

RUN_ID: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List runs with optional filtering and pagination.

dg api run list [OPTIONS]

Example:

$ dg api run list --limit 3
ID                                    STATUS    JOB                CREATED
5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a  SUCCESS   ingest_customers   2026-05-06 18:00:12 UTC
2a1f7b3c-9d8e-4c5b-8a6d-3f1e2b9c4d7a  SUCCESS   ingest_customers   2026-05-05 18:00:08 UTC
8c4d2e7f-1a9b-4e3d-7c5b-9f2a1d8e3b6c  FAILURE   ingest_customers   2026-05-04 18:00:15 UTC

Options:

--limit <limit>: Number of runs to return (default: 50, max: 1000)

--cursor <cursor>: Cursor for pagination (run ID)

--status <statuses>

Filter by run status. Repeatable.

--job <job_name>: Filter by job name

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

schedule

Manage schedules in Dagster Plus.

dg api schedule [OPTIONS] COMMAND [ARGS]...

get

Get specific schedule details.

dg api schedule get [OPTIONS] SCHEDULE_NAME

Example:

$ dg api schedule get daily_customer_ingest
Name:          daily_customer_ingest
Status:        RUNNING
Cron Schedule: 0 6 * * *
Pipeline:      ingest_customers
Description:   Daily customer ingest at 06:00 UTC
Timezone:      UTC
Next Tick:     2026-05-07 06:00:00 UTC

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

SCHEDULE_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-ticks

Get tick history for a specific schedule.

dg api schedule get-ticks [OPTIONS] SCHEDULE_NAME

Example:

$ dg api schedule get-ticks daily_customer_ingest --limit 3
TIMESTAMP                STATUS    RUN IDS                               SKIP REASON
2026-05-06 06:00:00 UTC  SUCCESS   5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
2026-05-05 06:00:00 UTC  SUCCESS   2a1f7b3c-9d8e-4c5b-8a6d-3f1e2b9c4d7a
2026-05-04 06:00:00 UTC  FAILURE   8c4d2e7f-1a9b-4e3d-7c5b-9f2a1d8e3b6c

Total ticks: 3

Options:

--status <statuses>

Filter by tick status. Repeatable.

Options: STARTED | SKIPPED | SUCCESS | FAILURE

--limit <limit>: Maximum number of ticks to return

--cursor <cursor>: Pagination cursor

--before <before_timestamp>: Filter ticks before this Unix timestamp

--after <after_timestamp>: Filter ticks after this Unix timestamp

--json: Output in JSON format

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

SCHEDULE_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List schedules in the deployment.

dg api schedule list [OPTIONS]

Example:

$ dg api schedule list
NAME                       STATUS   CRON           PIPELINE
daily_customer_ingest      RUNNING  0 6 * * *      ingest_customers
hourly_event_aggregation   RUNNING  0 * * * *      aggregate_events
weekly_model_retrain       STOPPED  0 9 * * MON    retrain_recommendation_model

Options:

--status <status>

Filter schedules by status

Options: RUNNING | STOPPED

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

secret

Manage secrets in Dagster Plus.

Secrets are environment variables that are encrypted and securely stored in Dagster Plus. They can be scoped to different deployment levels and code locations.

Security Note: Secret values are hidden by default. Use appropriate flags and caution when displaying sensitive values.

dg api secret [OPTIONS] COMMAND [ARGS]...

get

Get details for a specific secret.

By default, the secret value is not shown for security reasons. Use –show-value flag to display the actual secret value.

WARNING: When using –show-value, the secret will be visible in your terminal and may be stored in shell history. Use with caution.

dg api secret get [OPTIONS] SECRET_NAME

Example:

$ dg api secret get SNOWFLAKE_USER
Name: SNOWFLAKE_USER
Locations: All code locations
Scopes: Full Deployment, All Branch Deployments, Local Deployment
Permissions:
  Can Edit: Yes
  Can View Value: Yes

Value: <hidden - use --show-value to display>

Updated By: colton@dagsterlabs.com
Updated: 2023-05-04 19:14:15 UTC

Options:

--location <location>: Filter by code location name

--show-value: Include secret value in output (use with caution - values will be visible in terminal)

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

SECRET_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List secrets in the organization.

By default, secret values are not shown for security reasons. Use ‘dg api secret get NAME –show-value’ to view specific values.

dg api secret list [OPTIONS]

Example:

$ dg api secret list
NAME                LOCATIONS  SCOPES                                                     UPDATED
SNOWFLAKE_USER      All        Full Deployment, All Branch Deployments, Local Deployment  2023-05-04 19:14:15 UTC
SNOWFLAKE_PASSWORD  All        Full Deployment, All Branch Deployments, Local Deployment  2023-11-29 22:38:48 UTC
DATABRICKS_TOKEN    All        Full Deployment, Local Deployment                          2025-07-25 23:52:00 UTC
GITHUB_TOKEN        analytics  Full Deployment                                            2025-08-11 18:19:12 UTC

Options:

--location <location>: Filter secrets by code location name

--scope <scope>

Filter secrets by scope

Options: deployment | organization

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

sensor

Manage sensors in Dagster Plus.

dg api sensor [OPTIONS] COMMAND [ARGS]...

get

Get specific sensor details.

dg api sensor get [OPTIONS] SENSOR_NAME

Example:

$ dg api sensor get new_file_sensor
Name:        new_file_sensor
Status:      RUNNING
Type:        STANDARD
Description: Triggers ingest_customers when a new file lands in S3
Next Tick:   2026-05-06 18:43:00 UTC

Options:

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

SENSOR_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

get-ticks

Get tick history for a specific sensor.

dg api sensor get-ticks [OPTIONS] SENSOR_NAME

Example:

$ dg api sensor get-ticks new_file_sensor --limit 3
TIMESTAMP                STATUS    RUN IDS                               SKIP REASON
2026-05-06 18:42:00 UTC  SUCCESS   5b3c8a91-2e4f-4d7b-9c6a-1f8d3e5b2c4a
2026-05-06 18:41:30 UTC  SKIPPED   -                                     No new files in s3://incoming/customers/
2026-05-06 18:41:00 UTC  SKIPPED   -                                     No new files in s3://incoming/customers/

Total ticks: 3

Options:

--status <statuses>

Filter by tick status. Repeatable.

Options: STARTED | SKIPPED | SUCCESS | FAILURE

--limit <limit>: Maximum number of ticks to return

--cursor <cursor>: Pagination cursor

--before <before_timestamp>: Filter ticks before this Unix timestamp

--after <after_timestamp>: Filter ticks after this Unix timestamp

--json: Output in JSON format

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Arguments:

SENSOR_NAME: Required argument

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

list

List sensors in the deployment.

dg api sensor list [OPTIONS]

Example:

$ dg api sensor list
NAME                         STATUS   TYPE
new_file_sensor              RUNNING  STANDARD
slack_alert_sensor           RUNNING  RUN_STATUS
retrain_trigger_sensor       STOPPED  ASSET

Options:

--status <status>

Filter sensors by status

Options: RUNNING | STOPPED

--json: Output in JSON format for machine readability

--response-schema: Print the JSON Schema of the response model and exit.

-d, --deployment <deployment>: Deployment to target.

-o, --organization <organization>: Organization to target.

--api-token <api_token>: Dagster Cloud API token.

--view-graphql: Print GraphQL queries and responses to stderr for debugging.

Environment variables:

DAGSTER_CLOUD_DEPLOYMENT: Provide a default for --deployment

DAGSTER_CLOUD_ORGANIZATION: Provide a default for --organization

DAGSTER_CLOUD_API_TOKEN: Provide a default for --api-token

dg api​

agent​

get​

list​

alert-policy​

list​

sync​

artifact​

download​

upload​

asset​

get​

get-evaluations​

get-events​

get-health​

get-partition-status​

list​

asset-check​

get-executions​

list​

code-location​

add​

delete​

get​

list​

deployment​

delete​

get​

list​

settings​

get​

set​

issue​

add-link​

create​

get​

list​

remove-link​

update​

job​

get​

list​

organization​

saml​

remove​

upload​

settings​

get​

set​

run​

get​

get-events​

get-logs​

list​

schedule​

get​

get-ticks​

list​

secret​

get​

list​

sensor​

get​

get-ticks​

list​

dg api

agent

get

list

alert-policy

list

sync

artifact

download

upload

asset

get

get-evaluations

get-events

get-health

get-partition-status

list

asset-check

get-executions

list

code-location

add

delete

get

list

deployment

delete

get

list

settings

get

set

issue

add-link

create

get

list

remove-link

update

job

get

list

organization

saml

remove

upload

settings

get

set

run

get

get-events

get-logs

list

schedule

get

get-ticks

list

secret

get

list

sensor

get

get-ticks

list