Welcome to the OUTSCALE Public Documentation

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

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

What’s New?

Public Documentation

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.

December 20, 2022

November 16, 2022

October 4, 2022

  • All procedures of the User Guide that can be executed with OSC CLI now include links to the corresponding sections of the OUTSCALE API documentation.

September 20, 2022

  • A page summarizing the concepts and compatibility of the Elastic Identity Management (EIM) service is now available: About EIM.

API Release Notes

June 2023

June 19, 2023 (eu-west-2) / June 19, 2023 (cloudgouv-eu-west-1) / June 12, 2023 (us-west-1) / June 14, 2023 (us-east-2) / June 12, 2023 (ap-northeast-1)

  • You can now manage EIM users via the OUTSCALE API with the User methods.

  • You can now manage access keys for EIM users via the OUTSCALE API with the AccessKey methods.

April 2023

April 11, 2023 (eu-west-2) / April 14, 2023 (cloudgouv-eu-west-1) / April 3, 2023 (us-west-1) / April 5, 2023 (us-east-2) / April 3, 2023 (ap-northeast-1)

February 2023

February 27, 2023 (eu-west-2) / February 27, 2023 (cloudgouv-eu-west-1) / February 20, 2023 (us-west-1) / February 22, 2023 (us-east-2) / February 20, 2023 (ap-northeast-1)

  • In the DirectLink API, the Autonomous System Number (ASN) of private virtual interfaces must now be between 64512 and 65534. Existing connections are not affected.

  • In the OUTSCALE API, the UpdateDirectlinkInterface method now only supports a value of 1500 for the Mtu parameter.

  • Accounts of the cloudgouv-eu-west-1 Region are now notified by email 13 days, 8 days, and 1 day before the expiration of their password. For more information, see About Password Security.

Cockpit v2 Release Notes

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

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 or for any other motive. For more information, see Unpublishing a Product.

  • As a buyer:

    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