Reference

V1 Users

client.v1.users.list(...)

📝 Description

List all users of tenant filtered by query and showInvalidUsers. Pagination is available based on query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.users.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

query: typing.Optional[str]

show_invalid_users: typing.Optional[bool] — Show Deactivated users

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.users.update_roles(...)

📝 Description

This endpoint allows tenant administrators to update the roles of a user within their tenant.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.users.update_roles(email='email', roles=['roles'], )

⚙️ Parameters

email: str — Email of the user

roles: typing.Sequence[str] — Roles for the user

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.users.get(...)

📝 Description

Get User associated with provided User id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.users.get(id='id', )

⚙️ Parameters

id: str — User Id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.users.invite_user(...)

📝 Description

Invite a user to the tenant

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.users.invite_user(accept_invite_client_url='<control plane url>/invite-accept', email='email', )

⚙️ Parameters

accept_invite_client_url: str — Url to redirect when invite is accepted

email: str — Email of user

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.users.deactivate(...)

📝 Description

Deactivate user associated with the provided email within the tenant.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.users.deactivate(email='email', )

⚙️ Parameters

email: str — Email of the user

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.users.activate(...)

📝 Description

Activate user associated with the provided email within the tenant.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.users.activate(email='email', )

⚙️ Parameters

email: str — Email of the user

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Teams

client.v1.teams.list(...)

📝 Description

Retrieve all teams associated with the authenticated user. If the user is a tenant admin, returns all teams for the tenant. Pagination is available based on query parameters

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.teams.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.teams.create_or_update(...)

📝 Description

Creates a new team or updates an existing team. It ensures that the team name is unique, valid, and that the team has at least one member. The members of the team are added or updated based on the provided emails.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import TeamManifest
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.teams.create_or_update(manifest=TeamManifest(name='name', members=['members'], ), )

⚙️ Parameters

manifest: TeamManifest — Team manifest

dry_run: typing.Optional[bool] — Dry run

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.teams.get(...)

📝 Description

Get Team associated with provided team id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.teams.get(id='id', )

⚙️ Parameters

id: str — Team Id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.teams.delete(...)

📝 Description

Deletes the Team associated with the provided Id.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.teams.delete(id='id', )

⚙️ Parameters

id: str — Team Id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 PersonalAccessTokens

client.v1.personal_access_tokens.list(...)

📝 Description

List Personal Access Tokens created by the user in the current tenant.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.personal_access_tokens.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.personal_access_tokens.create(...)

📝 Description

Create Personal Access Token

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.personal_access_tokens.create(name='name', )

⚙️ Parameters

name: str — serviceaccount name

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.personal_access_tokens.delete(...)

📝 Description

Delete Personal Access Token associated with the provided serviceAccountId

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.personal_access_tokens.delete(id='id', )

⚙️ Parameters

id: str — serviceaccount id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 VirtualAccounts

client.v1.virtual_accounts.list(...)

📝 Description

List virtual accounts for the tenant.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.virtual_accounts.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.virtual_accounts.create_or_update(...)

📝 Description

Creates a new virtual account or updates an existing one based on the provided manifest.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import VirtualAccountManifest
from truefoundry_sdk import Permissions
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.virtual_accounts.create_or_update(manifest=VirtualAccountManifest(name='name', permissions=[Permissions(resource_fqn='resource_fqn', resource_type='resource_type', role_id='role_id', )], ), )

⚙️ Parameters

manifest: VirtualAccountManifest — Virtual account manifest

dry_run: typing.Optional[bool] — Dry run

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.virtual_accounts.get(...)

📝 Description

Get virtual account by id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.virtual_accounts.get(id='id', )

⚙️ Parameters

id: str — serviceaccount id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.virtual_accounts.delete(...)

📝 Description

Delete a virtual account associated with the provided virtual account id.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.virtual_accounts.delete(id='id', )

⚙️ Parameters

id: str — serviceaccount id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Secrets

client.v1.secrets.list(...)

📝 Description

List secrets associated with a user filtered with optional parameters passed in the body.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.secrets.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

secret_id: typing.Optional[str] — Secret Id of the secret.

secret_fqns: typing.Optional[typing.Sequence[str]] — Array of FQNs

secret_group_id: typing.Optional[str] — Secret Group Id of the secret gourp.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secrets.get(...)

📝 Description

Get Secret associated with provided id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secrets.get(id='id', )

⚙️ Parameters

id: str — Secret Id of the secret.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secrets.delete(...)

📝 Description

Deletes a secret and its versions along with its values.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secrets.delete(id='id', )

⚙️ Parameters

id: str — Secret Id of the secret.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 SecretGroups

client.v1.secret_groups.list(...)

📝 Description

List the secret groups associated with a user along with the associated secrets for each group. Filtered with the options passed in the query fields.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.secret_groups.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

secret_group_id: typing.Optional[str] — Secret Group Id of secret group.

secret_group_fqn: typing.Optional[str] — Fqn of secret group.

secret_attributes: typing.Optional[str] — Attributes to return for secret object provided as comma separated values (secretAttributes=id,fqn)

secret_group_attributes: typing.Optional[str] — Attributes returned for secret group object provided as comma separated values (secretGroupAttributes=id,fqn)

search: typing.Optional[str] — Search query - filters by secret group names that contain the search string

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secret_groups.create(...)

📝 Description

Creates a secret group with secrets in it. A secret version for each of the created secret is created with version number as 1. The returned secret group does not have any secrets in the associatedSecrets field. A separate API call should be made to fetch the associated secrets.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import SecretInput
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secret_groups.create(name='name', integration_id='integrationId', secrets=[SecretInput(key='key', value='value', )], )

⚙️ Parameters

name: str — Name of the secret group.

integration_id: str — Id of the provider integration.

secrets: typing.Sequence[SecretInput] — The secrets to be associated with the secret group

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secret_groups.get(...)

📝 Description

Get Secret Group associated with provided secretGroup id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secret_groups.get(id='id', )

⚙️ Parameters

id: str — Secret Id of the secret group.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secret_groups.update(...)

📝 Description

Updates the secrets in a secret group with new values. A new secret version is created for every secret that has a modified value. Returns the updated secret group. The returned secret group does not have any secrets in the associatedSecrets field. A separate API call should be made to fetch the associated secrets.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import UpdateSecretInput
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secret_groups.update(id='id', secrets=[UpdateSecretInput(key='key', value='value', )], )

⚙️ Parameters

id: str — Secret Id of the secret group.

secrets: typing.Sequence[UpdateSecretInput]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secret_groups.delete(...)

📝 Description

Deletes the secret group, its associated secrets and secret versions of those secrets.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secret_groups.delete(id='id', )

⚙️ Parameters

id: str — Secret Id of the secret group.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.secret_groups.list_secrets(...)

📝 Description

List Secrets associated with a Secret Group.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.secret_groups.list_secrets(id='id', )

⚙️ Parameters

id: str — Secret Id of the secret group.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Clusters

client.v1.clusters.list(...)

📝 Description

Retrieves a list of all latest Clusters. Pagination is available based on query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.clusters.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.clusters.create_or_update(...)

📝 Description

Create or Update cluster with provided manifest

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ClusterManifest
from truefoundry_sdk import ClusterManifestClusterType
from truefoundry_sdk import Collaborator
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.clusters.create_or_update(manifest=ClusterManifest(name='name', cluster_type=ClusterManifestClusterType.AWS_EKS, environment_names=['environment_names'], collaborators=[Collaborator(subject='subject', role_id='role_id', )], ), )

⚙️ Parameters

manifest: ClusterManifest — Cluster manifest

dry_run: typing.Optional[bool] — Dry run the cluster creation/update

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.clusters.get(...)

📝 Description

Get cluster associated with provided id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.clusters.get(id='id', )

⚙️ Parameters

id: str — Cluster id of the cluster

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.clusters.delete(...)

📝 Description

Delete cluster associated with provided cluster id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.clusters.delete(id='id', )

⚙️ Parameters

id: str — Cluster id of the cluster

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.clusters.get_addons(...)

📝 Description

List addons for the provided cluster.Pagination is available based on query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.clusters.get_addons(id='id', limit=10, offset=0, )

⚙️ Parameters

id: str — Cluster id of the cluster

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.clusters.is_connected(...)

📝 Description

Get the status of provided cluster

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.clusters.is_connected(id='id', )

⚙️ Parameters

id: str — Cluster id of the cluster

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Environments

client.v1.environments.list(...)

📝 Description

List environments, if no environments are found, default environments are created and returned. Pagination is available based on query parameters

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.environments.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.environments.create_or_update(...)

📝 Description

Creates a new Environment or updates an existing Environment.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import EnvironmentManifest
from truefoundry_sdk import EnvironmentColor
from truefoundry_sdk import EnvironmentOptimizeFor
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.environments.create_or_update(manifest=EnvironmentManifest(name='name', color=EnvironmentColor(), is_production=True, optimize_for=EnvironmentOptimizeFor.COST, ), )

⚙️ Parameters

manifest: EnvironmentManifest — Environment Manifest

dry_run: typing.Optional[bool] — Dry run

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.environments.get(...)

📝 Description

Get Environment associated with the provided id.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.environments.get(id='id', )

⚙️ Parameters

id: str — Environment id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.environments.delete(...)

📝 Description

Delete Environment associated with the provided id.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.environments.delete(id='id', )

⚙️ Parameters

id: str — Environment id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Applications

client.v1.applications.list(...)

📝 Description

Retrieves a list of all latest applications. Supports filtering by application ID, name, type, and other parameters. Pagination is available based on query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.applications.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

application_id: typing.Optional[str] — Application id of the application

workspace_id: typing.Optional[str] — Workspace id of the application (comma separated for multiple)

application_name: typing.Optional[str] — Name of application

application_type: typing.Optional[str] — Type of application (comma separated for multiple). Allowed Values: async-service, service, job, spark-job, helm, notebook, codeserver, rstudio, ssh-server, volume, application, application-set, intercept, workflow

name_search_query: typing.Optional[str] — Search query for application name

environment_id: typing.Optional[str] — Filter by Environment ids of the application (comma separated for multiple)

cluster_id: typing.Optional[str] — Filter by Cluster ids of the application (comma separated for multiple)

application_set_id: typing.Optional[str] — Filter by Application Set id of the application

paused: typing.Optional[bool] — Filter by Application Paused status

device_type_filter: typing.Optional[ApplicationsListRequestDeviceTypeFilter] — Filter by device type of the application. Allowed values: cpu, nvidia_gpu, aws_inferentia, nvidia_mig_gpu, nvidia_timeslicing_gpu, gcp_tpu

last_deployed_by_subjects: typing.Optional[str] — Filter by last deployed by specific users

lifecycle_stage: typing.Optional[ApplicationsListRequestLifecycleStage] — Filter by application lifecycle state

is_recommendation_present: typing.Optional[bool] — Filter out applications with recommendations

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.applications.create_or_update(...)

📝 Description

Create a new Application Deployment based on the provided manifest.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.applications.create_or_update(manifest={'key': 'value'
}, )

⚙️ Parameters

manifest: typing.Dict[str, typing.Optional[typing.Any]] — Manifest of application

dry_run: typing.Optional[bool] — Dry run

force_deploy: typing.Optional[bool] — Cancels any ongoing deployments

workspace_id: typing.Optional[str] — workspace id of the workspace

application_id: typing.Optional[str] — Id of the application

name: typing.Optional[str] — Name of application

application_set_id: typing.Optional[str] — Application Set Id

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.applications.get(...)

📝 Description

Get Application associated with the provided application ID.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.applications.get(id='id', )

⚙️ Parameters

id: str — Id of the application

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.applications.delete(...)

📝 Description

Delete Application associated with the provided application ID.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.applications.delete(id='id', )

⚙️ Parameters

id: str — Id of the application

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.applications.scale_to_zero(...)

📝 Description

Pause a running application by scaling to 0 replicas

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.applications.scale_to_zero(id='id', )

⚙️ Parameters

id: str — Id of the application

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.applications.scale_to_original(...)

📝 Description

Resume a paused application by scaling back to the original number of replicas

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.applications.scale_to_original(id='id', )

⚙️ Parameters

id: str — Id of the application

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.applications.cancel_deployment(...)

📝 Description

Cancel an ongoing deployment associated with the provided application ID and deployment ID.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.applications.cancel_deployment(id='id', deployment_id='deploymentId', )

⚙️ Parameters

id: str — Application id of the application

deployment_id: str — Deployment id of the deployment

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 ApplicationVersions

client.v1.application_versions.list(...)

📝 Description

Fetch all deployments for a given application ID with optional filters such as deployment ID or version. Supports pagination.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.application_versions.list(id='id', limit=10, offset=0, version='1', deployment_id='deployment123', )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

id: str — Id of the application

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

version: typing.Optional[str] — Deployment version. Filter deployments by version.

deployment_id: typing.Optional[str] — Deployment ID. Filter deployments by a specific ID.

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.application_versions.get(...)

📝 Description

Get Deployment associated with the provided application ID and deployment ID.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.application_versions.get(id='id', deployment_id='deploymentId', )

⚙️ Parameters

id: str — Application id of the application

deployment_id: str — Deployment id of the deployment

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Jobs

client.v1.jobs.list_runs(...)

📝 Description

List Job Runs for provided Job Id. Filter the data based on parameters passed in the query

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.jobs.list_runs(job_id='jobId', limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

job_id: str — Job id of the application

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

search_prefix: typing.Optional[str] — Prefix used to search for job runs by name or identifier

sort_by: typing.Optional[JobRunsSortBy] — Attribute to sort by

order: typing.Optional[JobRunsSortDirection] — Sorting order

triggered_by: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Array of subject slugs

status: typing.Optional[typing.Union[JobRunStatus, typing.Sequence[JobRunStatus]]] — Status of the job run

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.jobs.get_run(...)

📝 Description

Get Job Run for provided jobRunName and jobId

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.jobs.get_run(job_id='jobId', job_run_name='jobRunName', )

⚙️ Parameters

job_id: str — Application Id of JOB

job_run_name: str — Job run name of the application

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.jobs.delete_run(...)

📝 Description

Delete Job Run for provided jobRunName and jobId

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.jobs.delete_run(job_id='jobId', job_run_name='jobRunName', )

⚙️ Parameters

job_id: str — Application Id of JOB

job_run_name: str — Job run name of the application

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.jobs.trigger(...)

📝 Description

Trigger Job for provided deploymentId or applicationId

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.jobs.trigger()

⚙️ Parameters

deployment_id: typing.Optional[str] — Deployment Id of the job

application_id: typing.Optional[str] — Application Id of the job

input: typing.Optional[TriggerJobRequestInput] — Job trigger input

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.jobs.terminate(...)

📝 Description

Terminate Job for provided deploymentId and jobRunName

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.jobs.terminate(deployment_id='deploymentId', job_run_name='jobRunName', )

⚙️ Parameters

deployment_id: str — Deployment Id of the Deployment

job_run_name: str — Job Run name

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Workspaces

client.v1.workspaces.list(...)

📝 Description

List workspaces associated with the user. Optional filters include clusterId, fqn, and workspace name. Pagination is available based on query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.workspaces.list(limit=10, offset=0, )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

limit: typing.Optional[int] — Number of items per page

offset: typing.Optional[int] — Number of items to skip

cluster_id: typing.Optional[str] — ClusterId of the Cluster

name: typing.Optional[str] — Workspace Name

fqn: typing.Optional[str] — Workspace FQN

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.workspaces.create_or_update(...)

📝 Description

Creates a new workspace or updates an existing one based on the provided manifest.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import WorkspaceManifest
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.workspaces.create_or_update(manifest=WorkspaceManifest(cluster_fqn='cluster_fqn', name='name', ), )

⚙️ Parameters

manifest: WorkspaceManifest — Workspace manifest

dry_run: typing.Optional[bool] — Dry run the request

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.workspaces.get(...)

📝 Description

Get workspace associated with provided workspace id

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.workspaces.get(id='id', )

⚙️ Parameters

id: str — Workspace id of the space

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.workspaces.delete(...)

📝 Description

Deletes the workspace with the given workspace ID. - Removes the associated namespace from the cluster. - Deletes the corresponding authorization entry.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.workspaces.delete(id='id', )

⚙️ Parameters

id: str — Workspace id of the space

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Events

client.v1.events.get(...)

📝 Description

Get Events for Pod, Job Run, Application. The events are sourced from Kubernetes as well as events captured by truefoundry. Optional query parameters include startTs, endTs for filtering.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.events.get()

⚙️ Parameters

start_ts: typing.Optional[str] — Start timestamp (ISO format) for querying events

end_ts: typing.Optional[str] — End timestamp (ISO format) for querying events

application_id: typing.Optional[str] — Application ID

application_fqn: typing.Optional[str] — Application FQN

pod_names: typing.Optional[typing.Union[str, typing.Sequence[str]]] — Name of the pods

job_run_name: typing.Optional[str] — Job run name

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Alerts

client.v1.alerts.list(...)

📝 Description

Get alerts for a given application or cluster filtered by start and end timestamp

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.alerts.list()

⚙️ Parameters

start_ts: typing.Optional[str] — Start timestamp (ISO format) for querying events

end_ts: typing.Optional[str] — End timestamp (ISO format) for querying events

cluster_id: typing.Optional[str] — Cluster id

application_id: typing.Optional[str] — Application id

alert_status: typing.Optional[AlertStatus] — Alert status

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Logs

client.v1.logs.get(...)

📝 Description

Fetch logs for various workload components, including Services, Jobs, Workflows, Job Runs, and Pods. Logs are filtered based on the provided query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.logs.get()

⚙️ Parameters

start_ts: typing.Optional[int] — Start timestamp for querying logs, in nanoseconds from the Unix epoch.

end_ts: typing.Optional[int] — End timestamp for querying logs, in nanoseconds from the Unix epoch.

limit: typing.Optional[int] — Max number of log lines to fetch

direction: typing.Optional[LogsSortingDirection] — Direction of sorting logs. Can be asc or desc

num_logs_to_ignore: typing.Optional[int] — Number of logs corresponding to the starting timestamp to be ignored.

application_id: typing.Optional[str] — Application ID

application_fqn: typing.Optional[str] — Application FQN

deployment_id: typing.Optional[str] — Deployment ID

job_run_name: typing.Optional[str] — Name of the Job Run for which to fetch logs.

pod_name: typing.Optional[str] — Name of Pod for which to fetch logs.

container_name: typing.Optional[str] — Name of the Container for which to fetch logs.

pod_names: typing.Optional[typing.Union[str, typing.Sequence[str]]] — List of pod names for which to fetch logs.

pod_names_regex: typing.Optional[str] — Regex pattern for pod names to fetch logs.

search_string: typing.Optional[str] — String that needs to be matched

search_type: typing.Optional[LogsSearchFilterType] — Query filter type, regex or substring

search_operator: typing.Optional[LogsSearchOperatorType] — Comparison operator for filter. equal or not_equal

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 MlRepos

client.v1.ml_repos.create_or_update(...)

📝 Description

Creates or updates an MLRepo entity based on the provided manifest.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.ml_repos.create_or_update(manifest={'key': 'value'
}, )

⚙️ Parameters

manifest: typing.Dict[str, typing.Optional[typing.Any]] — MLRepo manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.ml_repos.get(...)

📝 Description

Get a ml repo by id Args: id: Unique identifier of the ml repo to get user_info: Authenticated user information

Returns: GetMLRepoResponse: The ml repo

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.ml_repos.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.ml_repos.delete(...)

📝 Description

Delete a ml repo Args: id: Unique identifier of the ml repo to delete user_info: Authenticated user information

Returns: EmptyResponse: Empty response indicating successful deletion

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.ml_repos.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.ml_repos.list(...)

📝 Description

List ml repos Args: filters: Filters for the ml repos user_info: Authenticated user information

Returns: ListMLReposResponse: List of ml repos

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.ml_repos.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

name: typing.Optional[str]

limit: typing.Optional[int]

offset: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Artifacts

client.v1.artifacts.get(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifacts.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifacts.delete(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifacts.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifacts.list(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.artifacts.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[str]

name: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

run_id: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifacts.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifacts.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Agents

client.v1.agents.get(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.agents.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.agents.delete(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.agents.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.agents.list(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.agents.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[str]

name: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.agents.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.agents.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Prompts

client.v1.prompts.get(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.prompts.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.prompts.delete(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.prompts.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.prompts.list(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.prompts.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[str]

name: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.prompts.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.prompts.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Tools

client.v1.tools.get(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tools.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tools.delete(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tools.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tools.list(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.tools.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[str]

name: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tools.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tools.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Models

client.v1.models.get(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.models.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.models.delete(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.models.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.models.list(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.models.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[str]

name: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

run_id: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.models.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.models.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 ArtifactVersions

client.v1.artifact_versions.get(...)

📝 Description

Get artifact version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifact_versions.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.delete(...)

📝 Description

Delete artifact versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifact_versions.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.list(...)

📝 Description

List artifact version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.artifact_versions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

artifact_id: typing.Optional[str]

fqn: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

run_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]]

run_steps: typing.Optional[typing.Union[int, typing.Sequence[int]]]

include_internal_metadata: typing.Optional[bool]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.get_signed_urls(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import Operation
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifact_versions.get_signed_urls(id='id', paths=['paths'], operation=Operation.READ, )

⚙️ Parameters

id: str

paths: typing.Sequence[str]

operation: Operation

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.create_multi_part_upload(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifact_versions.create_multi_part_upload(id='id', path='path', num_parts=1, )

⚙️ Parameters

id: str

path: str

num_parts: int

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.stage(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifact_versions.stage(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.list_files(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.artifact_versions.list_files(id='id', )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

id: str

path: typing.Optional[str]

limit: typing.Optional[int]

page_token: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.artifact_versions.mark_stage_failure(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.artifact_versions.mark_stage_failure(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 ModelVersions

client.v1.model_versions.get(...)

📝 Description

Get model version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.model_versions.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.model_versions.delete(...)

📝 Description

Delete model versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.model_versions.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.model_versions.list(...)

📝 Description

List model version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.model_versions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

model_id: typing.Optional[str]

fqn: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

run_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]]

run_steps: typing.Optional[typing.Union[int, typing.Sequence[int]]]

include_internal_metadata: typing.Optional[bool]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 PromptVersions

client.v1.prompt_versions.get(...)

📝 Description

Get prompt version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.prompt_versions.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.prompt_versions.delete(...)

📝 Description

Delete prompt versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.prompt_versions.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.prompt_versions.list(...)

📝 Description

List prompt version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.prompt_versions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

prompt_id: typing.Optional[str]

fqn: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 ToolVersions

client.v1.tool_versions.get(...)

📝 Description

Get tool version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tool_versions.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tool_versions.delete(...)

📝 Description

Delete tool versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tool_versions.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tool_versions.list(...)

📝 Description

List tool versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.tool_versions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

tool_id: typing.Optional[str]

fqn: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 AgentVersions

client.v1.agent_versions.resolve(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.agent_versions.resolve(fqn='fqn', )

⚙️ Parameters

fqn: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.agent_versions.get(...)

📝 Description

Get agent version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.agent_versions.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.agent_versions.delete(...)

📝 Description

Delete agent versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.agent_versions.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.agent_versions.list(...)

📝 Description

List agent versions API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.agent_versions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

agent_id: typing.Optional[str]

fqn: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 DataDirectories

client.v1.data_directories.get(...)

📝 Description

Get a data directory by its ID.

Args: id (str): The ID of the data directory to retrieve user_info: Current authenticated user info

Returns: DataDirectoryResponse: Response containing the retrieved data directory

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.data_directories.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.delete(...)

📝 Description

Delete a data directory and optionally its contents.

Args: id: Unique identifier of the data directory to delete delete_contents: If True, also deletes the data directory's contents user_info: Authenticated user information

Returns: EmptyResponse: Empty response indicating successful deletion

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.data_directories.delete(id='id', )

⚙️ Parameters

id: str

delete_contents: typing.Optional[bool]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.list(...)

📝 Description

List all data directories with optional filtering and pagination.

Args: filters: Query parameters for filtering and pagination - ml_repo_id: Filter data directories by ml repo ID - name: Optional filter data directories by name - limit: Optional maximum number of data directories to return - offset: Optional number of data directories to skip user_info: Authenticated user information

Returns: ListDataDirectoriesResponse: List of data directories and pagination info

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.data_directories.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[str]

name: typing.Optional[str]

limit: typing.Optional[int]

offset: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.data_directories.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.list_files(...)

📝 Description

List files in a dataset.

Args: request_dto: Request containing dataset ID, path, page token and limit user_info: Authenticated user information

Returns: ListFilesResponse: Response containing files and pagination info

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.data_directories.list_files(id='id', )
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

id: str

path: typing.Optional[str]

limit: typing.Optional[int]

page_token: typing.Optional[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.delete_files(...)

📝 Description

Delete files from the dataset.

Args: request_dto: Request containing dataset ID and paths user_info: Authenticated user information

Returns: EmptyResponse: Empty response indicating successful deletion

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.data_directories.delete_files(id='id', paths=['paths'], )

⚙️ Parameters

id: str

paths: typing.Sequence[str]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.get_signed_urls(...)

📝 Description

Get signed URLs for a dataset.

Args: request_dto: Request containing dataset ID, paths and operation user_info: Authenticated user information

Returns: GetSignedURLsResponse: Response containing signed URLs

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import Operation
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.data_directories.get_signed_urls(id='id', paths=['paths'], operation=Operation.READ, )

⚙️ Parameters

id: str

paths: typing.Sequence[str]

operation: Operation

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.data_directories.create_multipart_upload(...)

📝 Description

Create a multipart upload for a dataset

Args: request_dto: Request containing dataset ID, path and number of parts user_info: Authenticated user information

Returns: MultiPartUploadResponse: Response containing multipart upload info

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.data_directories.create_multipart_upload(id='id', path='path', num_parts=1, )

⚙️ Parameters

id: str

path: str

num_parts: int

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 TracingProjects

client.v1.tracing_projects.list(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.tracing_projects.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

ml_repo_id: typing.Optional[int]

fqn: typing.Optional[str]

name: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tracing_projects.create_or_update(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ModelManifest
from truefoundry_sdk import TrueFoundryManagedSource
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tracing_projects.create_or_update(manifest=ModelManifest(name='name', metadata={'key': 'value'
}, ml_repo='ml_repo', source=TrueFoundryManagedSource(), ), )

⚙️ Parameters

manifest: Manifest

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tracing_projects.get(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tracing_projects.get(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.tracing_projects.delete(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.tracing_projects.delete(id='id', )

⚙️ Parameters

id: str

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal Users

client.v1.internal.users.get_info()

📝 Description

Get the user session details for the currently authenticated user

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.users.get_info()

⚙️ Parameters

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal Clusters

client.v1.internal.clusters.get_autoprovisioning_state(...)

📝 Description

Get the auto provisioning status for the provided cluster

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.clusters.get_autoprovisioning_state(id='id', )

⚙️ Parameters

id: str — Cluster id of the cluster

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal Deployments

client.v1.internal.deployments.get_builds(...)

📝 Description

This endpoint returns all build details associated with a specific deployment in a given application.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.deployments.get_builds(id='id', deployment_id='deploymentId', )

⚙️ Parameters

id: str — Application id of the application

deployment_id: str — Deployment id of the deployment

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.internal.deployments.get_code_upload_url(...)

📝 Description

Generate presigned URL to upload code for given serviceName and workspaceFqn

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.deployments.get_code_upload_url(service_name='serviceName', workspace_fqn='workspaceFqn', )

⚙️ Parameters

service_name: str — ServiceName of the deployment

workspace_fqn: str — WorkSpaceFQN of the workspace

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.internal.deployments.get_suggested_endpoint(...)

📝 Description

Generate deployment endpoint based on the provided query parameters.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk import ApplicationType
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.deployments.get_suggested_endpoint(application_type=ApplicationType.ASYNC_SERVICE, application_name='applicationName', workspace_id='workspaceId', )

⚙️ Parameters

application_type: ApplicationType — Application Type

application_name: str — Application name

workspace_id: str — Workspace id

base_domain: typing.Optional[str] — Base domain

port: typing.Optional[str] — Port

prefer_wildcard: typing.Optional[bool] — Prefer wildcard

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal Applications

client.v1.internal.applications.get_pod_template_hash_to_deployment_version(...)

📝 Description

This endpoint fetches the pod template hash to deployment version map for a specific application.

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.applications.get_pod_template_hash_to_deployment_version(id='id', )

⚙️ Parameters

id: str — Id of the application

pod_template_hashes: typing.Optional[str] — Pod Template Hashes (comma separated for multiple)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal Vcs

client.v1.internal.vcs.get_repository_details(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.vcs.get_repository_details(repo_url='repoURL', )

⚙️ Parameters

repo_url: str — The URL of the repository

id: typing.Optional[str] — The integration id of the repository

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

client.v1.internal.vcs.get_authenticated_url(...)

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.vcs.get_authenticated_url(repo_url='repoURL', )

⚙️ Parameters

repo_url: str — Repository URL (e.g., https://github.com/user/repo, https://bitbucket.org/user/repo)

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal Metrics

client.v1.internal.metrics.get_charts(...)

📝 Description

List charts for a given Application based on parameters passed in the query.

🔌 Usage

from truefoundry_sdk import TrueFoundry
from truefoundry_sdk.v1.internal.metrics import MetricsGetChartsRequestFilterEntity
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
client.v1.internal.metrics.get_charts(workspace_id='workspaceId', application_id='applicationId', filter_entity=MetricsGetChartsRequestFilterEntity.APPLICATION, )

⚙️ Parameters

workspace_id: str

application_id: str

filter_entity: MetricsGetChartsRequestFilterEntity

start_ts: typing.Optional[str] — Start Timestamp

end_ts: typing.Optional[str] — End Timestamp

filter_query: typing.Optional[str] — Query params to filter metrics

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

V1 Internal ArtifactVersions

client.v1.internal.artifact_versions.list(...)

📝 Description

List artifact version API

🔌 Usage

from truefoundry_sdk import TrueFoundry
client = TrueFoundry(api_key="YOUR_API_KEY", base_url="https://yourhost.com/path/to/api", )
response = client.v1.internal.artifact_versions.list()
for item in response:
    yield item
# alternatively, you can paginate page-by-page
for page in response.iter_pages():
    yield page

⚙️ Parameters

artifact_id: typing.Optional[str]

fqn: typing.Optional[str]

offset: typing.Optional[int]

limit: typing.Optional[int]

run_ids: typing.Optional[typing.Union[str, typing.Sequence[str]]]

run_steps: typing.Optional[typing.Union[int, typing.Sequence[int]]]

include_internal_metadata: typing.Optional[bool]

include_model_versions: typing.Optional[bool]

request_options: typing.Optional[RequestOptions] — Request-specific configuration.

Files

reference.md

Latest commit

History

reference.md

File metadata and controls

Reference

V1 Users

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

V1 Teams

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

V1 PersonalAccessTokens

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

V1 VirtualAccounts

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

V1 Secrets

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

V1 SecretGroups

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description

🔌 Usage

⚙️ Parameters

📝 Description