ubiops

www.ubiops.com

Client Library to interact with the UbiOps API.

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

• API version: v2.1
• Package version: 4.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

For more information, please visit https://ubiops.com/docs

Requirements

Python 3.8+. Python 3.13+ is recommended.

Installation & Usage

pip install

You can install directly using:

pip install ubiops

(you may need to run pip with root permission: sudo pip install ubiops)

Then import the package:

importubiops

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:

importubiops

Troubleshooting

Python 3.10/11/12 raise a SSLError (EOF occurred in violation of protocol) instead of Request Entity Too Large (413) for too large file uploads, see urllib3/urllib3#2733.

Getting Started

Please follow the installation procedure and then run the following:

• Use system environment variables

  importubiops# Set environment variables# - UBIOPS_API_TOKEN: "Token <YOUR_API_TOKEN>"# - UBIOPS_API_HOST: optional - default to "https://api.ubiops.com/v2.1"core_api=ubiops.CoreApi()
  api_response=core_api.service_status()
  print(api_response)
  # Close the connectioncore_api.api_client.close()

• Use authorization parameters

  importubiopsconfiguration=ubiops.Configuration()
  # Configure API token authorizationconfiguration.api_key['Authorization'] ="Token <YOUR_API_TOKEN>"# Defining host is optional and default to "https://api.ubiops.com/v2.1"configuration.host="https://api.ubiops.com/v2.1"api_client=ubiops.ApiClient(configuration)
  core_api=ubiops.CoreApi(api_client)
  api_response=core_api.service_status()
  print(api_response)
  # Close the connectionapi_client.close()

Rate limiting

This package will automatically retry requests when rate limits are exceeded. You can turn this off by changing the auto_retry_rate_limiting setting on the ubiops.Configuration object.

importubiopsconfiguration=ubiops.Configuration()
configuration.auto_retry_rate_limiting=False

Or for an existing CoraApi object, turn it off by changing the auto_retry_rate_limiting setting on the rest_client.

importubiopscore_api=ubiops.CoreApi()
core_api.api_client.rest_client.auto_retry_rate_limiting=False

Documentation for API Endpoints

All URIs are relative to https://api.ubiops.com/v2.1

Class	Method	HTTP request	Description
DeploymentRequests	batch_deployment_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/requests/batch	Create a batch deployment request
DeploymentRequests	batch_deployment_version_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/batch	Create a batch deployment version request
DeploymentRequests	deployment_requests_batch_cancel	POST /projects/{project_name}/deployments/{deployment_name}/requests/cancel	Cancel multiple deployment requests
DeploymentRequests	deployment_requests_batch_delete	POST /projects/{project_name}/deployments/{deployment_name}/requests/delete	Delete multiple deployment requests
DeploymentRequests	deployment_requests_batch_get	POST /projects/{project_name}/deployments/{deployment_name}/requests/collect	Retrieve multiple deployment requests
DeploymentRequests	deployment_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/requests	Create a direct deployment request
DeploymentRequests	deployment_requests_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}	Delete a deployment request
DeploymentRequests	deployment_requests_get	GET /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}	Get a deployment request
DeploymentRequests	deployment_requests_input_get	GET /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}/input	Get a deployment request input
DeploymentRequests	deployment_requests_list	GET /projects/{project_name}/deployments/{deployment_name}/requests	List deployment requests
DeploymentRequests	deployment_requests_output_get	GET /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}/output	Get a deployment request output
DeploymentRequests	deployment_requests_update	PATCH /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}	Update a deployment request
DeploymentRequests	deployment_version_requests_batch_cancel	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/cancel	Delete multiple deployment version requests
DeploymentRequests	deployment_version_requests_batch_delete	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/delete	Delete multiple deployment version requests
DeploymentRequests	deployment_version_requests_batch_get	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/collect	Retrieve multiple deployment version requests
DeploymentRequests	deployment_version_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests	Create a direct deployment version request
DeploymentRequests	deployment_version_requests_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}	Delete a deployment version request
DeploymentRequests	deployment_version_requests_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}	Get a deployment version request
DeploymentRequests	deployment_version_requests_input_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}/input	Get a deployment request input
DeploymentRequests	deployment_version_requests_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests	List deployment version requests
DeploymentRequests	deployment_version_requests_output_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}/output	Get a deployment request output
DeploymentRequests	deployment_version_requests_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}	Update a deployment version request
Deployments	deployment_audit_events_list	GET /projects/{project_name}/deployments/{deployment_name}/audit	List audit events for a deployment
Deployments	deployment_environment_variables_copy	POST /projects/{project_name}/deployments/{deployment_name}/copy-environment-variables	Copy deployment environment variable
Deployments	deployment_environment_variables_create	POST /projects/{project_name}/deployments/{deployment_name}/environment-variables	Create deployment environment variable
Deployments	deployment_environment_variables_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/environment-variables/{id}	Delete deployment environment variable
Deployments	deployment_environment_variables_get	GET /projects/{project_name}/deployments/{deployment_name}/environment-variables/{id}	Get deployment environment variable
Deployments	deployment_environment_variables_list	GET /projects/{project_name}/deployments/{deployment_name}/environment-variables	List deployment environment variables
Deployments	deployment_environment_variables_update	PATCH /projects/{project_name}/deployments/{deployment_name}/environment-variables/{id}	Update deployment environment variable
Deployments	deployment_version_environment_variables_copy	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/copy-environment-variables	Copy deployment version environment variable
Deployments	deployment_version_environment_variables_create	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables	Create deployment version environment variable
Deployments	deployment_version_environment_variables_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables/{id}	Delete deployment version environment variable
Deployments	deployment_version_environment_variables_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables/{id}	Get deployment version environment variable
Deployments	deployment_version_environment_variables_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables	List deployment version environment variables
Deployments	deployment_version_environment_variables_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables/{id}	Update deployment version environment variable
Deployments	deployment_versions_create	POST /projects/{project_name}/deployments/{deployment_name}/versions	Create deployment versions
Deployments	deployment_versions_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/versions/{version}	Delete deployment version
Deployments	deployment_versions_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}	Get deployment version
Deployments	deployment_versions_list	GET /projects/{project_name}/deployments/{deployment_name}/versions	List deployment versions
Deployments	deployment_versions_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}	Update deployment version
Deployments	deployments_create	POST /projects/{project_name}/deployments	Create deployments
Deployments	deployments_delete	DELETE /projects/{project_name}/deployments/{deployment_name}	Delete a deployment
Deployments	deployments_get	GET /projects/{project_name}/deployments/{deployment_name}	Get details of a deployment
Deployments	deployments_list	GET /projects/{project_name}/deployments	List deployments
Deployments	deployments_update	PATCH /projects/{project_name}/deployments/{deployment_name}	Update a deployment
Deployments	revisions_file_download	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions/{revision_id}/download	Download deployment file
Deployments	revisions_file_upload	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions	Upload deployment file
Deployments	revisions_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions/{revision_id}	Get revision
Deployments	revisions_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions	List revisions
Deployments	revisions_rebuild	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions/{revision_id}/rebuild	Rebuild revision
Deployments	template_deployments_list	GET /template-deployments	List template deployments
Environments	environment_build_dependencies_list	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds/{build_id}/dependency-files	List dependency files
Environments	environment_builds_get	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds/{build_id}	Get build
Environments	environment_builds_list	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds	List builds
Environments	environment_builds_update	PATCH /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds/{build_id}	Update build
Environments	environment_revisions_file_download	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/download	Download environment file
Environments	environment_revisions_file_upload	POST /projects/{project_name}/environments/{environment_name}/revisions	Upload environment file
Environments	environment_revisions_get	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}	Get revision
Environments	environment_revisions_list	GET /projects/{project_name}/environments/{environment_name}/revisions	List revisions
Environments	environment_revisions_rebuild	POST /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/rebuild	Rebuild revision
Environments	environment_secrets_copy	POST /projects/{project_name}/environments/{environment_name}/copy-secrets	Copy environment secret
Environments	environment_secrets_create	POST /projects/{project_name}/environments/{environment_name}/secrets	Create environment secret
Environments	environment_secrets_delete	DELETE /projects/{project_name}/environments/{environment_name}/secrets/{id}	Delete environment secret
Environments	environment_secrets_get	GET /projects/{project_name}/environments/{environment_name}/secrets/{id}	Get environment secret
Environments	environment_secrets_list	GET /projects/{project_name}/environments/{environment_name}/secrets	List environment secrets
Environments	environment_secrets_update	PATCH /projects/{project_name}/environments/{environment_name}/secrets/{id}	Update environment secret
Environments	environments_create	POST /projects/{project_name}/environments	Create environments
Environments	environments_delete	DELETE /projects/{project_name}/environments/{environment_name}	Delete environment
Environments	environments_get	GET /projects/{project_name}/environments/{environment_name}	Get environment
Environments	environments_list	GET /projects/{project_name}/environments	List environments
Environments	environments_update	PATCH /projects/{project_name}/environments/{environment_name}	Update environment
Environments	environments_usage	GET /projects/{project_name}/environments/{environment_name}/usage	List usage of environment
Files	buckets_create	POST /projects/{project_name}/buckets	Create bucket
Files	buckets_delete	DELETE /projects/{project_name}/buckets/{bucket_name}	Delete a bucket
Files	buckets_get	GET /projects/{project_name}/buckets/{bucket_name}	Get details of a bucket
Files	buckets_list	GET /projects/{project_name}/buckets	List buckets
Files	buckets_update	PATCH /projects/{project_name}/buckets/{bucket_name}	Update a bucket
Files	files_complete_multipart_upload	POST /projects/{project_name}/buckets/{bucket_name}/files/{file}/complete-multipart-upload	Complete multipart upload
Files	files_delete	DELETE /projects/{project_name}/buckets/{bucket_name}/files/{file}	Delete a file
Files	files_download	GET /projects/{project_name}/buckets/{bucket_name}/files/{file}/download	Download a file
Files	files_get	GET /projects/{project_name}/buckets/{bucket_name}/files/{file}	Get a file
Files	files_list	GET /projects/{project_name}/buckets/{bucket_name}/files	List files
Files	files_start_multipart_upload	POST /projects/{project_name}/buckets/{bucket_name}/files/{file}/start-multipart-upload	Start multipart upload
Files	files_upload	POST /projects/{project_name}/buckets/{bucket_name}/files/{file}	Upload a file
ImportsAndExports	exports_create	POST /projects/{project_name}/exports	Create an export
ImportsAndExports	exports_delete	DELETE /projects/{project_name}/exports/{export_id}	Delete an export
ImportsAndExports	exports_download	GET /projects/{project_name}/exports/{export_id}/download	Download an export
ImportsAndExports	exports_get	GET /projects/{project_name}/exports/{export_id}	Get an export
ImportsAndExports	exports_list	GET /projects/{project_name}/exports	List exports
ImportsAndExports	imports_create	POST /projects/{project_name}/imports	Create an import
ImportsAndExports	imports_delete	DELETE /projects/{project_name}/imports/{import_id}	Delete an import
ImportsAndExports	imports_download	GET /projects/{project_name}/imports/{import_id}/download	Download an import
ImportsAndExports	imports_get	GET /projects/{project_name}/imports/{import_id}	Get an import
ImportsAndExports	imports_list	GET /projects/{project_name}/imports	List imports
ImportsAndExports	imports_update	PATCH /projects/{project_name}/imports/{import_id}	Confirm an import
Instances	instance_events_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/instances/{instance_id}/events	List events for instances
Instances	instance_type_groups_create	POST /projects/{project_name}/instance-type-groups	Create instance type group
Instances	instance_type_groups_delete	DELETE /projects/{project_name}/instance-type-groups/{instance_type_group_id}	Delete instance type group
Instances	instance_type_groups_get	GET /projects/{project_name}/instance-type-groups/{instance_type_group_id}	Get instance type group
Instances	instance_type_groups_list	GET /projects/{project_name}/instance-type-groups	List instance type groups
Instances	instance_type_groups_update	PATCH /projects/{project_name}/instance-type-groups/{instance_type_group_id}	Update instance type group
Instances	instance_type_groups_usage	GET /projects/{project_name}/instance-type-groups/{instance_type_group_id}/usage	List usage of instance type group
Instances	instance_types_list	GET /projects/{project_name}/instance-types	List instance types
Instances	instances_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/instances/{instance_id}	Get instance for deployment versions
Instances	instances_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/instances	List instances for deployment versions
Instances	instances_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}/instances/{instance_id}	Update instance for deployment versions
Instances	project_instances_get	GET /projects/{project_name}/instances/{instance_id}	Get instance for projects
Instances	project_instances_list	GET /projects/{project_name}/instances	List instances for projects
Instances	project_instances_update	PATCH /projects/{project_name}/instances/{instance_id}	Update instance for projects
Metrics	metrics_create	POST /projects/{project_name}/metrics	Create metrics
Metrics	metrics_delete	DELETE /projects/{project_name}/metrics/{metric_name}	Delete metric
Metrics	metrics_get	GET /projects/{project_name}/metrics/{metric_name}	Get metric
Metrics	metrics_list	GET /projects/{project_name}/metrics	List metrics
Metrics	metrics_update	PATCH /projects/{project_name}/metrics/{metric_name}	Update metric
Metrics	time_series_data_aggregate	POST /projects/{project_name}/time-series/aggregate	Aggregate metric data
Metrics	time_series_data_create	POST /projects/{project_name}/time-series/data	Create metric data
Metrics	time_series_data_list	GET /projects/{project_name}/time-series/data	List time series data
Metrics	time_series_delete	DELETE /projects/{project_name}/time-series/{time_series_id}	Delete time series
Metrics	time_series_search	GET /projects/{project_name}/time-series/search	Search time series
Organizations	organization_users_create	POST /organizations/{organization_name}/users	Add a user to an organization
Organizations	organization_users_delete	DELETE /organizations/{organization_name}/users/{user_id}	Delete a user from an organization
Organizations	organization_users_get	GET /organizations/{organization_name}/users/{user_id}	Get details of a user in an organization
Organizations	organization_users_list	GET /organizations/{organization_name}/users	List the users in an organization
Organizations	organization_users_update	PATCH /organizations/{organization_name}/users/{user_id}	Update details of a user in an organization
Organizations	organizations_create	POST /organizations	Create organizations
Organizations	organizations_get	GET /organizations/{organization_name}	Get details of an organization
Organizations	organizations_list	GET /organizations	List organizations
Organizations	organizations_resource_usage	GET /organizations/{organization_name}/resources	Get resource usage
Organizations	organizations_update	PATCH /organizations/{organization_name}	Update details of an organization
Organizations	organizations_usage_get	GET /organizations/{organization_name}/usage	Get organization usage
Organizations	vouchers_get	GET /vouchers/{code}	Get voucher
PipelineRequests	batch_pipeline_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/batch	Create a batch pipeline request
PipelineRequests	batch_pipeline_version_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/batch	Create a batch pipeline version request
PipelineRequests	pipeline_requests_batch_cancel	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/cancel	Cancel multiple pipeline requests
PipelineRequests	pipeline_requests_batch_delete	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/delete	Delete multiple pipeline requests
PipelineRequests	pipeline_requests_batch_get	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/collect	Retrieve multiple pipeline requests
PipelineRequests	pipeline_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/requests	Create a pipeline request
PipelineRequests	pipeline_requests_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}	Delete a pipeline request
PipelineRequests	pipeline_requests_get	GET /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}	Get a pipeline request
PipelineRequests	pipeline_requests_input_get	GET /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}/input	Get a pipeline request input
PipelineRequests	pipeline_requests_list	GET /projects/{project_name}/pipelines/{pipeline_name}/requests	List pipeline requests
PipelineRequests	pipeline_requests_output_get	GET /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}/output	Get a pipeline request output
PipelineRequests	pipeline_requests_update	PATCH /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}	Update a pipeline request
PipelineRequests	pipeline_version_object_requests_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/object-requests/{request_id}	Get an operator request
PipelineRequests	pipeline_version_object_requests_input_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/object-requests/{request_id}/input	Get an operator request input
PipelineRequests	pipeline_version_object_requests_output_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/object-requests/{request_id}/output	Get an operator request output
PipelineRequests	pipeline_version_requests_batch_cancel	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/cancel	Cancel multiple pipeline version requests
PipelineRequests	pipeline_version_requests_batch_delete	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/delete	Delete multiple pipeline version requests
PipelineRequests	pipeline_version_requests_batch_get	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/collect	Retrieve multiple pipeline version requests
PipelineRequests	pipeline_version_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests	Create a pipeline version request
PipelineRequests	pipeline_version_requests_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}	Delete a pipeline version request
PipelineRequests	pipeline_version_requests_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}	Get a pipeline version request
PipelineRequests	pipeline_version_requests_input_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}/input	Get a pipeline request input
PipelineRequests	pipeline_version_requests_list	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests	List pipeline version requests
PipelineRequests	pipeline_version_requests_output_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}/output	Get a pipeline request output
PipelineRequests	pipeline_version_requests_update	PATCH /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}	Update a pipeline version request
Pipelines	expressions_evaluate	POST /expressions/evaluate	Evaluate expression
Pipelines	pipeline_audit_events_list	GET /projects/{project_name}/pipelines/{pipeline_name}/audit	List audit events for a pipeline
Pipelines	pipeline_version_object_environment_variables_list	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{name}/environment-variables	List pipeline object environment variables
Pipelines	pipeline_versions_create	POST /projects/{project_name}/pipelines/{pipeline_name}/versions	Create pipeline versions
Pipelines	pipeline_versions_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}	Delete pipeline version
Pipelines	pipeline_versions_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}	Get pipeline version
Pipelines	pipeline_versions_list	GET /projects/{project_name}/pipelines/{pipeline_name}/versions	List pipeline versions
Pipelines	pipeline_versions_update	PATCH /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}	Update pipeline version
Pipelines	pipelines_create	POST /projects/{project_name}/pipelines	Create pipelines
Pipelines	pipelines_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}	Delete a pipeline
Pipelines	pipelines_get	GET /projects/{project_name}/pipelines/{pipeline_name}	Get details of a pipeline
Pipelines	pipelines_list	GET /projects/{project_name}/pipelines	List pipelines
Pipelines	pipelines_update	PATCH /projects/{project_name}/pipelines/{pipeline_name}	Update a pipeline
Projects	logs_list	GET /projects/{project_name}/logs	List logs for a project
Projects	project_audit_events_list	GET /projects/{project_name}/audit	List audit events in a project
Projects	project_environment_variables_create	POST /projects/{project_name}/environment-variables	Create project environment variable
Projects	project_environment_variables_delete	DELETE /projects/{project_name}/environment-variables/{id}	Delete project environment variable
Projects	project_environment_variables_get	GET /projects/{project_name}/environment-variables/{id}	Get project environment variable
Projects	project_environment_variables_list	GET /projects/{project_name}/environment-variables	List project environment variables
Projects	project_environment_variables_update	PATCH /projects/{project_name}/environment-variables/{id}	Update project environment variable
Projects	project_requests_list	GET /projects/{project_name}/requests	List requests in project
Projects	project_users_create	POST /projects/{project_name}/users	Add user to a project
Projects	project_users_delete	DELETE /projects/{project_name}/users/{user_id}	Delete user from a project
Projects	project_users_get	GET /projects/{project_name}/users/{user_id}	Get user in a project
Projects	project_users_list	GET /projects/{project_name}/users	List users in a project
Projects	projects_create	POST /projects	Create projects
Projects	projects_delete	DELETE /projects/{project_name}	Delete a project
Projects	projects_get	GET /projects/{project_name}	Get details of a project
Projects	projects_list	GET /projects	List projects
Projects	projects_resource_usage	GET /projects/{project_name}/resources	List resource usage of a project
Projects	projects_update	PATCH /projects/{project_name}	Update a project
Projects	projects_usage_get	GET /projects/{project_name}/usage	Get resource usage
Projects	quotas_list	GET /projects/{project_name}/quotas	List quotas
RequestSchedules	request_schedules_create	POST /projects/{project_name}/schedules	Create request schedules
RequestSchedules	request_schedules_delete	DELETE /projects/{project_name}/schedules/{schedule_name}	Delete a request schedule
RequestSchedules	request_schedules_get	GET /projects/{project_name}/schedules/{schedule_name}	Get details of a request schedule
RequestSchedules	request_schedules_list	GET /projects/{project_name}/schedules	List request schedules
RequestSchedules	request_schedules_update	PATCH /projects/{project_name}/schedules/{schedule_name}	Update a request schedule
Roles	permissions_list	GET /permissions	List the available permissions
Roles	role_assignments_create	POST /projects/{project_name}/role-assignments	Assign role to user/object
Roles	role_assignments_delete	DELETE /projects/{project_name}/role-assignments/{id}	Delete role of user
Roles	role_assignments_get	GET /projects/{project_name}/role-assignments/{id}	Get role assignment
Roles	role_assignments_per_object_list	GET /projects/{project_name}/role-assignments	List roles on object/user
Roles	roles_create	POST /projects/{project_name}/roles	Create a custom role scoped in a project
Roles	roles_delete	DELETE /projects/{project_name}/roles/{role_name}	Delete a role from a project
Roles	roles_get	GET /projects/{project_name}/roles/{role_name}	Get details of a role
Roles	roles_list	GET /projects/{project_name}/roles	List the available roles in a project
Roles	roles_update	PATCH /projects/{project_name}/roles/{role_name}	Update a role in a project
ServiceUsers	service_users_create	POST /projects/{project_name}/service-users	Create a new service user
ServiceUsers	service_users_delete	DELETE /projects/{project_name}/service-users/{service_user_id}	Delete service user
ServiceUsers	service_users_get	GET /projects/{project_name}/service-users/{service_user_id}	Retrieve details of a service user
ServiceUsers	service_users_list	GET /projects/{project_name}/service-users	List service users
ServiceUsers	service_users_token	PUT /projects/{project_name}/service-users/{service_user_id}/token	Reset the token of a service user
ServiceUsers	service_users_update	PATCH /projects/{project_name}/service-users/{service_user_id}	Update service user details
Services	services_create	POST /projects/{project_name}/services	Create service
Services	services_delete	DELETE /projects/{project_name}/services/{service_name}	Delete service
Services	services_get	GET /projects/{project_name}/services/{service_name}	Get service
Services	services_list	GET /projects/{project_name}/services	List services
Services	services_status_get	GET /projects/{project_name}/services/{service_name}/status	Get the service status
Services	services_update	PATCH /projects/{project_name}/services/{service_name}	Update service
Services	services_user_concurrency_limit_create	POST /projects/{project_name}/services/{service_name}/user-concurrency-limits	Create services user concurrency limit
Services	services_user_concurrency_limit_delete	DELETE /projects/{project_name}/services/{service_name}/user-concurrency-limits/{user_id}	Delete services user concurrency limit
Services	services_user_concurrency_limit_get	GET /projects/{project_name}/services/{service_name}/user-concurrency-limits/{user_id}	Get services user concurrency limit
Services	services_user_concurrency_limit_list	GET /projects/{project_name}/services/{service_name}/user-concurrency-limits	List services user concurrency limits
Services	services_user_concurrency_limit_update	PATCH /projects/{project_name}/services/{service_name}/user-concurrency-limits/{user_id}	Update services user concurrency limit
Services	services_user_rate_limit_create	POST /projects/{project_name}/services/{service_name}/user-rate-limits	Create services user rate limit
Services	services_user_rate_limit_delete	DELETE /projects/{project_name}/services/{service_name}/user-rate-limits/{user_id}	Delete services user rate limit
Services	services_user_rate_limit_get	GET /projects/{project_name}/services/{service_name}/user-rate-limits/{user_id}	Get services user rate limit
Services	services_user_rate_limit_list	GET /projects/{project_name}/services/{service_name}/user-rate-limits	List services user rate limits
Services	services_user_rate_limit_update	PATCH /projects/{project_name}/services/{service_name}/user-rate-limits/{user_id}	Update services user rate limit
Status	service_status	GET /status	Service status
User	user_create	POST /user	Create a new user
User	user_delete	DELETE /user	Delete user
User	user_get	GET /user	Get user details
Webhooks	webhook_tests_create	POST /projects/{project_name}/webhooks-tests	Create webhook tests
Webhooks	webhook_tests_get	GET /projects/{project_name}/webhooks-tests/{test_id}	Get webhook test
Webhooks	webhooks_create	POST /projects/{project_name}/webhooks	Create webhooks
Webhooks	webhooks_delete	DELETE /projects/{project_name}/webhooks/{webhook_name}	Delete a webhook
Webhooks	webhooks_get	GET /projects/{project_name}/webhooks/{webhook_name}	Get webhook
Webhooks	webhooks_list	GET /projects/{project_name}/webhooks	List webhooks
Webhooks	webhooks_update	PATCH /projects/{project_name}/webhooks/{webhook_name}	Update a webhook

Documentation For Models

• AdditionalData
• AttachmentFieldsList
• AttachmentSourcesList
• AttachmentsCreate
• AttachmentsList
• AuditList
• BucketCreate
• BucketDetail
• BucketList
• BucketUpdate
• DeploymentCreate
• DeploymentCreateResponse
• DeploymentDetail
• DeploymentInputFieldCreate
• DeploymentList
• DeploymentOutputFieldCreate
• DeploymentRequestBatchCreateResponse
• DeploymentRequestCreateResponse
• DeploymentRequestDetail
• DeploymentRequestList
• DeploymentRequestSingleDetail
• DeploymentRequestUpdate
• DeploymentUpdate
• DeploymentVersionCreate
• DeploymentVersionDetail
• DeploymentVersionList
• DeploymentVersionPort
• DeploymentVersionUpdate
• EnvironmentBuildDependency
• EnvironmentBuildList
• EnvironmentBuildUpdate
• EnvironmentCreate
• EnvironmentDetail
• EnvironmentList
• EnvironmentRevisionCreate
• EnvironmentRevisionDetail
• EnvironmentSecretCopy
• EnvironmentUpdate
• EnvironmentUsage
• EnvironmentVariableCopy
• EnvironmentVariableCreate
• EnvironmentVariableList
• ExportCreate
• ExportDetail
• ExportList
• ExpressionEvaluate
• ExpressionEvaluateResponse
• ExpressionInputFieldCreate
• FileCompleteMultipartUpload
• FileDetail
• FileItem
• FileMultipartUpload
• FileUploadResponse
• HealthCheck
• ImportDetail
• ImportList
• ImportUpdate
• InheritedEnvironmentVariableList
• InputFieldWidgetCreate
• InputOutputFieldBase
• InputOutputFieldDetail
• InputOutputFieldList
• InputOutputWidgetList
• InstanceDetail
• InstanceEvent
• InstanceEventPaginated
• InstanceInstanceTypeDetail
• InstanceList
• InstanceListPaginated
• InstanceTypeCluster
• InstanceTypeGroupCreate
• InstanceTypeGroupList
• InstanceTypeGroupListPaginated
• InstanceTypeGroupUpdate
• InstanceTypeGroupUsage
• InstanceTypeGroupUsagePaginated
• InstanceTypeItem
• InstanceTypeItemCreate
• InstanceTypeList
• InstanceTypeListPaginated
• InstanceTypeNodePool
• InstanceUpdate
• LogList
• LogMetadata
• MetricCreate
• MetricDetail
• MetricUpdate
• Node
• OperatorRequestDetail
• OrganizationCreate
• OrganizationDetail
• OrganizationList
• OrganizationProjectUsage
• OrganizationUpdate
• OrganizationUsage
• OrganizationUserCreate
• OrganizationUserList
• OrganizationUserUpdate
• OutputFieldWidgetCreate
• OutputValueList
• PermissionList
• PipelineCreate
• PipelineCreateResponse
• PipelineDetail
• PipelineInputFieldCreate
• PipelineList
• PipelineOutputFieldCreate
• PipelineRequestBatchCreateResponse
• PipelineRequestCreateResponse
• PipelineRequestDeploymentRequest
• PipelineRequestDetail
• PipelineRequestList
• PipelineRequestOperatorRequest
• PipelineRequestPipelineRequest
• PipelineRequestSingleDetail
• PipelineRequestUpdate
• PipelineUpdate
• PipelineVersionCreate
• PipelineVersionDetail
• PipelineVersionList
• PipelineVersionObjectConfigurationList
• PipelineVersionObjectCreate
• PipelineVersionObjectList
• PipelineVersionUpdate
• ProjectCreate
• ProjectDeploymentVersionUsage
• ProjectDetail
• ProjectInstanceList
• ProjectInstanceListPaginated
• ProjectList
• ProjectResourceUsage
• ProjectUpdate
• ProjectUsage
• ProjectUserCreate
• ProjectUserList
• QuotaDetail
• RequestsOverview
• ResourceUsage
• RevisionCreate
• RevisionList
• RoleAssignmentCreate
• RoleAssignmentList
• RoleCreate
• RoleDetailList
• RoleList
• RoleUpdate
• ScheduleCreate
• ScheduleList
• ScheduleUpdate
• ServiceCreate
• ServiceDetail
• ServiceList
• ServiceStatus
• ServiceUpdate
• ServiceUserCreate
• ServiceUserList
• ServiceUserTokenDetail
• ServiceUserTokenList
• ServicesUserConcurrencyLimitCreate
• ServicesUserConcurrencyLimitList
• ServicesUserConcurrencyLimitUpdate
• ServicesUserRateLimitCreate
• ServicesUserRateLimitList
• ServicesUserRateLimitUpdate
• Status
• TemplateDeploymentList
• TimeSeriesDataCreate
• TimeSeriesDataList
• TimeSeriesDataPointCreate
• TimeSeriesDataPointList
• TimeSeriesSearch
• UserDetail
• UserPendingCreate
• UserPendingDetail
• Voucher
• WebhookCreate
• WebhookDetail
• WebhookHeader
• WebhookTestCreate
• WebhookTestDetail
• WebhookUpdate

Documentation For Utils

See:

• FileOperations
• MetricClient

Documentation For Authorization

api_key

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

Attribution

This software uses the library gitignorefile by Vladimir Chebotarev - see license.