Welcome to the OUTSCALE Public Documentation

For a broad overview of the OUTSCALE Cloud, see Quickstart.

To learn how to create your first virtual machine (VM), see Tutorial: Getting Started with the OUTSCALE Cloud.

What’s New?

Public Documentation

March 14, 2024

  • The visual theme of the documentation website has been updated, in order to match the colors of the other OUTSCALE websites.

February 19, 2024

  • Wait conditions are now documented in the OUTSCALE Object Storage (OOS) section: Using Wait Conditions.

January 23, 2024

January 15, 2024

December 29, 2023

  • End of Life (EOL) of Cockpit v1. As of this date, Cockpit v1 is no longer available in any of our Regions. For more information, see End-of-Life Policy.

November 30, 2023

  • The Object Lock feature is now available in the OUTSCALE Object Storage (OOS) documentation. For more information, see Managing Object Lock.

  • As of this date, Cockpit v1 is no longer available in the cloudgouv-eu-west-1 Region. For more information, see End-of-Life Policy.

November 29, 2023

November 27, 2023

October 20, 2023

  • End of Support and Maintenance (EOSM) of Cockpit v1. As of this date, Cockpit v1 is no longer fixed nor supported. For more information, see End-of-Life Policy.

October 5, 2023

  • In the User Guide, the procedure pages now include descriptions and examples for OSC CLI, instead of only linking to sections of the OUTSCALE API documentation. For example, see Creating VMs > Creating VMs Using OSC CLI.

  • These OSC CLI descriptions and examples are the same in the User Guide and the OUTSCALE API documentation. Therefore, you can choose to use either part of the site depending on your browsing preference.

September 20, 2023

  • Cockpit v2 is now out of beta following the deployment of version 2.9:

    • As a consequence, the User Guide will now primarily use the terms used by Cockpit v2, which are also the terms of the OUTSCALE API (for example, resources are called virtual machines, Nets, etc.), rather than the legacy AWS terminology that was previously used (for example, instances, VPCs, etc.). Tooltips remain available on mouse hover to facilitate the transition. This terminology change also applies to page titles (for example, About Instances now redirects to About VMs).

    • For more information about version 2.9 of Cockpit v2, see the Cockpit v2 Release Notes.

September 18, 2023

August 30, 2023

  • The OUTSCALE API documentation now includes fully functional code samples:

    • Each of the 180 available methods features at least one code sample per programming language.

    • Some of the methods feature multiple code samples per programming language. For example, the CreateImage method features four different code samples, each one for a different use case in terms of request parameters.

    • For convenience, two copy buttons appear next to each code sample on mouse hover:

      • copy to clipboard: The first button copies the code as is, therefore as a multiline string.

      • copy to clipboard single line: The second button copies the code formatted as a single-line command (where applicable).

July 27, 2023

  • The search feature of the User Guide has been improved:

    • When using the search bar at the top right, you can now view the results in a distinct page and not only in the dropdown list.

    • You can now add the public documentation to your browser’s search engines. Doing so enables you to quickly search the documentation website by using a keyword shortcut. For example, you can type osc vm types in your URL bar to directly launch a search for "vm types" in the documentation, even if you are not already on the website. For more information, see Searching the Public Documentation From Your URL Bar.

  • You can now export any page of the User Guide to the PDF format, by using the button located in the right-side column of each page.

June 27, 2023

  • The API documentations have been updated:

    • The Authentication sections have been rewritten.

    • Code samples for the login/password authentication are now included.
      Note that the login/password authentication is only supported for certain actions, in the OUTSCALE API (for example, ReadAccessKeys) and in the ICU API (for example, ListAccessKeys).

    • Code samples in JavaScript are now included for the OUTSCALE API.
      They are based on the OUTSCALE SDK for TypeScript/JavaScript.

    • You can now switch between the programming languages by using the buttons above each code sample, as well as in the top left corner.

June 23, 2023

  • The AWS Compatibility Matrix has been updated. This page lists the correspondences between AWS-Compliant API methods and OUTSCALE API methods.

May 3, 2023

February 23, 2023

  • The API documentations now include a search bar in the top-left corner.

January 31, 2023

  • A page describing the different maturity levels of OUTSCALE open source projects is now available: Open Source Projects.

API Release Notes

January 2024

January 15, 2024 (eu-west-2) / January 16, 2024 (cloudgouv-eu-west-1) / January 8, 2024 (us-west-1) / January 10, 2024 (us-east-2) / January 9, 2024 (ap-northeast-1)

Cockpit v2 Release Notes

March 14, 2024 (Cockpit 2.15)

February 20, 2024 (Cockpit 2.14)

January 29, 2024 (Cockpit 2.13)

November 17, 2023 (Cockpit 2.10)

September 18, 2023 (Cockpit 2.8)

February 6, 2023 (Cockpit 2.4)

December 8, 2022 (Cockpit 2.3)

  • When creating a client gateway, you can now specify its name.

  • This release includes stability and error message improvements.

OUTSCALE Marketplace Release Notes

April 8, 2024

March 18, 2024

February 20, 2024

February 7, 2024

  • As a seller partner:

    • When creating an OMI product in bring your own license (BYOL) mode, you can now specify the URL to which buyers are redirected to subscribe to the product. For more information, see Creating and Publishing an OMI Product > Offer.

January 24, 2024

  • As a buyer:

    • When subscribing to a product, you can now reserve one or more virtual machines (VMs) among different VM types recommended by the seller partner, and for a Cloud account belonging to your organization. If required, you can also enter a purchase order ID. For more information, see About VMs > Reserved VMs and Subscribing To an OMI Product.

January 2, 2024

November 28, 2023

  • As a seller partner:

  • As a buyer:

    • As an administrator, you can now add OUTSCALE accounts to your organization to automatically share the permissions to the OMIs your organization subscribes to with these accounts. For more information, see Managing OUTSCALE Accounts as a Buyer.

    • Seller partners can now add templates to their OMI products to automate their deployment. You can access deployment templates from the My subscriptions page and from product pages.

    • You can now access product pages from the My subscriptions page.

November 8, 2023

October 18, 2023

  • As a seller partner:

  • As a buyer:

    • The procedure to subscribe to an outsourced product has been updated. For more information, see Subscribing To an Outsourced Product.

    • Your My subscriptions page is updated, and your organization receives an email, when seller partners modify the legal documents of their OMI products and apply the modifications to existing subscribers. For more information, see Subscribing To an OMI Product.

    • When the first administrator creates the organization, they must now specify if the company domiciled in France or abroad. For more information, see Creating an Organization as a Buyer.

  • You can now submit your seller partner application via the Becoming a seller partner page.

  • EIM resources marked by a marketplace_ prefix in the APIs and Cockpit v1 must not be modified nor deleted for the corresponding Marketplace accounts to be functional. For more information, see About OUTSCALE Marketplace > Administrators and Users.

  • This release also includes design, stability, and accessibility improvements.

September 7, 2023

  • As a seller partner:

    • You can now manage product versions. For more information, see the new procedure Managing OMI Product Versions.

    • The product depublication procedure has been updated. You can now unpublish OMI products because they have reached their end of life. For more information, see Unpublishing a Product.

  • As a buyer:

    • The procedure to subscribe to an OMI product on demand has been updated. For more information, see Subscribing To an OMI Product > Hourly Offer.

    • From the new Product History page, you can now:

      • View your on-demand product subscriptions.

      • View the products in BYOL mode you have accessed via the seller partners' websites.

      For more information, see Subscribing To an OMI Product.

    This release also includes design, stability, and accessibility improvements.

July 17, 2023

  • By default, the first administrator of an organization now has both an administrator role and a user role.

  • When creating an OMI product and completing its Version section, you can now select an OMI name or ID.

  • The My Products page now includes a Last update column.

  • You can now copy the product code of a product across the interface using a dedicated button.

  • This release also includes design and stability improvements.

June 12, 2023

August 3, 2022