This respository is no longer maintained.

ubiops

www.ubiops.com

Client Library to interact with the UbiOps API.

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

• API version: v2.1
• Package version: 0.19.1

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

Installation

DevTools

To install directly from Github, use devtools:

install.packages("R6")
install.packages("stringr")
install.packages("devtools")
library(devtools)
install_github("UbiOps/client-library-r")

Local build

To build and install locally:

1. Install the dependencies from CRAN

install.packages("rjson")
install.packages("jsonlite")
install.packages("httr")
install.packages("readr")
install.packages("R6")
install.packages("stringr")

2. Build the package

git clone https://github.com/UbiOps/client-library-r
cd client-library-r
R CMD build .
R CMD INSTALL ubiops_0.19.1.tar.gz

Troubleshooting

Getting errors while installing devtools? You may need to install some OS level packages. On Ubuntu, you can try with build-essential, libcurl4-gnutls-dev, libxml2-dev and libssl-dev.

Getting errors about LC_../LANG variables missing? You may need to export the following variables: LC_CTYPE=en_US.UTF-8 and LC_MESSAGES=en_US.UTF-8.

Usage

library(ubiops)

# 1) Use environment variables
Sys.setenv("UBIOPS_PROJECT" = "YOUR PROJECT NAME")
Sys.setenv("UBIOPS_API_TOKEN" = "YOUR API TOKEN")
result <- deployments_list()

# 2) Or provide directly
# result <- deployments_list(UBIOPS_PROJECT = "YOUR PROJECT NAME", UBIOPS_API_TOKEN = "YOUR API TOKEN")

print(result)
# Or print in JSON format
print(jsonlite::toJSON(result, auto_unbox=TRUE))

# The default API url is https://api.ubiops.com/v2.1
# Want to use a different API url? Provide `UBIOPS_API_URL`, either directly or as environment variable.

Documentation for API Endpoints

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

Method	HTTP request	Description
blobs_create	POST /projects/{project_name}/blobs	Upload a blob
blobs_delete	DELETE /projects/{project_name}/blobs/{blob_id}	Delete a blob
blobs_get	GET /projects/{project_name}/blobs/{blob_id}	Get a blob
blobs_list	GET /projects/{project_name}/blobs	List blobs
blobs_update	PUT /projects/{project_name}/blobs/{blob_id}	Update a blob
batch_deployment_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/requests/batch	Create a batch deployment request
batch_deployment_version_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/batch	Create a batch deployment version request
deployment_requests_batch_delete	POST /projects/{project_name}/deployments/{deployment_name}/requests/delete	Delete multiple deployment requests
deployment_requests_batch_get	POST /projects/{project_name}/deployments/{deployment_name}/requests/collect	Retrieve multiple deployment requests
deployment_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/requests	Create a direct deployment request
deployment_requests_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}	Delete a deployment request
deployment_requests_get	GET /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}	Get a deployment request
deployment_requests_list	GET /projects/{project_name}/deployments/{deployment_name}/requests	List deployment requests
deployment_requests_update	PATCH /projects/{project_name}/deployments/{deployment_name}/requests/{request_id}	Update a deployment request
deployment_version_requests_batch_delete	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/delete	Delete multiple deployment version requests
deployment_version_requests_batch_get	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/collect	Retrieve multiple deployment version requests
deployment_version_requests_create	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests	Create a direct deployment version request
deployment_version_requests_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}	Delete a deployment version request
deployment_version_requests_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}	Get a deployment version request
deployment_version_requests_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests	List deployment version requests
deployment_version_requests_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}/requests/{request_id}	Update a deployment version request
builds_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/builds/{build_id}	Get build
deployment_audit_events_list	GET /projects/{project_name}/deployments/{deployment_name}/audit	List audit events for a deployment
deployment_environment_variables_copy	POST /projects/{project_name}/deployments/{deployment_name}/copy-environment-variables	Copy deployment environment variable
deployment_environment_variables_create	POST /projects/{project_name}/deployments/{deployment_name}/environment-variables	Create deployment environment variable
deployment_environment_variables_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/environment-variables/{id}	Delete deployment environment variable
deployment_environment_variables_get	GET /projects/{project_name}/deployments/{deployment_name}/environment-variables/{id}	Get deployment environment variable
deployment_environment_variables_list	GET /projects/{project_name}/deployments/{deployment_name}/environment-variables	List deployment environment variables
deployment_environment_variables_update	PATCH /projects/{project_name}/deployments/{deployment_name}/environment-variables/{id}	Update deployment environment variable
deployment_version_environment_variables_copy	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/copy-environment-variables	Copy deployment version environment variable
deployment_version_environment_variables_create	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables	Create deployment version environment variable
deployment_version_environment_variables_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables/{id}	Delete deployment version environment variable
deployment_version_environment_variables_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables/{id}	Get deployment version environment variable
deployment_version_environment_variables_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables	List deployment version environment variables
deployment_version_environment_variables_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}/environment-variables/{id}	Update deployment version environment variable
deployment_versions_create	POST /projects/{project_name}/deployments/{deployment_name}/versions	Create deployment versions
deployment_versions_delete	DELETE /projects/{project_name}/deployments/{deployment_name}/versions/{version}	Delete deployment version
deployment_versions_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}	Get deployment version
deployment_versions_list	GET /projects/{project_name}/deployments/{deployment_name}/versions	List deployment versions
deployment_versions_update	PATCH /projects/{project_name}/deployments/{deployment_name}/versions/{version}	Update deployment version
deployments_create	POST /projects/{project_name}/deployments	Create deployments
deployments_delete	DELETE /projects/{project_name}/deployments/{deployment_name}	Delete a deployment
deployments_get	GET /projects/{project_name}/deployments/{deployment_name}	Get details of a deployment
deployments_list	GET /projects/{project_name}/deployments	List deployments
deployments_update	PATCH /projects/{project_name}/deployments/{deployment_name}	Update a deployment
revisions_file_download	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions/{revision_id}/download	Download deployment file
revisions_file_upload	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions	Upload deployment file
revisions_get	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions/{revision_id}	Get revision
revisions_list	GET /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions	List revisions
revisions_rebuild	POST /projects/{project_name}/deployments/{deployment_name}/versions/{version}/revisions/{revision_id}/rebuild	Rebuild revision
template_deployments_list	GET /template-deployments	List template deployments
environment_build_dependencies_list	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds/{build_id}/dependency-files	List dependency files
environment_builds_get	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds/{build_id}	Get build
environment_builds_list	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds	List builds
environment_builds_update	PATCH /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/builds/{build_id}	Update build
environment_revisions_file_download	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/download	Download environment file
environment_revisions_file_upload	POST /projects/{project_name}/environments/{environment_name}/revisions	Upload environment file
environment_revisions_get	GET /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}	Get revision
environment_revisions_list	GET /projects/{project_name}/environments/{environment_name}/revisions	List revisions
environment_revisions_rebuild	POST /projects/{project_name}/environments/{environment_name}/revisions/{revision_id}/rebuild	Rebuild revision
environments_create	POST /projects/{project_name}/environments	Create environments
environments_delete	DELETE /projects/{project_name}/environments/{environment_name}	Delete environment
environments_get	GET /projects/{project_name}/environments/{environment_name}	Get environment
environments_list	GET /projects/{project_name}/environments	List environments
environments_update	PATCH /projects/{project_name}/environments/{environment_name}	Update environment
environments_usage	GET /projects/{project_name}/environments/{environment_name}/usage	List usage of environment
buckets_create	POST /projects/{project_name}/buckets	Create bucket
buckets_delete	DELETE /projects/{project_name}/buckets/{bucket_name}	Delete a bucket
buckets_get	GET /projects/{project_name}/buckets/{bucket_name}	Get details of a bucket
buckets_list	GET /projects/{project_name}/buckets	List buckets
buckets_update	PATCH /projects/{project_name}/buckets/{bucket_name}	Update a bucket
files_complete_multipart_upload	POST /projects/{project_name}/buckets/{bucket_name}/files/{file}/complete-multipart-upload	Complete multipart upload
files_delete	DELETE /projects/{project_name}/buckets/{bucket_name}/files/{file}	Delete a file
files_download	GET /projects/{project_name}/buckets/{bucket_name}/files/{file}/download	Download a file
files_get	GET /projects/{project_name}/buckets/{bucket_name}/files/{file}	Get a file
files_list	GET /projects/{project_name}/buckets/{bucket_name}/files	List files
files_start_multipart_upload	POST /projects/{project_name}/buckets/{bucket_name}/files/{file}/start-multipart-upload	Start multipart upload
files_upload	POST /projects/{project_name}/buckets/{bucket_name}/files/{file}	Upload a file
exports_create	POST /projects/{project_name}/exports	Create an export
exports_delete	DELETE /projects/{project_name}/exports/{export_id}	Delete an export
exports_download	GET /projects/{project_name}/exports/{export_id}/download	Download an export
exports_get	GET /projects/{project_name}/exports/{export_id}	Get an export
exports_list	GET /projects/{project_name}/exports	List exports
imports_create	POST /projects/{project_name}/imports	Create an import
imports_delete	DELETE /projects/{project_name}/imports/{import_id}	Delete an import
imports_download	GET /projects/{project_name}/imports/{import_id}/download	Download an import
imports_get	GET /projects/{project_name}/imports/{import_id}	Get an import
imports_list	GET /projects/{project_name}/imports	List imports
imports_update	PATCH /projects/{project_name}/imports/{import_id}	Confirm an import
metrics_create	POST /projects/{project_name}/metrics	Create metrics
metrics_delete	DELETE /projects/{project_name}/metrics/{metric_name}	Delete metric
metrics_get	GET /projects/{project_name}/metrics/{metric_name}	Get metric
metrics_list	GET /projects/{project_name}/metrics	List metrics
metrics_update	PATCH /projects/{project_name}/metrics/{metric_name}	Update metric
time_series_data_aggregate	POST /projects/{project_name}/time-series/aggregate	Aggregate metric data
time_series_data_create	POST /projects/{project_name}/time-series/data	Create metric data
time_series_data_list	GET /projects/{project_name}/time-series/data	List time series data
time_series_delete	DELETE /projects/{project_name}/time-series/{time_series_id}	Delete time series
time_series_search	GET /projects/{project_name}/time-series/search	Search time series
notification_groups_create	POST /projects/{project_name}/monitoring/notification-groups	Create notification groups
notification_groups_delete	DELETE /projects/{project_name}/monitoring/notification-groups/{notification_group_name}	Delete notification group
notification_groups_get	GET /projects/{project_name}/monitoring/notification-groups/{notification_group_name}	Get notification group
notification_groups_list	GET /projects/{project_name}/monitoring/notification-groups	List notification groups
notification_groups_update	PATCH /projects/{project_name}/monitoring/notification-groups/{notification_group_name}	Update notification group
organization_users_create	POST /organizations/{organization_name}/users	Add a user to an organization
organization_users_delete	DELETE /organizations/{organization_name}/users/{user_id}	Delete a user from an organization
organization_users_get	GET /organizations/{organization_name}/users/{user_id}	Get details of a user in an organization
organization_users_list	GET /organizations/{organization_name}/users	List the users in an organization
organization_users_update	PATCH /organizations/{organization_name}/users/{user_id}	Update details of a user in an organization
organizations_create	POST /organizations	Create organizations
organizations_get	GET /organizations/{organization_name}	Get details of an organization
organizations_list	GET /organizations	List organizations
organizations_resource_usage	GET /organizations/{organization_name}/resources	Get resource usage
organizations_update	PATCH /organizations/{organization_name}	Update details of an organization
organizations_usage_get	GET /organizations/{organization_name}/usage	Get organization usage
vouchers_get	GET /vouchers/{code}	Get voucher
batch_pipeline_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/batch	Create a batch pipeline request
batch_pipeline_version_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/batch	Create a batch pipeline version request
pipeline_requests_batch_delete	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/delete	Delete multiple pipeline requests
pipeline_requests_batch_get	POST /projects/{project_name}/pipelines/{pipeline_name}/requests/collect	Retrieve multiple pipeline requests
pipeline_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/requests	Create a pipeline request
pipeline_requests_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}	Delete a pipeline request
pipeline_requests_get	GET /projects/{project_name}/pipelines/{pipeline_name}/requests/{request_id}	Get a pipeline request
pipeline_requests_list	GET /projects/{project_name}/pipelines/{pipeline_name}/requests	List pipeline requests
pipeline_version_object_requests_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/object-requests/{request_id}	Get an operator request
pipeline_version_requests_batch_delete	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/delete	Delete multiple pipeline version requests
pipeline_version_requests_batch_get	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/collect	Retrieve multiple pipeline version requests
pipeline_version_requests_create	POST /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests	Create a pipeline version request
pipeline_version_requests_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}	Delete a pipeline version request
pipeline_version_requests_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests/{request_id}	Get a pipeline version request
pipeline_version_requests_list	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/requests	List pipeline version requests
expressions_evaluate	POST /expressions/evaluate	Evaluate expression
pipeline_audit_events_list	GET /projects/{project_name}/pipelines/{pipeline_name}/audit	List audit events for a pipeline
pipeline_version_object_environment_variables_list	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}/objects/{name}/environment-variables	List pipeline object environment variables
pipeline_versions_create	POST /projects/{project_name}/pipelines/{pipeline_name}/versions	Create pipeline versions
pipeline_versions_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}	Delete pipeline version
pipeline_versions_get	GET /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}	Get pipeline version
pipeline_versions_list	GET /projects/{project_name}/pipelines/{pipeline_name}/versions	List pipeline versions
pipeline_versions_update	PATCH /projects/{project_name}/pipelines/{pipeline_name}/versions/{version}	Update pipeline version
pipelines_create	POST /projects/{project_name}/pipelines	Create pipelines
pipelines_delete	DELETE /projects/{project_name}/pipelines/{pipeline_name}	Delete a pipeline
pipelines_get	GET /projects/{project_name}/pipelines/{pipeline_name}	Get details of a pipeline
pipelines_list	GET /projects/{project_name}/pipelines	List pipelines
pipelines_update	PATCH /projects/{project_name}/pipelines/{pipeline_name}	Update a pipeline
instance_types_list	GET /projects/{project_name}/instance-types	List instance types
project_audit_events_list	GET /projects/{project_name}/audit	List audit events in a project
project_environment_variables_create	POST /projects/{project_name}/environment-variables	Create project environment variable
project_environment_variables_delete	DELETE /projects/{project_name}/environment-variables/{id}	Delete project environment variable
project_environment_variables_get	GET /projects/{project_name}/environment-variables/{id}	Get project environment variable
project_environment_variables_list	GET /projects/{project_name}/environment-variables	List project environment variables
project_environment_variables_update	PATCH /projects/{project_name}/environment-variables/{id}	Update project environment variable
project_requests_list	GET /projects/{project_name}/requests	List requests in project
project_users_create	POST /projects/{project_name}/users	Add user to a project
project_users_delete	DELETE /projects/{project_name}/users/{user_id}	Delete user from a project
project_users_get	GET /projects/{project_name}/users/{user_id}	Get user in a project
project_users_list	GET /projects/{project_name}/users	List users in a project
projects_create	POST /projects	Create projects
projects_delete	DELETE /projects/{project_name}	Delete a project
projects_get	GET /projects/{project_name}	Get details of a project
projects_list	GET /projects	List projects
projects_log_list	POST /projects/{project_name}/logs	List logs for a project
projects_resource_usage	GET /projects/{project_name}/resources	List resource usage of a project
projects_update	PATCH /projects/{project_name}	Update a project
projects_usage_get	GET /projects/{project_name}/usage	Get resource usage
quotas_list	GET /projects/{project_name}/quotas	List quotas
request_schedules_create	POST /projects/{project_name}/schedules	Create request schedules
request_schedules_delete	DELETE /projects/{project_name}/schedules/{schedule_name}	Delete a request schedule
request_schedules_get	GET /projects/{project_name}/schedules/{schedule_name}	Get details of a request schedule
request_schedules_list	GET /projects/{project_name}/schedules	List request schedules
request_schedules_update	PATCH /projects/{project_name}/schedules/{schedule_name}	Update a request schedule
permissions_list	GET /permissions	List the available permissions
role_assignments_create	POST /projects/{project_name}/role-assignments	Assign role to user/object
role_assignments_delete	DELETE /projects/{project_name}/role-assignments/{id}	Delete role of user
role_assignments_get	GET /projects/{project_name}/role-assignments/{id}	Get role assignment
role_assignments_per_object_list	GET /projects/{project_name}/role-assignments	List roles on object/user
roles_create	POST /projects/{project_name}/roles	Create a custom role scoped in a project
roles_delete	DELETE /projects/{project_name}/roles/{role_name}	Delete a role from a project
roles_get	GET /projects/{project_name}/roles/{role_name}	Get details of a role
roles_list	GET /projects/{project_name}/roles	List the available roles in a project
roles_update	PATCH /projects/{project_name}/roles/{role_name}	Update a role in a project
service_users_create	POST /projects/{project_name}/service-users	Create a new service user
service_users_delete	DELETE /projects/{project_name}/service-users/{service_user_id}	Delete service user
service_users_get	GET /projects/{project_name}/service-users/{service_user_id}	Retrieve details of a service user
service_users_list	GET /projects/{project_name}/service-users	List service users
service_users_token	PUT /projects/{project_name}/service-users/{service_user_id}/token	Reset the token of a service user
service_users_update	PATCH /projects/{project_name}/service-users/{service_user_id}	Update service user details
service_status	GET /status	Service status
user_create	POST /user	Create a new user
user_delete	DELETE /user	Delete user
webhook_tests_create	POST /projects/{project_name}/webhooks-tests	Create webhook tests
webhook_tests_get	GET /projects/{project_name}/webhooks-tests/{test_id}	Get webhook test
webhooks_create	POST /projects/{project_name}/webhooks	Create webhooks
webhooks_delete	DELETE /projects/{project_name}/webhooks/{webhook_name}	Delete a webhook
webhooks_get	GET /projects/{project_name}/webhooks/{webhook_name}	Get webhook
webhooks_list	GET /projects/{project_name}/webhooks	List webhooks
webhooks_update	PATCH /projects/{project_name}/webhooks/{webhook_name}	Update a webhook

Documentation for Authorization

api_key

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