saturn-api
The API for Saturn Cloud.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 2026.02.01
- Package version: 1.0.0
- Generator version: 7.22.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.10+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)
Then import the package:
import saturn_api
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install to install the package for all users)
Then import the package:
import saturn_api
Tests
Execute pytest to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import saturn_api
from saturn_api.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to the SATURN_BASE_URL env or http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = saturn_api.Configuration(
host = os.getenv("SATURN_BASE_URL", "http://localhost")
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization: bearerAuth, defaults to the SATURN_TOKEN env
configuration = saturn_api.Configuration(
access_token = os.environ["SATURN_TOKEN"]
)
# Enter a context with an instance of the API client
async with saturn_api.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = saturn_api.ActiveApi(api_client)
name = 'name_example' # str |
cluster = 'cluster_example' # str | (optional)
try:
# Get pod runtime summary
api_response = await api_instance.get_pod(name, cluster=cluster)
print("The response of ActiveApi->get_pod:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling ActiveApi->get_pod: %s\n" % e)
Documentation for API Endpoints
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| ActiveApi | get_pod | GET /api/active/pods/{name} | Get pod runtime summary |
| ActiveApi | get_pod_logs | GET /api/active/pods/{name}/logs | Get pod logs |
| ActiveApi | list_pods | GET /api/active/pods | List pod runtime summaries |
| ActiveApi | list_resources | GET /api/active/resources | List active resources |
| ApiStatusApi | get | GET /api/status | Get API status |
| ApiTokensApi | create | POST /api/tokens | Create api token |
| ApiTokensApi | delete | DELETE /api/tokens/{api_token_id} | Delete api token |
| ApiTokensApi | get | GET /api/tokens/{api_token_id} | Get api token |
| ApiTokensApi | list | GET /api/tokens | List api tokens |
| ApiTokensApi | update | PATCH /api/tokens/{api_token_id} | Update api token |
| ArtifactsApi | create | POST /api/orgs/{org_id}/artifacts | Create artifact |
| ArtifactsApi | delete | DELETE /api/orgs/{org_id}/artifacts/{artifact_id} | Delete artifact |
| ArtifactsApi | get | GET /api/orgs/{org_id}/artifacts/{artifact_id} | Get artifact |
| ArtifactsApi | list | GET /api/orgs/{org_id}/artifacts | List artifacts |
| ArtifactsApi | update | PATCH /api/orgs/{org_id}/artifacts/{artifact_id} | Update artifact |
| AuthorizationApi | create_oauth_token | POST /api/auth/token | Create OAuth token |
| AuthorizationApi | get_oauth_init | GET /api/auth/token | Initialize oauth |
| AuthorizationApi | login | POST /api/auth/login | Login |
| AuthorizationApi | logout | GET /api/auth/logout | Logout |
| ClustersApi | create | POST /api/clusters | Create cluster |
| ClustersApi | delete | DELETE /api/clusters/{cluster_id} | Delete cluster |
| ClustersApi | get | GET /api/clusters/{cluster_id} | Get cluster |
| ClustersApi | list | GET /api/clusters | List clusters |
| ClustersApi | update | PATCH /api/clusters/{cluster_id} | Update cluster |
| CurrentUserApi | delete | DELETE /api/user | Delete current user |
| CurrentUserApi | get | GET /api/user | Get current user |
| CurrentUserApi | get_aggregated_usage | GET /api/user/usage/aggregated | Get aggregated usage |
| CurrentUserApi | get_preferences | GET /api/user/preferences | Get current user preferences |
| CurrentUserApi | list_owners | GET /api/user/owners | List current user owners across orgs |
| CurrentUserApi | list_owners_0 | GET /api/users/{user_id}/owners | List user owners across orgs |
| CurrentUserApi | update | PATCH /api/user | Update current user |
| CurrentUserApi | update_preferences | PATCH /api/user/preferences | Update current user preferences |
| DaskClustersApi | adapt | POST /api/dask_clusters/{dask_cluster_id}/adapt | Set dask cluster adaptive scaling |
| DaskClustersApi | create | POST /api/dask_clusters | Create dask cluster |
| DaskClustersApi | delete | DELETE /api/dask_clusters/{dask_cluster_id} | Delete dask cluster |
| DaskClustersApi | get | GET /api/dask_clusters/{dask_cluster_id} | Get dask cluster |
| DaskClustersApi | get_info | GET /api/dask_clusters/{dask_cluster_id}/info | Get dask cluster info |
| DaskClustersApi | get_kubecluster_runtime_summary | GET /api/dask_clusters/{dask_cluster_id}/kubecluster/runtimesummary | Get dask cluster kubecluster runtime summary |
| DaskClustersApi | get_logs | GET /api/dask_clusters/{dask_cluster_id}/logs | Get dask cluster historical logs |
| DaskClustersApi | get_metrics | GET /api/dask_clusters/{dask_cluster_id}/metrics | Get dask cluster metrics |
| DaskClustersApi | get_pod_history | GET /api/dask_clusters/{dask_cluster_id}/history | Get dask cluster pod history |
| DaskClustersApi | get_runtime_summary | GET /api/dask_clusters/{dask_cluster_id}/runtimesummary | Get dask cluster runtime summary |
| DaskClustersApi | get_scheduler_info | GET /api/dask_clusters/{dask_cluster_id}/scheduler_info | Get dask cluster scheduler info |
| DaskClustersApi | get_scheduler_runtimesummary | GET /api/dask_clusters/{dask_cluster_id}/scheduler/runtimesummary | Get dask cluster scheduler runtime summary |
| DaskClustersApi | get_scheduler_status | GET /api/dask_clusters/{dask_cluster_id}/status | Get dask cluster scheduler status |
| DaskClustersApi | get_server_options | GET /api/dask_clusters/info | Get dask cluster server options |
| DaskClustersApi | get_token_info | GET /api/dask_clusters/{dask_cluster_id}/token | Get dask cluster API token info |
| DaskClustersApi | list | GET /api/dask_clusters | List dask clusters |
| DaskClustersApi | list_worker_runtime_summaries | GET /api/dask_clusters/{dask_cluster_id}/workers/runtimesummary | List dask cluster worker runtime summaries |
| DaskClustersApi | restart | POST /api/dask_clusters/{dask_cluster_id}/restart | Restart dask cluster |
| DaskClustersApi | rotate_token | POST /api/dask_clusters/{dask_cluster_id}/token | Rotate dask cluster API token |
| DaskClustersApi | scale | POST /api/dask_clusters/{dask_cluster_id}/scale | Scale dask cluster worker count |
| DaskClustersApi | start | POST /api/dask_clusters/{dask_cluster_id}/start | Start dask cluster |
| DaskClustersApi | stop | POST /api/dask_clusters/{dask_cluster_id}/stop | Stop dask cluster |
| DaskClustersApi | update | PATCH /api/dask_clusters/{dask_cluster_id} | Update dask cluster |
| DaskClustersApi | update_token | PATCH /api/dask_clusters/{dask_cluster_id}/token | Update dask cluster API token |
| DatasetsApi | call_import | POST /api/orgs/{org_id}/token-factory/datasets/import | Import dataset |
| DatasetsApi | create | POST /api/orgs/{org_id}/token-factory/datasets | Create dataset |
| DatasetsApi | delete | DELETE /api/orgs/{org_id}/token-factory/datasets/{dataset_id} | Delete dataset |
| DatasetsApi | get | GET /api/orgs/{org_id}/token-factory/datasets/{dataset_id} | Get dataset |
| DatasetsApi | list | GET /api/orgs/{org_id}/token-factory/datasets | List datasets |
| DatasetsApi | lock | POST /api/orgs/{org_id}/token-factory/datasets/lock | Lock shared folder as dataset |
| DatasetsApi | seal | POST /api/orgs/{org_id}/token-factory/datasets/{dataset_id}/seal | Seal dataset |
| DeploymentsApi | create | POST /api/deployments | Create deployment |
| DeploymentsApi | create_resource_template | POST /api/deployments/{deployment_id}/template | Create deployment resource template |
| DeploymentsApi | create_route | POST /api/deployments/{deployment_id}/routes | Create deployment route |
| DeploymentsApi | create_secret_attachment | POST /api/deployments/{deployment_id}/secrets | Create deployment secret attachment |
| DeploymentsApi | create_service_account_attachment | PUT /api/deployments/{deployment_id}/service_account | Create deployment service account attachment |
| DeploymentsApi | create_viewer | POST /api/deployments/{deployment_id}/viewers | Create deployment viewer |
| DeploymentsApi | delete | DELETE /api/deployments/{deployment_id} | Delete deployment |
| DeploymentsApi | delete_route | DELETE /api/deployments/{deployment_id}/routes/{route_id} | Delete deployment route |
| DeploymentsApi | delete_secret_attachment | DELETE /api/deployments/{deployment_id}/secrets/{secret_attachment_id} | Delete deployment secret attachment |
| DeploymentsApi | delete_service_account_attachment | DELETE /api/deployments/{deployment_id}/service_account | Delete deployment service account attachment |
| DeploymentsApi | delete_viewer | DELETE /api/deployments/{deployment_id}/viewers/{viewer_id} | Delete deployment viewer |
| DeploymentsApi | get | GET /api/deployments/{deployment_id} | Get deployment |
| DeploymentsApi | get_cluster_history | GET /api/deployments/{deployment_id}/clusters | Get deployment cluster history |
| DeploymentsApi | get_logs | GET /api/deployments/{deployment_id}/logs | Get deployment historical logs |
| DeploymentsApi | get_metrics | GET /api/deployments/{deployment_id}/metrics | Get deployment metrics |
| DeploymentsApi | get_pod_history | GET /api/deployments/{deployment_id}/history | Get deployment pod history |
| DeploymentsApi | get_recipe | GET /api/deployments/{deployment_id}/recipe | Get deployment recipe |
| DeploymentsApi | get_resource_template | GET /api/deployments/{deployment_id}/template | Get deployment resource template |
| DeploymentsApi | get_route | GET /api/deployments/{deployment_id}/routes/{route_id} | Get deployment route |
| DeploymentsApi | get_runtime_summary | GET /api/deployments/{deployment_id}/runtimesummary | Get deployment runtime summary |
| DeploymentsApi | get_secret_attachment | GET /api/deployments/{deployment_id}/secrets/{secret_attachment_id} | Get deployment secret attachment |
| DeploymentsApi | get_server_options | GET /api/deployments/info | Get deployment server options |
| DeploymentsApi | get_service_account_attachment | GET /api/deployments/{deployment_id}/service_account | Get deployment service account attachment |
| DeploymentsApi | list | GET /api/deployments | List deployments |
| DeploymentsApi | list_routes | GET /api/deployments/{deployment_id}/routes | List deployment routes |
| DeploymentsApi | list_secret_attachments | GET /api/deployments/{deployment_id}/secrets | List deployment secret attachments |
| DeploymentsApi | list_viewers | GET /api/deployments/{deployment_id}/viewers | List deployment viewers |
| DeploymentsApi | restart | POST /api/deployments/{deployment_id}/restart | Restart deployment |
| DeploymentsApi | start | POST /api/deployments/{deployment_id}/start | Start deployment |
| DeploymentsApi | stop | POST /api/deployments/{deployment_id}/stop | Stop deployment |
| DeploymentsApi | update | PATCH /api/deployments/{deployment_id} | Update deployment |
| DeploymentsApi | update_resource_template | PATCH /api/deployments/{deployment_id}/template | Update deployment resource template |
| DeploymentsApi | update_route | PATCH /api/deployments/{deployment_id}/routes/{route_id} | Update deployment route |
| DeploymentsApi | update_secret_attachment | PATCH /api/deployments/{deployment_id}/secrets/{secret_attachment_id} | Update deployment secret attachment |
| ExternalRepoAttachmentsApi | create | POST /api/external_repo_attachments | Create external repo attachment |
| ExternalRepoAttachmentsApi | delete | DELETE /api/external_repo_attachments/{external_repo_attachment_id} | Delete external repo attachment |
| ExternalRepoAttachmentsApi | get | GET /api/external_repo_attachments/{external_repo_attachment_id} | Get external repo attachment |
| ExternalRepoAttachmentsApi | list | GET /api/external_repo_attachments | List external repo attachments |
| ExternalRepoAttachmentsApi | update | PATCH /api/external_repo_attachments/{external_repo_attachment_id} | Update external repo attachment |
| ExternalReposApi | create | POST /api/external_repos | Create external repo |
| ExternalReposApi | delete | DELETE /api/external_repos/{external_repo_id} | Delete external repo |
| ExternalReposApi | get | GET /api/external_repos/{external_repo_id} | Get external repo |
| ExternalReposApi | list | GET /api/external_repos | List external repos |
| ExternalReposApi | update | PATCH /api/external_repos/{external_repo_id} | Update external repo |
| FineTuningJobsApi | create | POST /api/orgs/{org_id}/token-factory/fine-tuning/jobs | Create fine-tuning job |
| FineTuningJobsApi | get | GET /api/orgs/{org_id}/token-factory/fine-tuning/jobs/{job_id} | Get fine-tuning job |
| FineTuningJobsApi | get_logs | GET /api/orgs/{org_id}/token-factory/fine-tuning/jobs/{job_id}/logs | Get fine-tuning job historical logs |
| FineTuningJobsApi | jobs_cancel | POST /api/orgs/{org_id}/token-factory/fine-tuning/jobs/{job_id}/cancel | Cancel fine-tuning job |
| FineTuningJobsApi | list | GET /api/orgs/{org_id}/token-factory/fine-tuning/jobs | List fine-tuning jobs |
| GroupsApi | create | POST /api/groups | Create group |
| GroupsApi | create_member | POST /api/groups/{group_id}/members | Create group member |
| GroupsApi | delete | DELETE /api/groups/{group_id} | Delete group |
| GroupsApi | delete_member | DELETE /api/groups/{group_id}/members | Delete group member |
| GroupsApi | get | GET /api/groups/{group_id} | Get group |
| GroupsApi | get_daily_usage | GET /api/groups/{group_id}/usage/daily | Get group daily usage |
| GroupsApi | list | GET /api/groups | List groups |
| GroupsApi | list_members | GET /api/groups/{group_id}/members | List group members |
| GroupsApi | update | PATCH /api/groups/{group_id} | Update group |
| ImageTagsApi | create | POST /api/images/{image_id}/tags | Create image tag |
| ImageTagsApi | delete | DELETE /api/images/{image_id}/tags/{image_tag_id} | Delete image tag |
| ImageTagsApi | get | GET /api/images/{image_id}/tags/{image_tag_id} | Get image tag |
| ImageTagsApi | get_logs | GET /api/images/{image_id}/tags/{image_tag_id}/logs | Get image tag historical logs |
| ImageTagsApi | get_runtime_summary | GET /api/images/{image_id}/tags/{image_tag_id}/runtimesummary | Get image tag build runtime summary |
| ImageTagsApi | get_status_history | GET /api/images/{image_id}/tags/{image_tag_id}/history | Get image tag status history |
| ImageTagsApi | list | GET /api/images/{image_id}/tags | List image tags |
| ImageTagsApi | stop | POST /api/images/{image_id}/tags/{image_tag_id}/stop | Stop image tag build |
| ImageTagsApi | update | PATCH /api/images/{image_id}/tags/{image_tag_id} | Update image tag |
| ImagesApi | create | POST /api/images | Create image |
| ImagesApi | delete | DELETE /api/images/{image_id} | Delete image |
| ImagesApi | get | GET /api/images/{image_id} | Get image |
| ImagesApi | list | GET /api/images | List images |
| ImagesApi | update | PATCH /api/images/{image_id} | Update image |
| InferenceEndpointsApi | create | POST /api/orgs/{org_id}/token-factory/inference-endpoints | Create inference endpoint |
| InferenceEndpointsApi | delete | DELETE /api/orgs/{org_id}/token-factory/inference-endpoints/{endpoint_id} | Delete inference endpoint |
| InferenceEndpointsApi | endpoints_start | POST /api/orgs/{org_id}/token-factory/inference-endpoints/{endpoint_id}/start | Start inference endpoint |
| InferenceEndpointsApi | endpoints_stop | POST /api/orgs/{org_id}/token-factory/inference-endpoints/{endpoint_id}/stop | Stop inference endpoint |
| InferenceEndpointsApi | get | GET /api/orgs/{org_id}/token-factory/inference-endpoints/{endpoint_id} | Get inference endpoint |
| InferenceEndpointsApi | get_logs | GET /api/orgs/{org_id}/token-factory/inference-endpoints/{endpoint_id}/logs | Get inference endpoint historical logs |
| InferenceEndpointsApi | list | GET /api/orgs/{org_id}/token-factory/inference-endpoints | List inference endpoints |
| InfoApi | get | GET /api/info | Get app info |
| InfoApi | get_server_options | GET /api/info/servers | Get server options |
| InvitationsApi | create | POST /api/invitations | Create invitation |
| InvitationsApi | delete | DELETE /api/invitations/{invitation_id} | Delete invitation |
| InvitationsApi | get | GET /api/invitations/{invitation_id} | Get invitation |
| InvitationsApi | list | GET /api/invitations | List invitations |
| InvitationsApi | update | PATCH /api/invitations/{invitation_id} | Update invitation |
| JobsApi | create | POST /api/jobs | Create job |
| JobsApi | create_resource_template | POST /api/jobs/{job_id}/template | Create job resource template |
| JobsApi | create_secret_attachment | POST /api/jobs/{job_id}/secrets | Create job secret attachment |
| JobsApi | create_service_account_attachment | PUT /api/jobs/{job_id}/service_account | Create job service account attachment |
| JobsApi | delete | DELETE /api/jobs/{job_id} | Delete job |
| JobsApi | delete_secret_attachment | DELETE /api/jobs/{job_id}/secrets/{secret_attachment_id} | Delete job secret attachment |
| JobsApi | delete_service_account_attachment | DELETE /api/jobs/{job_id}/service_account | Delete job service account attachment |
| JobsApi | get | GET /api/jobs/{job_id} | Get job |
| JobsApi | get_cluster_history | GET /api/jobs/{job_id}/clusters | Get job cluster history |
| JobsApi | get_logs | GET /api/jobs/{job_id}/logs | Get job historical logs |
| JobsApi | get_metrics | GET /api/jobs/{job_id}/metrics | Get job metrics |
| JobsApi | get_pod_history | GET /api/jobs/{job_id}/history | Get job pod history |
| JobsApi | get_recipe | GET /api/jobs/{job_id}/recipe | Get job recipe |
| JobsApi | get_resource_template | GET /api/jobs/{job_id}/template | Get job resource template |
| JobsApi | get_secret_attachment | GET /api/jobs/{job_id}/secrets/{secret_attachment_id} | Get job secret attachment |
| JobsApi | get_server_options | GET /api/jobs/info | Get job server options |
| JobsApi | get_service_account_attachment | GET /api/jobs/{job_id}/service_account | Get job service account attachment |
| JobsApi | get_token_info | GET /api/jobs/{job_id}/token | Get job API token info |
| JobsApi | list | GET /api/jobs | List jobs |
| JobsApi | list_runtime_summaries | GET /api/jobs/{job_id}/runtimesummary | List job runtime summaries |
| JobsApi | list_secret_attachments | GET /api/jobs/{job_id}/secrets | List job secret attachments |
| JobsApi | restart | POST /api/jobs/{job_id}/restart | Restart job |
| JobsApi | rotate_token | POST /api/jobs/{job_id}/token | Rotate job API token |
| JobsApi | schedule | POST /api/jobs/{job_id}/schedule | Activate job cron schedule |
| JobsApi | start | POST /api/jobs/{job_id}/start | Start job |
| JobsApi | stop | POST /api/jobs/{job_id}/stop | Stop job |
| JobsApi | stop_run | POST /api/jobs/{job_id}/stop/{run_name} | Stop job run |
| JobsApi | unschedule | POST /api/jobs/{job_id}/unschedule | Deactivate job cron schedule |
| JobsApi | update | PATCH /api/jobs/{job_id} | Update job |
| JobsApi | update_resource_template | PATCH /api/jobs/{job_id}/template | Update job resource template |
| JobsApi | update_secret_attachment | PATCH /api/jobs/{job_id}/secrets/{secret_attachment_id} | Update job secret attachment |
| JobsApi | update_token | PATCH /api/jobs/{job_id}/token | Update job API token |
| LimitsApi | create | POST /api/limits | Create limits |
| LimitsApi | delete | DELETE /api/limits/{limits_id} | Delete limits |
| LimitsApi | get | GET /api/limits/{limits_id} | Get limits |
| LimitsApi | list | GET /api/limits | List limits |
| LimitsApi | update | PATCH /api/limits/{limits_id} | Update limits |
| NotificationsApi | acknowledge | PUT /api/notifications | Acknowledge notifications |
| NotificationsApi | delete | DELETE /api/notifications | Delete notifications |
| NotificationsApi | list | GET /api/notifications | List notifications |
| NotificationsApi | list_subscriptions | GET /api/notifications/subscriptions | List notification subscriptions |
| NotificationsApi | subscribe | PUT /api/notifications/subscriptions | Subscribe to topic |
| NotificationsApi | unsubscribe | DELETE /api/notifications/subscriptions | Unsubscribe from topic |
| ObjectStorageApi | cancel_upload | DELETE /api/object_storage/upload/{object_storage_upload_id} | Cancel object storage upload |
| ObjectStorageApi | complete_upload | POST /api/object_storage/upload/{object_storage_upload_id} | Complete object storage upload |
| ObjectStorageApi | delete | DELETE /api/object_storage/delete | Delete object storage |
| ObjectStorageApi | delete_bulk | DELETE /api/object_storage/bulk_delete | Delete multiple object storage |
| ObjectStorageApi | download | POST /api/object_storage/download | Download object storage |
| ObjectStorageApi | download_bulk | POST /api/object_storage/bulk_download | Download bulk object storage |
| ObjectStorageApi | get_usage | GET /api/object_storage/usage | Get object storage usage stats |
| ObjectStorageApi | list | GET /api/object_storage | List object storage |
| ObjectStorageApi | list_shared | GET /api/object_storage/shared | List shared object storage |
| ObjectStorageApi | list_uploads | GET /api/object_storage/upload | List object storage uploads |
| ObjectStorageApi | resume_upload | GET /api/object_storage/upload/{object_storage_upload_id} | Resume object storage upload |
| ObjectStorageApi | upload | POST /api/object_storage/upload | Create object storage upload |
| OrgsApi | accept_invitation | POST /api/orgs/invitation/{token}/accept | Accept org invitation |
| OrgsApi | create | POST /api/orgs | Create org |
| OrgsApi | create_invitation | POST /api/orgs/{org_id}/invitations | Create org invitation |
| OrgsApi | create_member | POST /api/orgs/{org_id}/members | Create org member |
| OrgsApi | decline_invitation | DELETE /api/orgs/invitation/{token}/decline | Decline org invitation |
| OrgsApi | delete | DELETE /api/orgs/{org_id} | Delete org |
| OrgsApi | delete_invitation | DELETE /api/orgs/{org_id}/invitations/{invitation_id} | Delete org invitation |
| OrgsApi | delete_member | DELETE /api/orgs/{org_id}/members/{user_id} | Delete org member |
| OrgsApi | get | GET /api/orgs/{org_id} | Get org |
| OrgsApi | get_aggregated_usage | GET /api/orgs/{org_id}/usage/aggregated | Get org usage |
| OrgsApi | get_daily_usage | GET /api/orgs/{org_id}/usage/daily | Get org daily usage |
| OrgsApi | get_daily_user_usage | GET /api/orgs/{org_id}/members/{user_id}/usage/daily | Get org member daily usage |
| OrgsApi | get_invitation | GET /api/orgs/{org_id}/invitations/{invitation_id} | Get org invitation |
| OrgsApi | get_member | GET /api/orgs/{org_id}/members/{user_id} | Get org member |
| OrgsApi | get_owner_usage | GET /api/orgs/{org_id}/usage/owners | Get org owner usage |
| OrgsApi | get_usage_limits | GET /api/orgs/{org_id}/limits | Get org usage limits |
| OrgsApi | list | GET /api/orgs | List orgs |
| OrgsApi | list_invitations | GET /api/orgs/{org_id}/invitations | List org invitations |
| OrgsApi | list_owners | GET /api/orgs/{org_id}/owners | List org owners |
| OrgsApi | update | PATCH /api/orgs/{org_id} | Update org |
| OrgsApi | update_invitation | PATCH /api/orgs/{org_id}/invitations/{invitation_id} | Update org invitation |
| OrgsApi | update_member | PATCH /api/orgs/{org_id}/members/{user_id} | Update org member |
| RecipesApi | apply | PUT /api/recipes | Apply recipe |
| RecipesApi | create | POST /api/recipes | Create recipe |
| RecipesApi | get | GET /api/recipes/{recipe_type}/{name} | Get recipe |
| RecipesApi | list | GET /api/recipes | List recipes |
| SecretsApi | create | POST /api/secrets | Create secret |
| SecretsApi | delete | DELETE /api/secrets/{secret_id} | Delete secret |
| SecretsApi | get | GET /api/secrets/{secret_id} | Get secret |
| SecretsApi | list | GET /api/secrets | List secrets |
| SecretsApi | update | PATCH /api/secrets/{secret_id} | Update secret |
| ServiceAccountEntitlementsApi | create | POST /api/service_account_entitlements | Create service account entitlement |
| ServiceAccountEntitlementsApi | delete | DELETE /api/service_account_entitlements/{service_account_entitlement_id} | Delete service account entitlement |
| ServiceAccountEntitlementsApi | get | GET /api/service_account_entitlements/{service_account_entitlement_id} | Get service account entitlement |
| ServiceAccountEntitlementsApi | list | GET /api/service_account_entitlements | List service account entitlements |
| ServiceAccountsApi | create | POST /api/service_accounts | Create service account |
| ServiceAccountsApi | delete | DELETE /api/service_accounts/{service_account_id} | Delete service account |
| ServiceAccountsApi | get | GET /api/service_accounts/{service_account_id} | Get service account |
| ServiceAccountsApi | list | GET /api/service_accounts | List service accounts |
| ServiceAccountsApi | update | PATCH /api/service_accounts/{service_account_id} | Update service account |
| SharedFolderAttachmentsApi | create | POST /api/shared_folder_attachments | Create shared folder attachment |
| SharedFolderAttachmentsApi | delete | DELETE /api/shared_folder_attachments/{shared_folder_attachment_id} | Delete shared folder attachment |
| SharedFolderAttachmentsApi | get | GET /api/shared_folder_attachments/{shared_folder_attachment_id} | Get shared folder attachment |
| SharedFolderAttachmentsApi | list | GET /api/shared_folder_attachments | List shared folder attachments |
| SharedFolderAttachmentsApi | update | PATCH /api/shared_folder_attachments/{shared_folder_attachment_id} | Update shared folder attachment |
| SharedFoldersApi | create | POST /api/shared_folders | Create shared folder |
| SharedFoldersApi | delete | DELETE /api/shared_folders/{shared_folder_id} | Delete shared folder |
| SharedFoldersApi | get | GET /api/shared_folders/{shared_folder_id} | Get shared folder |
| SharedFoldersApi | list | GET /api/shared_folders | List shared folders |
| SharedFoldersApi | update | PATCH /api/shared_folders/{shared_folder_id} | Update shared folder |
| SshPrivateKeysApi | create | POST /api/ssh_private_keys | Create ssh private key |
| SshPrivateKeysApi | delete | DELETE /api/ssh_private_keys/{ssh_privatekey_id} | Delete ssh private key |
| SshPrivateKeysApi | get | GET /api/ssh_private_keys/{ssh_privatekey_id} | Get ssh private key |
| SshPrivateKeysApi | list | GET /api/ssh_private_keys | List ssh private keys |
| SshPrivateKeysApi | update | PATCH /api/ssh_private_keys/{ssh_privatekey_id} | Update ssh private key |
| SshPublicKeysApi | create | POST /api/ssh_public_keys | Create ssh public key |
| SshPublicKeysApi | delete | DELETE /api/ssh_public_keys/{ssh_publickey_id} | Delete ssh public key |
| SshPublicKeysApi | get | GET /api/ssh_public_keys/{ssh_publickey_id} | Get ssh public key |
| SshPublicKeysApi | list | GET /api/ssh_public_keys | List ssh public keys |
| SshPublicKeysApi | update | PATCH /api/ssh_public_keys/{ssh_publickey_id} | Update ssh public key |
| UsersApi | create | POST /api/users | Create user |
| UsersApi | delete | DELETE /api/users/{user_id} | Delete user |
| UsersApi | get | GET /api/users/{user_id} | Get user |
| UsersApi | list | GET /api/users | List users |
| UsersApi | update | PATCH /api/users/{user_id} | Update user |
| WorkspacesApi | create | POST /api/workspaces | Create workspace |
| WorkspacesApi | create_resource_template | POST /api/workspaces/{workspace_id}/template | Create workspace resource template |
| WorkspacesApi | create_route | POST /api/workspaces/{workspace_id}/routes | Create workspace route |
| WorkspacesApi | create_secret_attachment | POST /api/workspaces/{workspace_id}/secrets | Create workspace secret attachment |
| WorkspacesApi | create_service_account_attachment | PUT /api/workspaces/{workspace_id}/service_account | Create workspace service account attachment |
| WorkspacesApi | create_viewer | POST /api/workspaces/{workspace_id}/viewers | Create workspace viewer |
| WorkspacesApi | delete | DELETE /api/workspaces/{workspace_id} | Delete workspace |
| WorkspacesApi | delete_route | DELETE /api/workspaces/{workspace_id}/routes/{route_id} | Delete workspace route |
| WorkspacesApi | delete_secret_attachment | DELETE /api/workspaces/{workspace_id}/secrets/{secret_attachment_id} | Delete workspace secret attachment |
| WorkspacesApi | delete_service_account_attachment | DELETE /api/workspaces/{workspace_id}/service_account | Delete workspace service account attachment |
| WorkspacesApi | delete_viewer | DELETE /api/workspaces/{workspace_id}/viewers/{viewer_id} | Delete workspace viewer |
| WorkspacesApi | get | GET /api/workspaces/{workspace_id} | Get workspace |
| WorkspacesApi | get_cluster_history | GET /api/workspaces/{workspace_id}/clusters | Get workspace cluster history |
| WorkspacesApi | get_logs | GET /api/workspaces/{workspace_id}/logs | Get workspace historical logs |
| WorkspacesApi | get_metrics | GET /api/workspaces/{workspace_id}/metrics | Get workspace metrics |
| WorkspacesApi | get_pod_history | GET /api/workspaces/{workspace_id}/history | Get workspace pod history |
| WorkspacesApi | get_recipe | GET /api/workspaces/{workspace_id}/recipe | Get workspace recipe |
| WorkspacesApi | get_resource_template | GET /api/workspaces/{workspace_id}/template | Get workspace resource template |
| WorkspacesApi | get_route | GET /api/workspaces/{workspace_id}/routes/{route_id} | Get workspace route |
| WorkspacesApi | get_runtime_summary | GET /api/workspaces/{workspace_id}/runtimesummary | Get workspace runtime summary |
| WorkspacesApi | get_secret_attachment | GET /api/workspaces/{workspace_id}/secrets/{secret_attachment_id} | Get workspace secret attachment |
| WorkspacesApi | get_server_options | GET /api/workspaces/info | Get workspace server options |
| WorkspacesApi | get_service_account_attachment | GET /api/workspaces/{workspace_id}/service_account | Get workspace service account attachment |
| WorkspacesApi | get_token_info | GET /api/workspaces/{workspace_id}/token | Get workspace API token info |
| WorkspacesApi | list | GET /api/workspaces | List workspaces |
| WorkspacesApi | list_routes | GET /api/workspaces/{workspace_id}/routes | List workspace routes |
| WorkspacesApi | list_secret_attachments | GET /api/workspaces/{workspace_id}/secrets | List workspace secret attachments |
| WorkspacesApi | list_viewers | GET /api/workspaces/{workspace_id}/viewers | List workspace viewers |
| WorkspacesApi | restart | POST /api/workspaces/{workspace_id}/restart | Restart workspace |
| WorkspacesApi | rotate_token | POST /api/workspaces/{workspace_id}/token | Rotate workspace API token |
| WorkspacesApi | start | POST /api/workspaces/{workspace_id}/start | Start workspace |
| WorkspacesApi | stop | POST /api/workspaces/{workspace_id}/stop | Stop workspace |
| WorkspacesApi | update | PATCH /api/workspaces/{workspace_id} | Update workspace |
| WorkspacesApi | update_resource_template | PATCH /api/workspaces/{workspace_id}/template | Update workspace resource template |
| WorkspacesApi | update_route | PATCH /api/workspaces/{workspace_id}/routes/{route_id} | Update workspace route |
| WorkspacesApi | update_secret_attachment | PATCH /api/workspaces/{workspace_id}/secrets/{secret_attachment_id} | Update workspace secret attachment |
| WorkspacesApi | update_token | PATCH /api/workspaces/{workspace_id}/token | Update workspace API token |
Documentation For Models
- ActiveResourceList
- AggregatedUsage
- ApiStatus
- ApiToken
- ApiTokenCreate
- ApiTokenInfo
- ApiTokenList
- ApiTokenUpdate
- AppInfo
- Artifact
- ArtifactCreate
- ArtifactKind
- ArtifactList
- ArtifactStatus
- ArtifactUpdate
- Auth0Info
- AuthorizationCodeGrant
- AuthorizationGrant
- AuthorizationRefreshGrant
- AuthorizationTokenResponse
- BuildData
- Cluster
- ClusterConnectionType
- ClusterCreate
- ClusterList
- ClusterUpdate
- ConcurrencyPolicy
- Condition
- ConfigFileEntry
- ContainerRuntimeSummary
- ContainerStatus
- CronSchedule
- CronScheduleCreate
- CronScheduleUpdate
- DailyUsage
- DailyUsageList
- DaskCluster
- DaskClusterAdapt
- DaskClusterAttachment
- DaskClusterAttachmentScheduler
- DaskClusterAttachmentWorker
- DaskClusterCreate
- DaskClusterList
- DaskClusterNested
- DaskClusterRuntimeSummary
- DaskClusterScale
- DaskClusterServerOptions
- DaskClusterUpdate
- DaskComponents
- DaskWorkerRuntimeSummaryList
- DaskWorkerSummary
- DataPoint
- Dataset
- DatasetCreate
- DatasetImportCreate
- DatasetList
- DatasetLockCreate
- DefaultImages
- DefaultSizes
- Deployment
- DeploymentCreate
- DeploymentList
- DeploymentRecipe
- DeploymentRouteRecipe
- DeploymentRuntimeSummary
- DeploymentServerInfo
- DeploymentSpec
- DeploymentStart
- DeploymentStatus
- DeploymentUpdate
- DiskSpaceOption
- ExternalRepo
- ExternalRepoAttachment
- ExternalRepoAttachmentCreate
- ExternalRepoAttachmentList
- ExternalRepoAttachmentNested
- ExternalRepoAttachmentRecipe
- ExternalRepoAttachmentUpdate
- ExternalRepoCreate
- ExternalRepoList
- ExternalRepoUpdate
- ExtraPackages
- ExtraPackagesRecipe
- ExtraPackagesRecipeApt
- ExtraPackagesRecipeConda
- ExtraPackagesRecipePip
- FineTuneJobCreate
- FineTuneJobList
- FineTuneJobSummary
- FineTuneJobView
- Group
- GroupCreate
- GroupList
- GroupMember
- GroupMemberCreate
- GroupMemberList
- GroupUpdate
- HardwareType
- HistoricLog
- HistoricLogList
- Hyperparameters
- Hyperparameters1
- Identity
- IdentityByGroupId
- IdentityByUserId
- IdentityReference
- IdentityType
- Image
- ImageAccessLevel
- ImageBuildStatus
- ImageCreate
- ImageList
- ImageRecipe
- ImageSpec
- ImageState
- ImageTag
- ImageTagById
- ImageTagByName
- ImageTagByUri
- ImageTagCreate
- ImageTagCreateBuild
- ImageTagCreateExternal
- ImageTagList
- ImageTagRecipe
- ImageTagReference
- ImageTagState
- ImageTagUpdate
- ImageUpdate
- InferenceEndpointCreate
- InferenceEndpointList
- InferenceEndpointSummary
- InferenceEndpointView
- InstanceSize
- Invitation
- InvitationCreate
- InvitationList
- InvitationStatus
- InvitationUpdate
- Job
- JobCreate
- JobList
- JobRecipe
- JobRestart
- JobRuntimeSummary
- JobRuntimeSummaryList
- JobServerInfo
- JobSpec
- JobStart
- JobStatus
- JobUpdate
- Login
- MetricSeries
- Metrics
- Notification
- NotificationAcknowledged
- NotificationDelete
- NotificationList
- NotificationSubscribe
- NotificationSubscription
- NotificationSubscriptionList
- NotificationUnsubscribe
- ObjectStorageBulkDeleteResults
- ObjectStorageBulkDownload
- ObjectStorageBulkReference
- ObjectStorageCompletePart
- ObjectStorageCompletedUpload
- ObjectStorageCopySource
- ObjectStorageDirDetails
- ObjectStorageFileDetails
- ObjectStorageList
- ObjectStoragePresignedDownload
- ObjectStoragePresignedPart
- ObjectStoragePresignedUpload
- ObjectStorageReference
- ObjectStorageSharedOwner
- ObjectStorageSharedOwnerList
- ObjectStorageUpload
- ObjectStorageUploadCreate
- ObjectStorageUploadList
- ObjectStorageUsageStats
- Org
- OrgCreate
- OrgInvitation
- OrgInvitationCreate
- OrgInvitationList
- OrgInvitationUpdate
- OrgList
- OrgMemberCreate
- OrgMemberUpdate
- OrgUpdate
- OrgsListOwners200Response
- Owner
- OwnerById
- OwnerByIdentityId
- OwnerByName
- OwnerDetailed
- OwnerDetailedList
- OwnerList
- OwnerReference
- OwnerUsage
- OwnerUsageList
- OwnerUserDetailed
- PodHistory
- PodLogs
- PodRuntimeSummary
- PodRuntimeSummaryList
- PodStatus
- Recipe
- RecipeList
- Resource
- ResourceByDeploymentId
- ResourceByJobId
- ResourceByWorkspaceId
- ResourceClusters
- ResourceHistory
- ResourceRecipe
- ResourceReference
- ResourceState
- ResourceTemplate
- ResourceTemplateAccessLevel
- ResourceTokenInfo
- ResourceTokenUpdate
- ResourceType
- RestartPolicy
- Route
- RouteByContainerPort
- RouteById
- RouteBySubdomain
- RouteCreate
- RouteList
- RouteReference
- RouteState
- RouteUpdate
- SSHPrivateKey
- SSHPrivateKeyCreate
- SSHPrivateKeyList
- SSHPrivateKeyPartial
- SSHPrivateKeyUpdate
- SSHPublicKey
- SSHPublicKeyCreate
- SSHPublicKeyList
- SSHPublicKeyUpdate
- Secret
- SecretAccessLevel
- SecretAttachment
- SecretAttachmentCreate
- SecretAttachmentList
- SecretAttachmentRecipe
- SecretAttachmentType
- SecretAttachmentUpdate
- SecretCreate
- SecretList
- SecretUpdate
- ServerOptions
- ServerOptionsSize
- ServiceAccount
- ServiceAccountAttachment
- ServiceAccountCreate
- ServiceAccountCreateAttachment
- ServiceAccountEntitlement
- ServiceAccountEntitlementCreate
- ServiceAccountEntitlementList
- ServiceAccountList
- ServiceAccountUpdate
- SharedAccessMode
- SharedFolder
- SharedFolderAccessLevel
- SharedFolderAttachment
- SharedFolderAttachmentCreate
- SharedFolderAttachmentList
- SharedFolderAttachmentRecipe
- SharedFolderAttachmentUpdate
- SharedFolderCreate
- SharedFolderList
- SharedFolderUpdate
- Stats
- UsageLimits
- UsageLimitsCreate
- UsageLimitsList
- UsageLimitsUpdate
- UsageOwner
- User
- UserAdminCreate
- UserDetailed
- UserDetailedList
- UserList
- UserOwnerList
- UserPreferences
- UserPreferencesUpdate
- UserUpdate
- UsersGet200Response
- UsersList200Response
- Viewer
- ViewerCreate
- ViewerList
- ViewerRecipe
- WhiteLabelConfiguration
- WorkloadType
- Workspace
- WorkspaceCreate
- WorkspaceIdeDefaultImages
- WorkspaceList
- WorkspaceRecipe
- WorkspaceRouteRecipe
- WorkspaceRuntimeSummary
- WorkspaceServerInfo
- WorkspaceServerOptions
- WorkspaceSpec
- WorkspaceStart
- WorkspaceUpdate
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication
Author
Metadata
Release files for saturn-api 2026.6.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| saturn_api-2026.6.3.tar.gz | 250.5 kB | With provenance | Details for saturn_api-2026.6.3.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| saturn_api-2026.6.3-py3-none-any.whl | Python 3 | none | any | Details for saturn_api-2026.6.3-py3-none-any.whl |
Total release size: 881.7 kB
Release files / saturn_api-2026.6.3.tar.gz
| Download URL | saturn_api-2026.6.3.tar.gz |
|---|---|
| Size | 250.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9c57d79de643599395eeed64c9a4c9ea8784ca63fab40b055d60c3dc6cf4f729
|
|
BLAKE2b-256 checksum How to use checksums |
a98352b6ba9c2d1fc28aa72153e4539a8a45300a7515d066bfd9f62c08e1eb9a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 3, 2026.
Transparency logRelease files / saturn_api-2026.6.3-py3-none-any.whl
| Download URL | saturn_api-2026.6.3-py3-none-any.whl |
|---|---|
| Size | 631.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
bcce3a12d2954f7a315c94c565cdfdc8c706d57b84bcd151b4cd05998a44eb28
|
|
BLAKE2b-256 checksum How to use checksums |
32b184684ea6eb461b800bb41e57fb9c58059fa25fd38b989a83b772f090c703
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 3, 2026.
Transparency logSecurity for saturn-api 2026.6.3
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for saturn_api-2026.6.3.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 3, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.