https://platform.instabase.com/docs/26.04/apis/index.html Recent content in APIs on Instabase Platform Documentation Hugo -- gohugo.io en-us https://platform.instabase.com/docs/26.04/apis/account/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/account/index.html Table of Contents Create users Create service accounts Update a user’s email Description Examples Deactivate users Disable users Reactivate users Get site admins Set site admins Remove site admins List users Check account type Reset password Use the Account API to create and deactivate users, return a list of all site admins, and set and remove site admins. import json, requests api_root = "https://www.instabase.com/api/v1/accounts" See Instabase API authorization and response conventions for authorization and error convention details. https://platform.instabase.com/docs/26.04/apis/audit-log/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/audit-log/index.html Table of Contents Audit log metadata Description Examples Audit log query Description Model training operation (model_training) Examples The Audit Log API allows site admins to get audit log metadata and audit log results to track activity on the platform. See the Audit Logs Documentation for more details. See Instabase API authorization and response conventions for authorization and error convention details. For the Audit Log API, URL_BASE defines the base domain and API prefix of your Instabase instance. https://platform.instabase.com/docs/26.04/apis/auth/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/auth/index.html Table of Contents Create OAuth2 app Get a list of all OAuth2 Apps for a user Delete All OAuth2 Apps and Tokens Get a User’s OAuth2 App Create/Update OAuth2 Token Get OAuth2 Token Get SAML Mappings Set SAML Mappings Use the Auth API to create, delete, and list OAuth2 apps, create, update, and get a user Oath2 token, and set and get SAML mappings. For the Auth API, api-root defines where to route API requests for your Instabase instance: https://platform.instabase.com/docs/26.04/apis/v2-apis/automation-metrics/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/v2-apis/automation-metrics/index.html Table of Contents Query for Metrics Description Examples The Automation Metrics API allows you to query for metrics through the last 90 days for any deployed solution that relates to extraction performance, based on validation success and human review modifications. To authorize your request, the Automation Metrics API requires an Authorization header with the value Bearer XYZ, where XYZ is your access token. See API authorization. In this document, URL_BASE refers to the root URL of your Instabase instance, such as https://www. https://platform.instabase.com/docs/26.04/apis/database-table/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/database-table/index.html Table of Contents Create a database List all tables Describe a table Bulk insert into a table Execute a query Execute a query with custom connection Use the Database API to create a database, describe a table, list tables, and execute a query against a database. Site admins can execute a query against a database using custom connection parameters. import json, requests table_api = 'https://www.instabase.com/api/v1/databases' root = '/<username>/<workspace>/databases' See Instabase API authorization and response conventions for authorization and error convention details. https://platform.instabase.com/docs/26.04/apis/v2-apis/deployed-solutions/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/v2-apis/deployed-solutions/index.html Table of Contents Deploy a solution Description Get solutions Description Get single solution API Description Run a solution Description Run a solution by name/version Description Delete a solution Description Update a solution’s attributes Description Get jobs for a single solution API Description Get jobs for multiple solutions API Description The Deployed Solutions API lets you add, manage, and run solutions that you indicate are deployed, so you can monitor their automation metrics in the Solution Dashboard. https://platform.instabase.com/docs/26.04/apis/deployment-manager/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/deployment-manager/index.html Table of Contents Conventions and authentication Set up Deployment Manager Description Examples Deployment Manager set up status Description Examples Database initialization Description Examples Database mock DDL for initialization Description Examples Test database connection Description Examples Create base configs Description Examples Get all base configuration versions Description Examples Get base configuration versions of object Description Examples Update base config image Description Examples Get all base configs Description Apply patch Description Examples Get all patches Description Examples Get all patches for object Description Examples Delete patch Description Examples Update namespace Description Examples Set image registry Description Examples Get all latest materialized configurations Description Examples Get materialized configuration of object Description Examples Push latest materialized configs to cluster Description Examples Get all resource labels Description Examples Create resource label bindings Description Get object names by label Description Examples Get labels by object name Description Examples Delete object bindings Description Examples Update default resource labels Description Examples Update cluster size Description Examples Pause autoscaling controllers Description Examples Resume autoscaling controllers Description Examples Get autoscaling controller statuses Description Examples Get all containers for resource Description Examples Get all release versions for resource Description Examples Get upgrade history Description Examples Asynchronous base configs upload Description Examples Get results of asynchronous base configs upload Description Examples Find inconsistent resources Description Examples Get Deployment Manager namespace Description Examples Download telemetry data Description Examples Check telemetry data status Description Examples Upload telemetry data Description Examples Download imported telemetry configs Description Examples Check status of imported telemetry data Description Examples Search patches by keyword Description Examples Get platform status Description Examples Get platform release version Description Examples Revive the Instabase platform Description Examples Update all objects Description Examples Update an object Description Examples Get autoscaled resources Description Examples Get settings Description Examples Update settings Description Examples Get previous and new config given a patch Description Examples Hibernate cluster Description Examples Delete a Kubernetes Job Description Examples Delete a Kubernetes pod Description Examples Quarantine a Kubernetes pod Description Examples Use the Deployment Manager API to manage the Instabase platform infrastructure. https://platform.instabase.com/docs/26.04/apis/diagnostics/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/diagnostics/index.html Table of Contents Run system test Request Response Get system test status Request Response Supported tests Run filesystem performance tests Discover available filesystem performance tests Request Response Start test Request Response Get filesystem performance test status Request Response Run database performance tests Discover available database performance tests Request Response Start test Request Response Get database performance test status Request Response Use the Diagnostics API to run system and performance tests and get the status and results of test runs. https://platform.instabase.com/docs/26.04/apis/diffs/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/diffs/index.html Use the Diff API to run a diff operation with configurable sensitivity settings and signature detection customizations. See Instabase API authorization and response conventions for authorization and error convention details. Text Diff The following code demonstrates how to request a text diff operation using the Diff API. A diff can be generated on these levels of specificity: Line Word Character Request import json, requests # Set the URLs for your Instabase installation # -------------------------------------------- INSTABASE_URL = u'https://www. https://platform.instabase.com/docs/26.04/apis/filesystem-v1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/filesystem-v1/index.html Table of Contents Create a folder API Write content to a file API Read contents from a file API List directory API Read metadata from a file or folder API Copy a file or folder API Move a file or folder API Delete a folder API Delete a file API Extract a ZIP file API Use the Filesystem API to perform file management operations, including creating, deleting, and moving files and folders. https://platform.instabase.com/docs/26.04/apis/v2-apis/filesystem-v2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/v2-apis/filesystem-v2/index.html Table of Contents Create an empty file or folder Description Examples Create a non-empty file or overwrite a file Description Examples Append content to a file Description Examples Read a file Description Examples Read metadata from a file or folder Description Examples List Directory Description Examples Delete a file or folder Description Examples Copy a file or folder Description Examples Move a file or folder Description Examples Extract a ZIP file Description Examples Poll status of an async file operation Description Examples The Filesystem API allows you to perform common file operations on the Instabase platform, including reading files, writing files, copying, moving, deleting files and folders, and extracting ZIP archives. https://platform.instabase.com/docs/26.04/apis/flow/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/flow/index.html Table of Contents Run a step Run a fully configured step Run a flow Description Examples Restart a flow Description Examples Run a metaflow Description Examples Job status Use Flow API to run a flow step or a flow, get flow execution status, export flow output, and more. Run a step Use this API to run a step in a flow. Request Send a POST request to url_base/flow/run_step_async with the post body encoded as JSON: https://platform.instabase.com/docs/26.04/apis/flow-binary/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/flow-binary/index.html Table of Contents Compile a flow binary Description Examples Run a Flow Binary Description Examples Webhook Configuration Add a log prefix Change output schema at runtime Job Status Run a flow binary in sync mode Description Examples The Flow Binary API allows you to compile a flow, generate and run a flow binary, and list, pause, resume, cancel, or retry flow jobs. In this document, URL_BASE refers to the root URL of your Instabase instance, such as https://www. https://platform.instabase.com/docs/26.04/apis/flow-metrics/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/flow-metrics/index.html Table of Contents Aggregated flow review metrics Description Examples Jobs Table Query Description Examples Flow Review Log Query Description Examples Use the Flow Metrics API to get metrics describing how a flow performed over a period of time. Instabase can track review metrics for all flow jobs that have a pipeline attached when the job is kicked off. Developers can use this API to pull reviewer efficiency data from Instabase and process elsewhere to monitor the overall efficiency of reviewer teams. https://platform.instabase.com/docs/26.04/apis/flow-pipeline/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/flow-pipeline/index.html Table of Contents List flow pipelines Description Examples Update the pipelines for a job Description Examples The Flow Pipeline API allows you to retrieve and update Flow pipelines. Flow pipelines are created and managed in the Admin - Flow Pipelines section. List flow pipelines Method Syntax GET URL_BASE/api/v1/flow/pipeline Description Lists Flow pipelines a user has access to. Response schema All keys are returned in the response by default unless marked as optional. https://platform.instabase.com/docs/26.04/apis/flow-results/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/flow-results/index.html Table of Contents Access Flow Results Description Examples The Flow Result API helps you to view flow outputs. The API renders the view in Flow Review for human reviewers to fix validation errors and review results. This API also handles exporting data into various outputs to be reused within Instabase or sent downstream. All API requests must include your valid access token to authenticate the request. See Instabase API authorization and response conventions for authorization and error convention details. https://platform.instabase.com/docs/26.04/apis/flow-results-export/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/flow-results-export/index.html Table of Contents Exporting to an Annotation Set Description Examples The Flow Results Export API exports Flow Review results to an annotation set. Exporting to an Annotation Set Method Syntax POST URL_BASE/api/v1/flow/results/export_to_dataset Description Start a job that exports flow results to an annotation set by sending a POST request to URL_BASE/api/v1/flow/results/export_to_dataset with the request body encoded as JSON. Request parameters All parameters are required. Parameter Type Description Values ibresults_path string The path to a flow results file whose results you want to export, such as /space/subspace/fs/Instabase Drive/flow_proj/out/batch. https://platform.instabase.com/docs/26.04/apis/group/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/group/index.html Table of Contents Create a Group Get Group information Update Group Delete Group Add/Remove users to/from a Group List all groups Groups are collections of users. Site admins use the Group API to manage Groups. See Instabase API authorization and response conventions for authorization, success response, and error response convention details. For the Group API, api_root defines where to route API requests for your Instabase instance: import json, requests api_root = "https://www. https://platform.instabase.com/docs/26.04/apis/http-endpoint/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/http-endpoint/index.html Table of Contents Create an HTTP endpoint Description Examples Trigger HTTP endpoint handler Description Examples Delete an HTTP endpoint Description Examples Update an HTTP endpoint Description Examples Get an HTTP endpoint Description Examples List HTTP endpoint Description Examples The HTTP Endpoint API lets you create and manage custom HTTP endpoints. The HTTP Endpoint API lets users create a custom endpoint at URL_BASE/api/v1/http-endpoint/u/<custom-endpoint>. Any incoming request to the endpoint runs a user-defined handler function and return the HTTP response. https://platform.instabase.com/docs/26.04/apis/installer/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/installer/index.html Instabase supports installation through API only, letting you integrate the installation process into CI/CD pipelines. This article outlines the required and optional Installer API endpoints used to perform an installation. Table of Contents Overview of required and optional installation steps Conventions and authentication Requests Responses Authentication Database configuration Description MySQL PostgreSQL Microsoft SQL Server: Connect with username and password Microsoft SQL Server: Connect with Azure AD Oracle Database connection string format TLS authentication configuration Description MySQL PostgreSQL Microsoft SQL Server File system configuration Description Amazon S3 Local file storage Azure Blob Storage Google Cloud Storage Upload custom Amazon S3 certificate Request parameters Examples Upload Google Cloud Storage service account credentials Description Request parameters Configuring the Google Cloud Storage service account Examples Configure platform and Kubernetes cluster-related settings Description Request parameters Examples Configure Kubernetes cluster resourcing Description Request parameters Examples Preflight checks Service accounts check Role-based access control (RBAC) check File storage access check Database check Persistent Volume Claim (PVC) check Upload Instabase license Description Request parameters Examples Upload base configurations Description Request parameters Examples Upload default patches Description Request parameters Examples Upload network policies Description Request parameters Examples Create SAML configuration Description Request parameters Examples Upload IdP metadata XML Description Request parameters Examples Clear SAML configuration Description Request Finalize installation Description Request parameters Examples Complete SAML configuration Description Request Run post-install actions Description Request Run a single post-install action Description Request Get the status of post-install actions Description Request Response Roll back all post-install actions Description Request Set the status of a single post-install action Description Request Info For installation using the Instabase Installer UI, see the Instabase Installer guide. https://platform.instabase.com/docs/26.04/apis/jobs/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/jobs/index.html Table of Contents Job Status Description State Diagram Examples Job Logs Description Examples List Jobs Description Examples Pause Job Description Resume Job Description Cancel Job Description Retry Job Description Pause All Running Jobs Description Examples Resume All Paused Jobs Description Cancel All Jobs Description Update job tags Description Examples Potentially data-heavy workflows, such as running a flow or refiner, can have long run times. As a result, these jobs are run asynchronously: when you call the API, the job is started and a job ID is returned, instead of an immediate result. https://platform.instabase.com/docs/26.04/apis/license-usage/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/license-usage/index.html Table of Contents Get usage information for all the licenses Description Examples Get usage information for a single license Description Examples Get resource usage breakdown Description Examples The License Usage API lets you get the usage information for licenses, products, and resources. In this document, URL_BASE refers to the root URL of your Instabase instance, such as https://www.instabase.com. Get usage information for all the licenses Method Syntax GET URL_BASE/api/v1/license-service/usage Description Get license usage for all licenses/products. https://platform.instabase.com/docs/26.04/apis/installed-solution/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/installed-solution/index.html Table of Contents Package a solution Request Response Publish a solution to Marketplace Request Response Install a Marketplace solution Request Response Run a solution Request Response Run a solution in sync mode Description Examples Get Solution Execution Status Request Response URL_BASE refers to the root URL of your Instabase instance, such as https://www.instabase.com. API_ROOT is URL_BASE appended by /api/v1. import json, requests url_base = "https://www.instabase.com" api_root = url_base + '/api/v1' Package a solution Send a POST request to API_ROOT/solution/create with the request body encoded as JSON: https://platform.instabase.com/docs/26.04/apis/metrics/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/metrics/index.html Table of Contents Get apps Description Examples Get metrics Description Examples Get attributes Description Examples Metrics query Description Examples The Metrics API allows site admins to get metrics metadata and metrics results to track activity on the platform. The Metrics APIs include endpoints for getting metrics metadata, such as what metrics exist for an app and the attributes on which those metrics can be queried. See the Metrics Documentation for more details. https://platform.instabase.com/docs/26.04/apis/v2-apis/model/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/v2-apis/model/index.html Table of Contents Metrics API Description Response schema Examples Use the Model API to get information about a specific training, evaluation, or pruning job in a model project. Metrics API Method Syntax GET api/v2/model/metrics Description Use this API to get metric information for a job, including F1 scores, confusion matrices, dataset record counts, and more. URL parameters Parameters are required unless marked as optional. Name Type Description model_project_path string The path to the model project’s folder. https://platform.instabase.com/docs/26.04/apis/model-service/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/model-service/index.html Table of Contents Error responses Single input model API Batch inputs model API Prescreening model API The Instabase platform can be accessed with the Model Service API. You can use HTTP API calls to use and test models. These API endpoints permit single and batch run requests, test requests, and job-based asynchronous execution of models. To use the following examples, replace instabase.com with your Instabase instance domain, and ACCESS_TOKEN with your access token from Instabase. https://platform.instabase.com/docs/26.04/apis/mount/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/mount/index.html Table of Contents Mount drive Request Response Update drive credentials Request Response Unmount drive Request Response Edit mounted drive point Request Response Mount database Request Response Unmount database Request Response Edit mounted database point Request Response Use the Mount API to mount a drive, such as S3 or NFS, or mount a database, like MySQL or Oracle, that your application can then interact with. See Instabase API authorization and response conventions for authorization, success response, and error response convention details. https://platform.instabase.com/docs/26.04/apis/organization/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/organization/index.html Table of Contents Create an organization Get organization information Update organization Delete organization Update organization admins List all organizations Site admins use the Organization API to manage your organization spaces. See Instabase API authorization and response conventions for authorization, success response, and error response convention details. For the Organization API, api_root defines where to route API requests for your Instabase instance: import json, requests api_root = "https://www.instabase.com/api/v1/organizations" Create an organization Use this API to create an organization space. https://platform.instabase.com/docs/26.04/apis/repo/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/repo/index.html Table of Contents Create a Subspace Get Subspace information Update Subspace Delete Subspace Add/Remove users to Subspace List Subspaces in Space List Subspace ACL Resources List Subspace ACLs for Resource Site admins use the Repo API to create and manage repos. import json, requests api_root = "https://www.instabase.com/api/v1/repos" See Instabase API authorization and response conventions for authorization and error convention details. Create a Subspace Use this API to create a Subspace. https://platform.instabase.com/docs/26.04/apis/scheduler/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/scheduler/index.html Table of Contents Create a scheduled job Description Examples List scheduled jobs Description Examples Delete a scheduled job Description Examples Enable a scheduled job Description Examples Disable a scheduled job Description Examples Manually trigger a scheduler Description Examples Use the Scheduler API to manage schedule operations, including creating, viewing, managing, and scheduling jobs. See Instabase API authorization and response conventions for authorization and response convention details. Create a scheduled job Method Syntax POST URL_BASE/api/v1/scheduler/create_job Description Create a scheduled job that will run on a regular interval. https://platform.instabase.com/docs/26.04/apis/search/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/search/index.html Table of Contents Search Documents Get Document Index Attributes Use the Search API to query for documents and retrieve document index attributes. Before you begin Document Search must be enabled in your Instabase deployment. For the Search API, api-root defines where to route API requests for your Instabase instance: import json, requests api_root = "https://www.instabase.com/api/v1/search" See Instabase API authorization and response conventions for authorization and error convention details. Search Documents Use this API to search for documents that match the specified query and are accessible by the user’s permissions. https://platform.instabase.com/docs/26.04/apis/security/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/security/index.html Use the Security API to manage multifactor authentication (MFA) tokens. For the Security API, api-root defines where to route API requests for your Instabase instance: import json, requests api_root = "https://www.instabase.com/api/v1/security" See Instabase API authorization and response conventions for authorization and error convention details. Get MFA info This API returns a user account’s MFA setup information. This API is callable only by: A site admin A user with the manage_user site ACL https://platform.instabase.com/docs/26.04/apis/site/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/site/index.html Table of Contents Get Site config Set Site Config Get Site ACLs Set Site ACLs Get database tables setup status Setup database tables Use the Site API to get and set site configurations and site ACLs. See Instabase API authorization and response conventions for authorization, success response, and error response convention details. For the Site API, api_root defines where to route API requests for your Instabase instance: import json, requests api_root = "https://www. https://platform.instabase.com/docs/26.04/apis/space/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/space/index.html Use the Space API to get details about the spaces in your instance. See Instabase API authorization and response conventions for authorization, success response, and error response convention details. For the Space API, api_root defines where to route API requests for your Instabase instance: import json, requests api_root = "https://www.instabase.com/api/v1/spaces" List Spaces Use this API to query the list of Spaces a user has access to with various search filters. The list will include both User Spaces as well as Organization Spaces. https://platform.instabase.com/docs/26.04/apis/test-runner-v1/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/test-runner-v1/index.html Table of Contents Run a test Test Runner with Test-Suite Test Runner with Test-Suite path Get test execution status Use this API to run a regression test that leverages the previous output of flows that were successfully run and compares the representative ground truth (also known as golden output) to the test output. See Instabase API authorization and response conventions for authorization, success response, and error response convention details. https://platform.instabase.com/docs/26.04/apis/v2-apis/test-runner-v2/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/v2-apis/test-runner-v2/index.html Table of Contents Execute test suites Description Get test execution status Description Note This API is in public preview. Use this API to run regression tests for solutions and flow. It leverages the previous output of flows referred to as ground truth (also known as golden output) to the test output. To authorize your request, the Test Runner API requires an Authorization header with the value Bearer XYZ, where XYZ is your access token. https://platform.instabase.com/docs/26.04/apis/upgrade/index.html Mon, 01 Jan 0001 00:00:00 +0000 https://platform.instabase.com/docs/26.04/apis/upgrade/index.html Table of Contents Before upgrading Overview of required and optional upgrade steps Conventions and authentication Asynchronous endpoint conventions Preflight checks Description Request parameters Examples Create upgrade Description Request parameters Response schema Examples Asynchronous upgrade creation Description Request parameters Response schema Examples Get results of asynchronous upgrade creation Description Request parameters Response schema Get upgrade Description Request parameters Response schema Examples Validate upgrade Description Request parameters Response schema Examples Asynchronous upgrade validation Description Request parameters Response schema Get results of asynchronous upgrade validation Description Request parameters Response schema Diff upgrade Description Request parameters Response schema Examples Summarize upgrade diff Description Request parameters Response schema Examples Asynchronous upgrade diff Description Request parameters Response schema Examples Get results of asynchronous upgrade diff Description Request parameters Response schema Start upgrade Description Request parameters Response schema Examples Get upgrade progress Description Request parameters Response schema Examples Stream upgrade events Description Request parameters Response schema Examples Get upgrade events Description Request parameters Response schema Examples Complete upgrade Description Request parameters Response schema Examples Pause upgrade Description Request parameters Response schema Examples Retry upgrade Description Request parameters Response schema Examples Continue upgrade Description Request parameters Response schema Examples Roll back upgrade Description Request parameters Response schema Examples Abandon upgrade Description Request parameters Response schema Examples Instabase supports performing platform upgrades by API.