{"id":2454,"library":"dagster-cloud","title":"Dagster Cloud","description":"Dagster Cloud is a fully-managed cloud platform for Dagster, providing hosted orchestration, development tools, and operations dashboards. The `dagster-cloud` Python library offers a client to interact with the Dagster Cloud API programmatically, manage deployments, and configure agents. It is currently at version 1.13.0 and follows the Dagster core library's release cadence, typically releasing new versions monthly.","status":"active","version":"1.13.0","language":"en","source_language":"en","source_url":"https://github.com/dagster-io/dagster-cloud","tags":["orchestration","cloud","data-pipeline","etl","dagster"],"install":[{"cmd":"pip install dagster-cloud","lang":"bash","label":"Install dagster-cloud"}],"dependencies":[{"reason":"Provides core Dagster functionality; dagster-cloud builds on and extends it for cloud deployments.","package":"dagster"}],"imports":[{"symbol":"DagsterCloudClient","correct":"from dagster_cloud.client import DagsterCloudClient"},{"note":"The definition location changed with version 1.x to be more explicit about cloud-specific definitions.","wrong":"from dagster_cloud.definitions import DagsterCloudCodeLocation","symbol":"DagsterCloudCodeLocation","correct":"from dagster_cloud.dagster_cloud_definitions import DagsterCloudCodeLocation"}],"quickstart":{"code":"import os\nfrom dagster_cloud.client import DagsterCloudClient\n\n# Ensure these environment variables are set:\n# DAGSTER_CLOUD_ORGANIZATION_ID\n# DAGSTER_CLOUD_API_TOKEN\n\norganization_id = os.environ.get('DAGSTER_CLOUD_ORGANIZATION_ID', 'your_org_id_here')\napi_token = os.environ.get('DAGSTER_CLOUD_API_TOKEN', 'your_api_token_here')\n\nif not organization_id or not api_token:\n    print(\"Error: DAGSTER_CLOUD_ORGANIZATION_ID and DAGSTER_CLOUD_API_TOKEN must be set.\")\n    exit(1)\n\ntry:\n    client = DagsterCloudClient(\n        organization_id=organization_id,\n        api_token=api_token\n    )\n    \n    # Example: List available workspaces\n    workspaces = client.get_workspaces()\n    print(f\"Found {len(workspaces)} workspaces in Dagster Cloud:\")\n    for ws in workspaces:\n        print(f\"- {ws.name} (ID: {ws.id})\")\n        \nexcept Exception as e:\n    print(f\"An error occurred: {e}\")","lang":"python","description":"This quickstart demonstrates how to initialize the `DagsterCloudClient` and use it to interact with your Dagster Cloud organization. It retrieves and prints the names of all available workspaces. Ensure `DAGSTER_CLOUD_ORGANIZATION_ID` and `DAGSTER_CLOUD_API_TOKEN` environment variables are set for authentication."},"warnings":[{"fix":"Set `DAGSTER_CLOUD_ORGANIZATION_ID` and `DAGSTER_CLOUD_API_TOKEN` in your environment. API tokens can be generated in the Dagster Cloud UI.","message":"Authentication to Dagster Cloud requires setting `DAGSTER_CLOUD_ORGANIZATION_ID` and `DAGSTER_CLOUD_API_TOKEN` environment variables. Without these, client initialization will fail or lead to unauthorized access errors.","severity":"gotcha","affected_versions":"All versions"},{"fix":"Always install `dagster` and `dagster-cloud` within the same major version range. Refer to the official Dagster documentation for version compatibility guidelines.","message":"The `dagster-cloud` library must be compatible with the core `dagster` library. Significant version mismatches (e.g., pre-1.0 `dagster` with 1.x `dagster-cloud`) can lead to import errors, runtime exceptions, or unexpected behavior due to API changes and data model evolution.","severity":"breaking","affected_versions":"All versions, particularly across major `dagster` versions (e.g., 0.x to 1.x)"},{"fix":"Regularly review the Dagster Cloud deployment documentation and ensure your deployment configuration and `dagster-cloud` CLI usage align with the recommended patterns for your chosen deployment model.","message":"Changes to deployment models (e.g., agent-based, hybrid, serverless) often require updates to `dagster-cloud` configuration or even CLI commands. Relying on outdated deployment patterns with newer `dagster-cloud` versions can lead to deployment failures or inefficiencies.","severity":"gotcha","affected_versions":"Versions 0.x through 1.x, particularly around features like serverless deployments."}],"env_vars":null,"last_verified":"2026-04-10T00:00:00.000Z","next_check":"2026-07-09T00:00:00.000Z"}