Platform API Documentation

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for srinivasgs from gravatar.com srinivasgs

Unverified details

These details have not been verified by PyPI
Project links
Meta
Report project as malware

Project description

do-sdk-platform

Combined API documentation for all platform services

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.14.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

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 do_sdk_platform

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 do_sdk_platform

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import do_sdk_platform
from do_sdk_platform.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = do_sdk_platform.Configuration(
    host = "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 (JWT): bearer
configuration = do_sdk_platform.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with do_sdk_platform.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = do_sdk_platform.BillingApi(api_client)
    org_key = 'org_key_example' # str | The organization friendly identifier resolving to the organization DRN.
    add_credits_request_schema_dto = do_sdk_platform.AddCreditsRequestSchemaDto() # AddCreditsRequestSchemaDto | Add credits request

    try:
        # Add Credits
        api_response = api_instance.billing_add_credits(org_key, add_credits_request_schema_dto)
        print("The response of BillingApi->billing_add_credits:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling BillingApi->billing_add_credits: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
BillingApi billing_add_credits POST /billing/{orgKey}/credits Add Credits
BillingApi billing_check GET /billing/health
BillingApi billing_delete_payment DELETE /billing/{orgKey}/payments/{paymentId} Delete payment
BillingApi billing_delete_subscription DELETE /billing/{orgKey}/subscriptions/{subscriptionId}/{immediately} Delete Subscriptions
BillingApi billing_get_active_subscriptions GET /billing/{orgKey}/subscriptions Get Active Subscriptions
BillingApi billing_get_all_subscriptions GET /billing/{orgKey}/subscriptions/all Gets All Subscriptions
BillingApi billing_get_billing_address GET /billing/{orgKey}/address Retrieve billing address
BillingApi billing_get_countries GET /billing/{orgKey}/countries Retrieve available countries
BillingApi billing_get_credit_balance GET /billing/{orgKey}/credits/balance Get Credit Balance
BillingApi billing_get_credit_line GET /billing/{orgKey}/credits/line Get credit line information
BillingApi billing_get_credits_history GET /billing/{orgKey}/credits/history Get Credits History
BillingApi billing_get_credits_usage GET /billing/{orgKey}/credits/usage Get Credits Usage
BillingApi billing_get_feature_descriptions GET /billing/{orgKey}/feature/descriptions Get feature descriptions
BillingApi billing_get_features GET /billing/{orgKey}/features Get Subscription Features
BillingApi billing_get_invoice_pdf_link GET /billing/{orgKey}/invoices/pdfLink/{id} Get invoice PDF link
BillingApi billing_get_invoices GET /billing/{orgKey}/invoices Get Invoices
BillingApi billing_get_monthly_balance GET /billing/{orgKey}/credits/monthly/{month}/{year} Get Monthly Credit Usage
BillingApi billing_get_monthly_overview GET /billing/{orgKey}/usage/monthly/{year}/{month} Get Monthly Overview
BillingApi billing_get_past_subscriptions GET /billing/{orgKey}/subscriptions/past Get Past Subscriptions
BillingApi billing_get_payment GET /billing/{orgKey}/payments List payment methods
BillingApi billing_get_payment_link GET /billing/{orgKey}/invoices/payment/{id}/{tab} Get payment link
BillingApi billing_get_recent_activity GET /billing/{orgKey}/usage/recent Get Recent Activity
BillingApi billing_pay POST /billing/{orgKey}/invoices/{invoiceId}/{paymentId} Process payment
BillingApi billing_update_billing_address POST /billing/{orgKey}/address Update billing address
BillingApi billing_update_payment POST /billing/{orgKey}/payments Update payment details
BillingApi billing_update_subscription POST /billing/{orgKey}/subscriptions Updates Subscription
ComputeBenchAPIApi api_accept_organization_invite POST /api/organizations/invites/code/{code}:{action} Accept an organization invite
ComputeBenchAPIApi api_account POST /api/users Create a new user account
ComputeBenchAPIApi api_action_tool_execution PATCH /api/tools/executions/{orgFriendlyId}/{executionId}:{action} Updates a Tool
ComputeBenchAPIApi api_add_credits POST /api/credits/{orgFriendlyId} Add Credits
ComputeBenchAPIApi api_all_admin_compute_benches GET /api/computebenches/{orgFriendlyId}/admin Get all admin ComputeBenches
ComputeBenchAPIApi api_all_compute_benches GET /api/computebenches/{orgFriendlyId} Get all ComputeBenches for a user
ComputeBenchAPIApi api_capture_event POST /api/ulog Capture a custom analytics event
ComputeBenchAPIApi api_check GET /api/health
ComputeBenchAPIApi api_contact_us POST /api/organizations/{orgFriendlyId}/contact/us Submit a contact request
ComputeBenchAPIApi api_create_account POST /api/accounts-v2 Create Account
ComputeBenchAPIApi api_create_compute_bench POST /api/computebenches/{orgFriendlyId} Create a new ComputeBench
ComputeBenchAPIApi api_create_custom_entrypoint POST /api/computebenches/{orgFriendlyId}/entrypoint Create a custom entrypoint for a ComputeBench
ComputeBenchAPIApi api_create_function POST /api/functions Creates a function
ComputeBenchAPIApi api_create_organization POST /api/organizations Create a new organization
ComputeBenchAPIApi api_create_organization_secret POST /api/secrets/{orgFriendlyId} Create Organization Secret
ComputeBenchAPIApi api_create_pipeline POST /api/pipelines Create Pipeline
ComputeBenchAPIApi api_create_signup_code POST /api/accounts-v2/verify Create Signup Code
ComputeBenchAPIApi api_create_ssh POST /api/ssh Creates a SSH Command
ComputeBenchAPIApi api_create_tool POST /api/tools/definitions Creates a new tool definition
ComputeBenchAPIApi api_create_user_secret POST /api/user/secrets Creates a user secret
ComputeBenchAPIApi api_create_volume POST /api/volumes/{orgFriendlyId} Creates Volume
ComputeBenchAPIApi api_create_workflow POST /api/workflows/{orgFriendlyId} Creates a workflow
ComputeBenchAPIApi api_create_workflow_task POST /api/workflows/{orgFriendlyId}/{workflowId}/tasks Creates a Workflow Task
ComputeBenchAPIApi api_delete_all_organization DELETE /api/admin/organizations Delete all organizations
ComputeBenchAPIApi api_delete_custom_entrypoint DELETE /api/computebenches/{orgFriendlyId}/{resourceId}/entrypoint/{port} Delete a custom entrypoint from a ComputeBench
ComputeBenchAPIApi api_delete_function DELETE /api/functions/{key} Deletes a function by key
ComputeBenchAPIApi api_delete_organization DELETE /api/organizations/{orgFriendlyId}
ComputeBenchAPIApi api_delete_organization_invite DELETE /api/organizations/{orgFriendlyId}/invites/{userEmail}
ComputeBenchAPIApi api_delete_organization_member DELETE /api/organizations/{orgFriendlyId}/users/{userAuthId} Delete an organization member
ComputeBenchAPIApi api_delete_organization_secret DELETE /api/secrets/{orgFriendlyId}/{secretId} Delete Organization Secret
ComputeBenchAPIApi api_delete_payment DELETE /api/billing/{orgFriendlyId}/{paymentId} Delete payment
ComputeBenchAPIApi api_delete_ssh DELETE /api/ssh/{drn} Deletes SSH Command
ComputeBenchAPIApi api_delete_subscription DELETE /api/subscriptions/{orgFriendlyId}/{subscriptionId}/{immediately} Delete Subscriptions
ComputeBenchAPIApi api_delete_tool DELETE /api/tools/{toolKey}/{toolVersion}/definitions Deletes a specific version of a tool definition
ComputeBenchAPIApi api_delete_user DELETE /api/user/{email} Delete a user
ComputeBenchAPIApi api_delete_user_secret DELETE /api/user/secrets/{secretId} Deletes a user secret
ComputeBenchAPIApi api_delete_volume DELETE /api/volumes/{orgFriendlyId}/{resourceId} Deletes a Volume
ComputeBenchAPIApi api_execute_tool POST /api/tools/{toolKey}/executions/{orgFriendlyId} Executes a Tool
ComputeBenchAPIApi api_execute_tool_with_version POST /api/tools/{toolKey}/{toolVersion}/executions/{orgFriendlyId} Executes a Tool with a version
ComputeBenchAPIApi api_get_account GET /api/users/account Get account details
ComputeBenchAPIApi api_get_active_subscriptions GET /api/subscriptions/{orgFriendlyId} Get Active Subscriptions
ComputeBenchAPIApi api_get_admin_tool_executions GET /api/admin/tools/executions List admin tool executions
ComputeBenchAPIApi api_get_all_subscriptions GET /api/subscriptions/{orgFriendlyId}/all Gets All Subscriptions
ComputeBenchAPIApi api_get_all_tools GET /api/tools/definitions Get all tools definition
ComputeBenchAPIApi api_get_billing_address GET /api/billing/{orgFriendlyId}/address Retrieve billing address
ComputeBenchAPIApi api_get_compute_bench GET /api/computebenches/{orgFriendlyId}/{resourceId} Retrieve a ComputeBench by its name
ComputeBenchAPIApi api_get_countries GET /api/billing/{orgFriendlyId}/countries Retrieve available countries
ComputeBenchAPIApi api_get_credit_balance GET /api/credits/{orgFriendlyId}/balance Get Credit Balance
ComputeBenchAPIApi api_get_credit_line GET /api/billing/{orgFriendlyId}/credit-line Get credit line information
ComputeBenchAPIApi api_get_credits_history GET /api/credits/{orgFriendlyId}/history Get Credits History
ComputeBenchAPIApi api_get_credits_usage GET /api/credits/{orgFriendlyId}/usage Get Credits Usage
ComputeBenchAPIApi api_get_feature_descriptions GET /api/billing/{orgFriendlyId}/feature-descriptions Get feature descriptions
ComputeBenchAPIApi api_get_features GET /api/subscriptions/{orgFriendlyId}/features Get Subscription Features
ComputeBenchAPIApi api_get_function GET /api/functions/{key} Gets a function by key
ComputeBenchAPIApi api_get_functions GET /api/functions Gets all functions
ComputeBenchAPIApi api_get_invoice_pdf_link GET /api/billing/{orgFriendlyId}/invoices/pdfLink/{id} Get invoice PDF link
ComputeBenchAPIApi api_get_invoices GET /api/invoices/{orgFriendlyId}/invoices Get Invoices
ComputeBenchAPIApi api_get_monthly_balance GET /api/credits/{orgFriendlyId}/monthly/balance/{month}/{year} Get Monthly Credit Usage
ComputeBenchAPIApi api_get_monthly_overview GET /api/billing/{orgFriendlyId}/monthly-overview/{year}/{month} Get Monthly Overview
ComputeBenchAPIApi api_get_organization GET /api/organizations/{orgFriendlyId}
ComputeBenchAPIApi api_get_organization_invite GET /api/organizations/{orgFriendlyId}/invites/{code}
ComputeBenchAPIApi api_get_organization_secret GET /api/secrets/{orgFriendlyId}/{secretId} Get Organization Secret
ComputeBenchAPIApi api_get_organization_user GET /api/organizations/{orgFriendlyId}/users/{userId} Get organization user details
ComputeBenchAPIApi api_get_organization_users GET /api/organizations/{orgFriendlyId}/users List organization users
ComputeBenchAPIApi api_get_organizations GET /api/organizations List Organizations
ComputeBenchAPIApi api_get_past_subscriptions GET /api/subscriptions/{orgFriendlyId}/past Get Past Subscriptions
ComputeBenchAPIApi api_get_payment GET /api/billing/{orgFriendlyId}/payments List payment methods
ComputeBenchAPIApi api_get_payment_link GET /api/billing/{orgFriendlyId}/invoices/payment/{id}/{tab} Get payment link
ComputeBenchAPIApi api_get_pipeline GET /api/pipelines/{pipelineId} Retrieve Pipeline Details
ComputeBenchAPIApi api_get_recent_activity GET /api/billing/{orgFriendlyId}/recent-activity Get Recent Activity
ComputeBenchAPIApi api_get_signup_code GET /api/accounts-v2/verify/{code} Get Signup Code
ComputeBenchAPIApi api_get_ssh GET /api/ssh/{drn} Gets SSH Command
ComputeBenchAPIApi api_get_tool GET /api/tools/{toolKey}/definitions Get all versions of a tool definition
ComputeBenchAPIApi api_get_tool_execution GET /api/tools/executions/{orgFriendlyId}/{executionId} Gets a Tool
ComputeBenchAPIApi api_get_tool_executions GET /api/tools/executions/{orgFriendlyId} Gets Paginated Tools Executions
ComputeBenchAPIApi api_get_tour_status GET /api/users/tour Get the last completed product tour version
ComputeBenchAPIApi api_get_unique_organization_id GET /api/organizations/unique/id/{companyName} Generate a unique organization friendly ID
ComputeBenchAPIApi api_get_user_secret GET /api/user/secrets/{secretId} Retrieves a specific user secret
ComputeBenchAPIApi api_get_versioned_tool GET /api/tools/{toolKey}/{toolVersion}/definitions Get a specific version of a tool definition
ComputeBenchAPIApi api_get_volume GET /api/volumes/{orgFriendlyId}/{resourceId} Gets a Volume
ComputeBenchAPIApi api_get_workflow GET /api/workflows/{orgFriendlyId}/{workflowId} List Workflow Tasks
ComputeBenchAPIApi api_get_workflow_task GET /api/workflows/{orgFriendlyId}/{workflowId}/tasks/{taskId} List Workflow Tasks by Task Id
ComputeBenchAPIApi api_invite_organization_member POST /api/organizations/{orgFriendlyId}/invites
ComputeBenchAPIApi api_list_all_applications GET /api/catalog/applications List All Applications
ComputeBenchAPIApi api_list_all_blueprints GET /api/catalog/blueprints List All Blueprints
ComputeBenchAPIApi api_list_all_notebooks GET /api/catalog/notebooks List All Notebooks
ComputeBenchAPIApi api_list_all_operating_systems GET /api/catalog/operating-systems List All Operating Systems
ComputeBenchAPIApi api_list_bench_secrets GET /api/computebenches/{orgFriendlyId}/{benchId}/secrets List ComputeBench secrets
ComputeBenchAPIApi api_list_clusters GET /api/clusters/{orgFriendlyId} List Clusters by Org ID
ComputeBenchAPIApi api_list_notifications GET /api/billing/{orgFriendlyId}/notifications Get billing notifications
ComputeBenchAPIApi api_list_organization_secrets GET /api/secrets/{orgFriendlyId} List Organization Secrets
ComputeBenchAPIApi api_list_organizations GET /api/organizations/me
ComputeBenchAPIApi api_list_pipelines GET /api/pipelines List Pipelines
ComputeBenchAPIApi api_list_ssh GET /api/ssh List SSH Commands
ComputeBenchAPIApi api_list_user_secrets GET /api/user/secrets Retrieves a list of user secrets
ComputeBenchAPIApi api_list_volumes GET /api/volumes/{orgFriendlyId} List Volumes
ComputeBenchAPIApi api_list_workflow_tasks GET /api/workflows/{orgFriendlyId}/{workflowId}/tasks List workflow tasks
ComputeBenchAPIApi api_list_workflows GET /api/workflows/{orgFriendlyId} List Workflow Tasks
ComputeBenchAPIApi api_pay GET /api/billing/{orgFriendlyId}/payments/{paymentId}/{invoiceId} Process payment
ComputeBenchAPIApi api_perform_compute_bench_action POST /api/computebenches/{orgFriendlyId}/{resourceId}:{action} Perform action on ComputeBench
ComputeBenchAPIApi api_register POST /api/clusters/{orgFriendlyId} Creates a new cluster
ComputeBenchAPIApi api_resend_invite_controller POST /api/users/account:{action} Resend or validate user invite
ComputeBenchAPIApi api_run_function POST /api/functions/{orgFriendlyId}/{key} Runs a function
ComputeBenchAPIApi api_update_account PATCH /api/users/me Update user account
ComputeBenchAPIApi api_update_billing_address POST /api/billing/{orgFriendlyId}/address Update billing address
ComputeBenchAPIApi api_update_compute_bench PATCH /api/computebenches/{orgFriendlyId}/{resourceId} Update a ComputeBench
ComputeBenchAPIApi api_update_computebench_status PATCH /api/computebenches/{orgFriendlyId}/{resourceId}/status Update ComputeBench Status
ComputeBenchAPIApi api_update_execution PATCH /api/tools/executions/{orgFriendlyId}/{executionId} Updates a Tool
ComputeBenchAPIApi api_update_function PUT /api/functions/{key} Updates a function
ComputeBenchAPIApi api_update_organization PATCH /api/organizations/{orgFriendlyId}
ComputeBenchAPIApi api_update_organization_invite_role PATCH /api/organizations/{orgFriendlyId}/invites/{userAuthId}
ComputeBenchAPIApi api_update_organization_member_role PATCH /api/organizations/{orgFriendlyId}/users/{userAuthId} Update organization user role
ComputeBenchAPIApi api_update_organization_secret PATCH /api/secrets/{orgFriendlyId}/{secretId} Update Organization Secret
ComputeBenchAPIApi api_update_organization_status_by_friendly_id PATCH /api/organizations/{orgFriendlyId}/status
ComputeBenchAPIApi api_update_payment POST /api/billing/{orgFriendlyId}/payments Update payment details
ComputeBenchAPIApi api_update_ssh PATCH /api/ssh/{drn} Updates SSH Command
ComputeBenchAPIApi api_update_subscription POST /api/subscriptions/{orgFriendlyId} Updates Subscription
ComputeBenchAPIApi api_update_tool PUT /api/tools/{toolKey}/{toolVersion}/definitions Updates a specific version of a tool definition
ComputeBenchAPIApi api_update_tour_status PUT /api/users/tour Update the last completed product tour version
ComputeBenchAPIApi api_update_user_secret PATCH /api/user/secrets/{secretId} Updates an existing user secret
ComputeBenchAPIApi api_update_volume_status_by_name PATCH /api/volumes/{orgFriendlyId}/{resourceId}/status Updates a Volume
ComputeBenchAPIApi api_update_workflow_status PATCH /api/workflows/{orgFriendlyId}/{workflowId}/status
ComputeBenchAPIApi api_update_workflow_task PATCH /api/workflows/{orgFriendlyId}/{workflowId}/tasks/{taskId} Updates a Workflow Task
ComputeBenchAPIApi file_api_check GET /file-api/file-api/health
ComputeBenchAPIApi file_api_delete_object DELETE /file-api/file-api/{orgKey}/{filePath}
ComputeBenchAPIApi file_api_get_object GET /file-api/file-api/{orgKey}/{filePath}
ComputeBenchAPIApi file_api_get_signed_url_download GET /file-api/file-api/signedUrl/download/{orgKey}/{filePath}
ComputeBenchAPIApi file_api_get_signed_url_upload GET /file-api/file-api/signedUrl/upload/{orgKey}/{filePath}
ComputeBenchAPIApi file_api_head_object HEAD /file-api/file-api/{orgKey}/{filePath}
ComputeBenchAPIApi file_api_put_object PUT /file-api/file-api/{orgKey}/{filePath}
DataApi data_check GET /data/health
DataApi data_get_data_description GET /data/{orgKey}/describe/{filePath}
DataApi data_get_data_set GET /data/{orgKey}/{filePath}
DataApi data_set_data POST /data/{orgKey}/{filePath}
EntitiesApi entities_accept_organization_invite GET /entities/protected/organizations/invites/{code}:accept Accept an organization invite
EntitiesApi entities_check GET /entities/health Check overall service health
EntitiesApi entities_check_keycloak GET /entities/health/keycloak Check Keycloak health
EntitiesApi entities_contact_us POST /entities/{orgKey}/organizations/contact/us Submit a contact request
EntitiesApi entities_create_account POST /entities/public/accounts Create Account
EntitiesApi entities_create_organization POST /entities/protected/organizations Create a new organization
EntitiesApi entities_create_signup_code POST /entities/public/accounts/verify Create Signup Code
EntitiesApi entities_delete_all_organization DELETE /entities/admin/organizations Delete all organizations
EntitiesApi entities_delete_organization DELETE /entities/{orgKey}/organizations
EntitiesApi entities_delete_organization_invite DELETE /entities/{orgKey}/organizations/invites/{email}
EntitiesApi entities_delete_organization_member DELETE /entities/{orgKey}/organizations/users/{userId} Delete an organization member
EntitiesApi entities_generate_referral_code POST /entities/protected/users/referral Generate a referral code
EntitiesApi entities_get_account GET /entities/protected/account Get user account
EntitiesApi entities_get_keycloak_token GET /entities/{orgKey}/token/{serviceName}:create Get Keycloak Token
EntitiesApi entities_get_notifications GET /entities/{orgKey}/users/notifications/{notificationId}
EntitiesApi entities_get_organization GET /entities/{orgKey}
EntitiesApi entities_get_organization_invite GET /entities/{orgKey}/organizations/invites/{code}
EntitiesApi entities_get_organization_user GET /entities/{orgKey}/organizations/users/{userId} Get organization user details
EntitiesApi entities_get_organization_users GET /entities/{orgKey}/organizations/users List organization users
EntitiesApi entities_get_organizations GET /entities/admin/organizations List Organizations
EntitiesApi entities_get_protected_service_token GET /entities/protected/service/token:create Get Keycloak Token
EntitiesApi entities_get_public_jwks GET /entities/public/jwks Get Keycloak JWKS
EntitiesApi entities_get_signup_code GET /entities/public/accounts/verify/{code} Get Signup Code
EntitiesApi entities_get_unique_organization_id GET /entities/protected/organizations/unique/id/{companyName} Generate a unique organization friendly ID
EntitiesApi entities_invite_organization_member POST /entities/{orgKey}/organizations/invite
EntitiesApi entities_list_notifications GET /entities/{orgKey}/users/notifications Get billing notifications
EntitiesApi entities_list_organizations GET /entities/protected/organizations
EntitiesApi entities_read_notification POST /entities/{orgKey}/users/notifications/{notificationId}/read Mark a notification as read
EntitiesApi entities_refresh_token GET /entities/{orgKey}/token/{serviceName}:refresh Get Keycloak JWKS
EntitiesApi entities_send_all_notifications GET /entities/admin/users/{email} Delete a user
EntitiesApi entities_send_notification_all_users POST /entities/admin/users/notifications/all
EntitiesApi entities_send_notification_to_user POST /entities/{orgKey}/users/{userId}/notifications
EntitiesApi entities_send_notification_user POST /entities/admin/users/notifications/user/{userId}
EntitiesApi entities_update_account PATCH /entities/protected/account Update user account
EntitiesApi entities_update_organization PATCH /entities/{orgKey}
EntitiesApi entities_update_organization_invite_role PATCH /entities/{orgKey}/organizations/invites/{email}
EntitiesApi entities_update_organization_member_role PATCH /entities/{orgKey}/organizations/users/{userId}
EntitiesApi entities_update_organization_status PATCH /entities/{orgKey}/organizations/status
FileApi files_check GET /files/health
FileApi files_delete_object DELETE /files/{orgKey}/{filePath}
FileApi files_get_object GET /files/{orgKey}/{filePath}
FileApi files_get_object_directory GET /files/{orgKey}/directory/{filePath}
FileApi files_get_signed_url GET /files/{orgKey}/signedUrl/{filePath}
FileApi files_head_object HEAD /files/{orgKey}/{filePath}
FileApi files_put_object PUT /files/{orgKey}/{filePath}
ToolsApi tools_action_tool_execution PATCH /tools/{orgKey}/tools/executions/{orgKey}/{executionId}:{action} Updates a Tool
ToolsApi tools_capture_event POST /tools/public/ulog Capture a custom analytics event
ToolsApi tools_check GET /tools/health
ToolsApi tools_create_function POST /tools/admin/functions/definitions Creates a function
ToolsApi tools_create_tool POST /tools/admin/tools/definitions Creates a new tool definition
ToolsApi tools_delete_tool DELETE /tools/admin/tools/{toolKey}/{toolVersion}/definitions Deletes a specific version of a tool definition
ToolsApi tools_execute_tool POST /tools/{orgKey}/tools/{toolKey}/executions Executes a Tool
ToolsApi tools_execute_tool_with_version POST /tools/{orgKey}/tools/{toolKey}/{toolVersion}/executions Executes a Tool with a version
ToolsApi tools_get_admin_tool_executions GET /tools/admin/tools/executions List admin tool executions
ToolsApi tools_get_all_tools GET /tools/protected/tools/definitions Get all tools definition
ToolsApi tools_get_connection GET /tools/message-communication Check connection status
ToolsApi tools_get_function GET /tools/protected/functions/{key}/{version} Gets a function by key and version
ToolsApi tools_get_functions GET /tools/protected/functions/definitions Gets all functions
ToolsApi tools_get_functions_bykey GET /tools/protected/functions/{key}/definitions Gets all versions of function key
ToolsApi tools_get_tool GET /tools/protected/tools/{toolKey}/definitions Get all versions of a tool definition
ToolsApi tools_get_tool_execution GET /tools/{orgKey}/tools/executions/{executionId} Gets a Tool
ToolsApi tools_get_tool_executions GET /tools/{orgKey}/tools/executions Gets Paginated Tools Executions
ToolsApi tools_get_versioned_tool GET /tools/protected/tools/{toolKey}/{toolVersion}/definitions Get a specific version of a tool definition
ToolsApi tools_list_clusters GET /tools/{orgKey}/clusters List Clusters by Org ID
ToolsApi tools_register POST /tools/{orgKey}/clusters Creates a new cluster
ToolsApi tools_run_function POST /tools/{orgKey}/functions/{key}/{version} Runs a function
ToolsApi tools_update_execution PATCH /tools/{orgKey}/tools/executions/{executionId} Updates a Tool
ToolsApi tools_update_function PUT /tools/protected/functions/{key}/{version} Updates a specific version of a function
ToolsApi tools_update_tool PUT /tools/admin/tools/{toolKey}/{toolVersion}/definitions Updates a specific version of a tool definition
ApiApi nucleus_api_add_database_column POST /nucleus-api/AddDatabaseColumn Add Database Column
ApiApi nucleus_api_archive_files POST /nucleus-api/ArchiveFiles Archive Files
ApiApi nucleus_api_configure_column_select_options POST /nucleus-api/ConfigureColumnSelectOptions Configure Column Select Options
ApiApi nucleus_api_convert_id_format POST /nucleus-api/ConvertIdFormat Convert ID format
ApiApi nucleus_api_create_chat_thread POST /nucleus-api/CreateChatThread Create Chat Thread
ApiApi nucleus_api_create_database POST /nucleus-api/CreateDatabase Create database
ApiApi nucleus_api_create_database_view POST /nucleus-api/CreateDatabaseView Create a database view
ApiApi nucleus_api_create_file_download_url POST /nucleus-api/CreateFileDownloadUrl Create file download URL
ApiApi nucleus_api_create_file_upload POST /nucleus-api/CreateFileUpload Create File Upload
ApiApi nucleus_api_create_workspace POST /nucleus-api/CreateWorkspace Create workspace
ApiApi nucleus_api_delete_database POST /nucleus-api/DeleteDatabase Delete a database
ApiApi nucleus_api_delete_database_column POST /nucleus-api/DeleteDatabaseColumn Delete Database Column
ApiApi nucleus_api_delete_database_view POST /nucleus-api/DeleteDatabaseView Delete a database view
ApiApi nucleus_api_delete_rows POST /nucleus-api/DeleteRows Delete Rows
ApiApi nucleus_api_delete_workspace POST /nucleus-api/DeleteWorkspace Delete a workspace
ApiApi nucleus_api_describe_code_execution POST /nucleus-api/DescribeCodeExecution Describe Code Execution
ApiApi nucleus_api_describe_database POST /nucleus-api/DescribeDatabase Describe a database
ApiApi nucleus_api_describe_database_row POST /nucleus-api/DescribeDatabaseRow Describe a database row
ApiApi nucleus_api_describe_database_stats POST /nucleus-api/DescribeDatabaseStats Describes Database Stats
ApiApi nucleus_api_describe_database_view POST /nucleus-api/DescribeDatabaseView Describe a database view
ApiApi nucleus_api_describe_file POST /nucleus-api/DescribeFile Describe File
ApiApi nucleus_api_describe_hierarchy POST /nucleus-api/DescribeHierarchy Describe the hierarchical position of an entity.
ApiApi nucleus_api_describe_row POST /nucleus-api/DescribeRow Describe a row
ApiApi nucleus_api_describe_workspace POST /nucleus-api/DescribeWorkspace Describe a workspace
ApiApi nucleus_api_download_file GET /nucleus-api/DownloadFile Download file
ApiApi nucleus_api_ensure_rows POST /nucleus-api/EnsureRows Ensure Rows
ApiApi nucleus_api_execute_code POST /nucleus-api/ExecuteCode Execute code
ApiApi nucleus_api_execute_code_sync POST /nucleus-api/ExecuteCodeSync Execute code synchronously
ApiApi nucleus_api_export_database POST /nucleus-api/ExportDatabase Export a database
ApiApi nucleus_api_get_code_execution_result POST /nucleus-api/GetCodeExecutionResult Get Code Execution Result
ApiApi nucleus_api_import_rows POST /nucleus-api/ImportRows Import Rows
ApiApi nucleus_api_list_chat_thread_messages POST /nucleus-api/ListChatThreadMessages List Chat Thread Messages
ApiApi nucleus_api_list_database_column_unique_values_v2 POST /nucleus-api/ListDatabaseColumnUniqueValuesV2 List database column unique values
ApiApi nucleus_api_list_database_rows POST /nucleus-api/ListDatabaseRows Lists database rows
ApiApi nucleus_api_list_database_views POST /nucleus-api/ListDatabaseViews List a database views
ApiApi nucleus_api_list_files POST /nucleus-api/ListFiles Lists files
ApiApi nucleus_api_list_mentions POST /nucleus-api/ListMentions Lists mentions
ApiApi nucleus_api_list_row_back_references POST /nucleus-api/ListRowBackReferences Lists row back references
ApiApi nucleus_api_list_rows POST /nucleus-api/ListRows Lists rows
ApiApi nucleus_api_lock_database POST /nucleus-api/LockDatabase Locks the database
ApiApi nucleus_api_parse_base_sequence_data POST /nucleus-api/ParseBaseSequenceData Parses Base Sequence Data
ApiApi nucleus_api_resolve_ids POST /nucleus-api/ResolveIds ResolveIds
ApiApi nucleus_api_send_chat_message POST /nucleus-api/SendChatMessage Send Chat Message
ApiApi nucleus_api_unlock_database POST /nucleus-api/UnlockDatabase Unlocks the database
ApiApi nucleus_api_update_database POST /nucleus-api/UpdateDatabase Update database
ApiApi nucleus_api_update_database_column POST /nucleus-api/UpdateDatabaseColumn Update database column
ApiApi nucleus_api_update_database_view POST /nucleus-api/UpdateDatabaseView Update a database view
ApiApi nucleus_api_update_workspace POST /nucleus-api/UpdateWorkspace Update Workspace

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearer

  • Type: Bearer authentication (JWT)

api-key

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

keycloak

  • Type: Bearer authentication (JWT)

bearerAuth

  • Type: Bearer authentication (JWT)

basic

  • Type: HTTP basic authentication

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for srinivasgs from gravatar.com srinivasgs

Unverified details

These details have not been verified by PyPI
Project links
Meta

Release history Release notifications | RSS feed

6.3.0

6.2.0

6.1.0

6.0.3

This version

6.0.2

6.0.1

6.0.0

5.0.0

4.0.0

3.2.0

3.1.0

3.0.0

2.1.0

2.0.0

1.1.0

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

do_sdk_platform-6.0.2.tar.gz (380.2 kB view details)

Uploaded Source

File details

Details for the file do_sdk_platform-6.0.2.tar.gz.

File metadata

  • Download URL: do_sdk_platform-6.0.2.tar.gz
  • Upload date:
  • Size: 380.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for do_sdk_platform-6.0.2.tar.gz
Algorithm Hash digest
SHA256 cee91b146d209e2927e09a29252b235dcd66c77b15fd828efa6c373b78a71eb5
MD5 64e5bb0ac5a9b607d7dcc72d630cc4fb
BLAKE2b-256 45c9402d0b885aa2b40f51348c135ba415a802b4e0364e147a94c5b80812dfd5

See more details on using hashes here.

Provenance

The following attestation bundles were made for do_sdk_platform-6.0.2.tar.gz:

Publisher: platform.yaml on deeporiginbio/generated-sdks

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page