--- title: "Read Workflow Configs" method: GET path: "/api/configs/workflow" tags: ["Config API"] --- # Read Workflow Configs `GET /api/configs/workflow` ## Request - The document declares no server URL. - Auth: none declared Read all the workflow configurations ## Response `200` Successful Response - WorkflowConfigOutput: Stores any workflow configs External Admins control - `workflow_data` DataConfig: Config for storing information about data. - `credential` union - StaticDataCredential: Static data credentials (i.e. credentials with access_key_id and access_key) for a data backend. - `endpoint` string, required: The OSMO storage URI for the data service (e.g., s3://bucket). For S3-compatible services with HTTP endpoints, set 'override_url' separately rather than pasting the full HTTPS URL here. - `region` string, nullable: The region for the data service - `override_url` string, nullable: HTTP service URL for S3-compatible providers (e.g., http://minio:9000, https://s3-compat.example.com). Leave unset for native AWS S3, GCS, Azure, etc. - `addressing_style` 'virtual' | 'path' | 'auto', nullable: S3 request addressing style for S3-compatible providers. Use 'virtual' for providers such as CoreWeave CAIOS that reject path-style requests, or 'path' for localstack/MinIO-style endpoints. - `access_key_id` string, required: The authentication key for a data backend - `access_key` string, password, required: The encrypted authentication secret for a data backend - DefaultDataCredential: Data credential that delegates resolution to the underlying SDK. Uses the SDK's default credential chain (e.g., Azure's DefaultAzureCredential, boto3's credential resolution) which may include environment variables, workload identity, instance metadata, and other provider-specific methods. Intentionally left empty as all credential resolution is handled by the SDK. - `endpoint` string, required: The OSMO storage URI for the data service (e.g., s3://bucket). For S3-compatible services with HTTP endpoints, set 'override_url' separately rather than pasting the full HTTPS URL here. - `region` string, nullable: The region for the data service - `override_url` string, nullable: HTTP service URL for S3-compatible providers (e.g., http://minio:9000, https://s3-compat.example.com). Leave unset for native AWS S3, GCS, Azure, etc. - `addressing_style` 'virtual' | 'path' | 'auto', nullable: S3 request addressing style for S3-compatible providers. Use 'virtual' for providers such as CoreWeave CAIOS that reject path-style requests, or 'path' for localstack/MinIO-style endpoints. - `base_url` string - `websocket_timeout` integer - `data_timeout` integer - `download_type` 'download': Type of Config to fetch or set - `workflow_log` LogConfig: Config for storing information about data. - `credential` union - StaticDataCredential: Static data credentials (i.e. credentials with access_key_id and access_key) for a data backend. - `endpoint` string, required: The OSMO storage URI for the data service (e.g., s3://bucket). For S3-compatible services with HTTP endpoints, set 'override_url' separately rather than pasting the full HTTPS URL here. - `region` string, nullable: The region for the data service - `override_url` string, nullable: HTTP service URL for S3-compatible providers (e.g., http://minio:9000, https://s3-compat.example.com). Leave unset for native AWS S3, GCS, Azure, etc. - `addressing_style` 'virtual' | 'path' | 'auto', nullable: S3 request addressing style for S3-compatible providers. Use 'virtual' for providers such as CoreWeave CAIOS that reject path-style requests, or 'path' for localstack/MinIO-style endpoints. - `access_key_id` string, required: The authentication key for a data backend - `access_key` string, password, required: The encrypted authentication secret for a data backend - DefaultDataCredential: Data credential that delegates resolution to the underlying SDK. Uses the SDK's default credential chain (e.g., Azure's DefaultAzureCredential, boto3's credential resolution) which may include environment variables, workload identity, instance metadata, and other provider-specific methods. Intentionally left empty as all credential resolution is handled by the SDK. - `endpoint` string, required: The OSMO storage URI for the data service (e.g., s3://bucket). For S3-compatible services with HTTP endpoints, set 'override_url' separately rather than pasting the full HTTPS URL here. - `region` string, nullable: The region for the data service - `override_url` string, nullable: HTTP service URL for S3-compatible providers (e.g., http://minio:9000, https://s3-compat.example.com). Leave unset for native AWS S3, GCS, Azure, etc. - `addressing_style` 'virtual' | 'path' | 'auto', nullable: S3 request addressing style for S3-compatible providers. Use 'virtual' for providers such as CoreWeave CAIOS that reject path-style requests, or 'path' for localstack/MinIO-style endpoints. - `workflow_app` LogConfig: Config for storing information about data. - `credential` union - StaticDataCredential: Static data credentials (i.e. credentials with access_key_id and access_key) for a data backend. - `endpoint` string, required: The OSMO storage URI for the data service (e.g., s3://bucket). For S3-compatible services with HTTP endpoints, set 'override_url' separately rather than pasting the full HTTPS URL here. - `region` string, nullable: The region for the data service - `override_url` string, nullable: HTTP service URL for S3-compatible providers (e.g., http://minio:9000, https://s3-compat.example.com). Leave unset for native AWS S3, GCS, Azure, etc. - `addressing_style` 'virtual' | 'path' | 'auto', nullable: S3 request addressing style for S3-compatible providers. Use 'virtual' for providers such as CoreWeave CAIOS that reject path-style requests, or 'path' for localstack/MinIO-style endpoints. - `access_key_id` string, required: The authentication key for a data backend - `access_key` string, password, required: The encrypted authentication secret for a data backend - DefaultDataCredential: Data credential that delegates resolution to the underlying SDK. Uses the SDK's default credential chain (e.g., Azure's DefaultAzureCredential, boto3's credential resolution) which may include environment variables, workload identity, instance metadata, and other provider-specific methods. Intentionally left empty as all credential resolution is handled by the SDK. - `endpoint` string, required: The OSMO storage URI for the data service (e.g., s3://bucket). For S3-compatible services with HTTP endpoints, set 'override_url' separately rather than pasting the full HTTPS URL here. - `region` string, nullable: The region for the data service - `override_url` string, nullable: HTTP service URL for S3-compatible providers (e.g., http://minio:9000, https://s3-compat.example.com). Leave unset for native AWS S3, GCS, Azure, etc. - `addressing_style` 'virtual' | 'path' | 'auto', nullable: S3 request addressing style for S3-compatible providers. Use 'virtual' for providers such as CoreWeave CAIOS that reject path-style requests, or 'path' for localstack/MinIO-style endpoints. - `workflow_info` WorkflowInfo: Config for workflow storage info. - `tags` string[] - `max_name_length` integer - `backend_images` OsmoImageConfig: Dynamic Config for storing the image URLs for service images and the credentials needed to pull them. - `init` string - `client` string - `credential` RegistryCredential: Authentication information for a Docker registry. - `registry` string: The Docker registry URL - `username` string: The username for the Docker registry - `auth` string, password: The authentication token (raw password) for the Docker registry - `workflow_alerts` NotificationConfig - `slack_token` string, password - `smtp_settings` SMTPConfig - `host` string - `sender` string - `password` string, password - `credential_config` CredentialConfig: Stores registries/data which do not do validation - `disable_registry_validation` string[] - `disable_data_validation` string[] - `user_workflow_limits` UserWorkflowLimitConfig: Stores workflow limits per user. Default is None, which means no limit. If a limit is set, it must be greater than 0. - `max_num_workflows` integer, nullable - `max_num_tasks` integer, nullable - `jinja_sandbox_workers` integer - `jinja_sandbox_max_time` number - `jinja_sandbox_memory_limit` integer - `plugins_config` PluginsConfigOutput: Stores any plugins configs - `rsync` RsyncConfig: Stores all configs for rsync - `enabled` boolean - `enable_telemetry` boolean - `read_bandwidth_limit` integer: User pod's rsync read bandwidth limit in bytes per second, zero means no limit - `write_bandwidth_limit` integer: User pod's rsync write bandwidth limit in bytes per second, zero means no limit - `allowed_paths` object - `daemon_debounce_delay` number: Daemon debounce delay for rsync in seconds - `daemon_poll_interval` number: Daemon poll interval for rsync in seconds - `daemon_reconcile_interval` number: Daemon reconcile interval for rsync in seconds - `client_upload_rate_limit` integer: Client upload rate limit for rsync in bytes per second, zero means no limit - `labels_config` LabelsConfigOutput: Curated workflow label policy; empty by default, so no policy applies until configured. - `policy` LabelPolicy[] - `key` string, required - `allow_list` string[] - `enforcement` 'off' | 'warn' | 'enforce': Per-key policy strictness: 'off' skips checking, 'warn' surfaces missing or unlisted values as submission warnings, and 'enforce' rejects them. - `assert_message` string - `pod_label_prefix` string - `max_num_tasks` integer - `max_num_ports_per_task` integer - `max_retry_per_task` integer - `max_retry_per_job` integer - `default_schedule_timeout` integer - `default_exec_timeout` string - `default_queue_timeout` string - `max_exec_timeout` string - `max_queue_timeout` string - `force_cleanup_delay` string - `max_log_lines` integer - `max_task_log_lines` integer - `max_error_log_lines` integer - `max_event_log_lines` integer - `task_heartbeat_frequency` string ## Changes - **2026-08-05** `44a82bab7387`: 2 info - added the optional property `labels_config/pod_label_prefix` to the response with the `200` status - the `labels_config` response's property default value changed from `{"policy":[]}` to `{"policy":[],"pod_label_prefix":""}` for the status `200` - **2026-08-03** `b9d312a13f5d`: 1 info - added the optional property `labels_config` to the response with the `200` status - **2026-05-11** `4a5778cf4e28`: 6 info - added the optional property `workflow_app/credential/anyOf[subschema #1: StaticDataCredential]/addressing_style` to the response with the `200` status - added the optional property `workflow_data/credential/anyOf[subschema #1: StaticDataCredential]/addressing_style` to the response with the `200` status - added the optional property `workflow_log/credential/anyOf[subschema #1: StaticDataCredential]/addressing_style` to the response with the `200` status - added `#/components/schemas/DefaultDataCredential` to the `workflow_app/credential` response property `anyOf` list for the response status `200` - …2 more - …earlier changes not shown [Operation history](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/changes/api/configs/workflow/get.md) --- [API](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api.md) - [All operations](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nvidia/apis/nvidia-corporation-osmo-api/revisions/845585a71dbb?raw)