NAV Navigation
Shell Python Java

3DS OUTSCALE API v0.15

Welcome to the 3DS OUTSCALE's API documentation.

The 3DS OUTSCALE API enables you to manage your resources in the 3DS OUTSCALE Cloud. This documentation describes the different actions available along with code examples.

Note that the 3DS OUTSCALE Cloud is compatible with Amazon Web Services (AWS) APIs, but some resources have different names in AWS than in the 3DS OUTSCALE API. You can find a list of the differences here.

You can also manage your resources using the Cockpit web interface.

Base URLs: https://api.{region}.outscale.com/oapi/v0

Terms of service Email: Support License: BSD 3 Clause

Authentication

ClientGateway

CreateClientGateway

POST /CreateClientGateway

Provides information about your client gateway.
This action registers information to identify the client gateway that you deployed in your network.
To open a tunnel to the client gateway, you must at least provide the communication protocol type, the valid fixed public IP address of the gateway, and an Autonomous System Number (ASN).
If you do not have any ASN assigned to your network, you may use a private ASN within the [64000; 64495] or [4200000000; 4294967294] ranges. By default, you can use 65000 as BGP ASN.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateClientGateway \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateClientGateway', params={ 'BgpAsn': '0', 'ConnectionType': 'string', 'PublicIp': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateClientGateway");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
BgpAsn body integer true An unsigned 32-bits Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find out the path to your client gateway through the Internet network. The integer must be within the [0;4294967295] range. By default, 65000.
ConnectionType body string true The communication protocol used to establish tunnel with your client gateway (only ipsec.1 is supported).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
PublicIp body string true The public fixed IPv4 address of your client gateway.

Body parameter

{
  "BgpAsn": 0,
  "ConnectionType": "string",
  "DryRun": true,
  "PublicIp": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateClientGatewayResponse

Example responses

200 Response

{
  "ClientGateway": {
    "BgpAsn": 0,
    "ClientGatewayId": "string",
    "ConnectionType": "string",
    "PublicIp": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteClientGateway

POST /DeleteClientGateway

Deletes a client gateway.
You must delete the VPN connection before deleting the client gateway.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteClientGateway \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteClientGateway', params={ 'ClientGatewayId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteClientGateway");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
ClientGatewayId body string true The ID of the client gateway you want to delete.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "ClientGatewayId": "string",
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteClientGatewayResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadClientGateways

POST /ReadClientGateways

Describes one or more of your client gateways.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadClientGateways \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadClientGateways', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadClientGateways");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersClientGateway false One or more filters.
» BgpAsns body [integer] false The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
» ClientGatewayIds body [string] false The IDs of the client gateways.
» ConnectionTypes body [string] false The types of communication tunnels used by the client gateways (only ipsec.1 is supported).
» PublicIps body [string] false The public IPv4 addresses of the client gateways.
» States body [string] false The states of the client gateways (pending | available | deleting | deleted).
» TagKeys body [string] false The keys of the tags associated with the client gateways.
» TagValues body [string] false The values of the tags associated with the client gateways.
» Tags body [string] false The key/value combination of the tags associated with the client gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "BgpAsns": [
      0
    ],
    "ClientGatewayIds": [
      "string"
    ],
    "ConnectionTypes": [
      "string"
    ],
    "PublicIps": [
      "string"
    ],
    "States": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadClientGatewaysResponse

Example responses

200 Response

{
  "ClientGateways": [
    {
      "BgpAsn": 0,
      "ClientGatewayId": "string",
      "ConnectionType": "string",
      "PublicIp": "string",
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

DhcpOption

CreateDhcpOptions

POST /CreateDhcpOptions

Creates a new set of DHCP options that you can then associate with a Net.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateDhcpOptions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateDhcpOptions', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateDhcpOptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DomainName body string false Specify a domain name (for example, MyCompany.com). You can specify only one domain name.
DomainNameServers body [string] false The IP addresses of domain name servers. If no IP addresses are specified, the OutscaleProvidedDNS value is set by default.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NtpServers body [string] false The IP addresses of the Network Time Protocol (NTP) servers.

Body parameter

{
  "DomainName": "string",
  "DomainNameServers": [
    "string"
  ],
  "DryRun": true,
  "NtpServers": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateDhcpOptionsResponse

Example responses

200 Response

{
  "DhcpOptionsSet": {
    "Default": true,
    "DhcpOptionsName": "string",
    "DhcpOptionsSetId": "string",
    "DomainName": "string",
    "DomainNameServers": [
      "string"
    ],
    "NtpServers": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteDhcpOptions

POST /DeleteDhcpOptions

Deletes a specified DHCP options set.
Before deleting a DHCP options set, you must disassociate it from the Nets you associated it with. To do so, you need to associate with each Net a new set of DHCP options, or the default one if you do not want to associate any DHCP options with the Net.

[NOTE]
You cannot delete the default set.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteDhcpOptions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteDhcpOptions', params={ 'DhcpOptionsSetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteDhcpOptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DhcpOptionsSetId body string true The ID of the DHCP options set you want to delete.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DhcpOptionsSetId": "string",
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteDhcpOptionsResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadDhcpOptions

POST /ReadDhcpOptions

Retrieves information about the content of one or more DHCP options sets.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadDhcpOptions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadDhcpOptions', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadDhcpOptions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersDhcpOptions false One or more filters.
» Default body boolean false If true, lists all default DHCP options set. If false, lists all non-default DHCP options set.
» DhcpOptionsSetIds body [string] false The IDs of the DHCP options sets.
» DomainNameServers body [string] false The domain name servers used for the DHCP options sets.
» DomainNames body [string] false The domain names used for the DHCP options sets.
» NtpServers body [string] false The Network Time Protocol (NTP) servers used for the DHCP options sets.
» TagKeys body [string] false The keys of the tags associated with the DHCP options sets.
» TagValues body [string] false The values of the tags associated with the DHCP options sets.
» Tags body [string] false The key/value combination of the tags associated with the DHCP options sets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "Default": true,
    "DhcpOptionsSetIds": [
      "string"
    ],
    "DomainNameServers": [
      "string"
    ],
    "DomainNames": [
      "string"
    ],
    "NtpServers": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadDhcpOptionsResponse

Example responses

200 Response

{
  "DhcpOptionsSets": [
    {
      "Default": true,
      "DhcpOptionsName": "string",
      "DhcpOptionsSetId": "string",
      "DomainName": "string",
      "DomainNameServers": [
        "string"
      ],
      "NtpServers": [
        "string"
      ],
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

DirectLink

POST /CreateDirectLink

Creates a new DirectLink between a customer network and a specified DirectLink location.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateDirectLink \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateDirectLink', params={ 'Bandwidth': 'string', 'DirectLinkName': 'string', 'Location': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateDirectLink");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameter In Type Required Description
Bandwidth body string true The bandwidth of the DirectLink (1GBps | 10GBps).
DirectLinkName body string true The name of the DirectLink.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Location body string true The code of the requested location for the DirectLink, returned by the ReadLocations method.

Body parameter

{
  "Bandwidth": "string",
  "DirectLinkName": "string",
  "DryRun": true,
  "Location": "string"
}
Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateDirectLinkResponse

Example responses

200 Response

{
  "DirectLink": {
    "AccountId": "string",
    "Bandwidth": "string",
    "DirectLinkId": "string",
    "DirectLinkName": "string",
    "Location": "string",
    "RegionName": "string",
    "State": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

POST /DeleteDirectLink

Deletes a specified DirectLink.
Before deleting a DirectLink, ensure that all your DirectLink interfaces related to this DirectLink are deleted.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteDirectLink \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteDirectLink', params={ 'DirectLinkId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteDirectLink");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameter In Type Required Description
DirectLinkId body string true The ID of the DirectLink you want to delete.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DirectLinkId": "string",
  "DryRun": true
}
Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteDirectLinkResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

POST /ReadDirectLinks

Lists all DirectLinks in the Region.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadDirectLinks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadDirectLinks', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadDirectLinks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersDirectLink false One or more filters.
» DirectLinkIds body [string] false The IDs of the DirectLinks.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "DirectLinkIds": [
      "string"
    ]
  }
}
Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadDirectLinksResponse

Example responses

200 Response

{
  "DirectLinks": [
    {
      "AccountId": "string",
      "Bandwidth": "string",
      "DirectLinkId": "string",
      "DirectLinkName": "string",
      "Location": "string",
      "RegionName": "string",
      "State": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

DirectLinkInterface

CreateDirectLinkInterface

POST /CreateDirectLinkInterface

Creates a DirectLink interface.
DirectLink interfaces enable you to reach one of your Nets through a virtual gateway.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateDirectLinkInterface \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateDirectLinkInterface', params={ 'DirectLinkId': 'string', 'DirectLinkInterface': {
  "BgpAsn": 0,
  "BgpKey": "string",
  "ClientPrivateIp": "string",
  "DirectLinkInterfaceName": "string",
  "OutscalePrivateIp": "string",
  "VirtualGatewayId": "string",
  "Vlan": 0
}, '» BgpAsn': '0', '» DirectLinkInterfaceName': 'string', '» VirtualGatewayId': 'string', '» Vlan': '0'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateDirectLinkInterface");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DirectLinkId body string true The ID of the existing DirectLink for which you want to create the DirectLink interface.
DirectLinkInterface body DirectLinkInterface true Information about the DirectLink interface.
» BgpAsn body integer true The BGP (Border Gateway Protocol) ASN (Autonomous System Number) on the customer's side of the DirectLink interface.
» BgpKey body string false The BGP authentication key.
» ClientPrivateIp body string false The IP address on the customer's side of the DirectLink interface.
» DirectLinkInterfaceName body string true The name of the DirectLink interface.
» OutscalePrivateIp body string false The IP address on 3DS OUTSCALE's side of the DirectLink interface.
» VirtualGatewayId body string true The ID of the target virtual gateway.
» Vlan body integer true The VLAN number associated with the DirectLink interface.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DirectLinkId": "string",
  "DirectLinkInterface": {
    "BgpAsn": 0,
    "BgpKey": "string",
    "ClientPrivateIp": "string",
    "DirectLinkInterfaceName": "string",
    "OutscalePrivateIp": "string",
    "VirtualGatewayId": "string",
    "Vlan": 0
  },
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateDirectLinkInterfaceResponse

Example responses

200 Response

{
  "DirectLinkInterface": {
    "AccountId": "string",
    "BgpAsn": 0,
    "BgpKey": "string",
    "ClientPrivateIp": "string",
    "DirectLinkId": "string",
    "DirectLinkInterfaceId": "string",
    "DirectLinkInterfaceName": "string",
    "InterfaceType": "string",
    "Location": "string",
    "OutscalePrivateIp": "string",
    "State": "string",
    "VirtualGatewayId": "string",
    "Vlan": 0
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteDirectLinkInterface

POST /DeleteDirectLinkInterface

Deletes a specified DirectLink interface.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteDirectLinkInterface \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteDirectLinkInterface', params={ 'DirectLinkInterfaceId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteDirectLinkInterface");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DirectLinkInterfaceId body string true The ID of the DirectLink interface you want to delete.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DirectLinkInterfaceId": "string",
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteDirectLinkInterfaceResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadDirectLinkInterfaces

POST /ReadDirectLinkInterfaces

Lists one or more of your DirectLink interfaces.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadDirectLinkInterfaces \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadDirectLinkInterfaces', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadDirectLinkInterfaces");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersDirectLinkInterface false One or more filters.
» DirectLinkIds body [string] false The IDs of the DirectLinks.
» DirectLinkInterfaceIds body [string] false The IDs of the DirectLink interfaces.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "DirectLinkIds": [
      "string"
    ],
    "DirectLinkInterfaceIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadDirectLinkInterfacesResponse

Example responses

200 Response

{
  "DirectLinkInterfaces": [
    {
      "AccountId": "string",
      "BgpAsn": 0,
      "BgpKey": "string",
      "ClientPrivateIp": "string",
      "DirectLinkId": "string",
      "DirectLinkInterfaceId": "string",
      "DirectLinkInterfaceName": "string",
      "InterfaceType": "string",
      "Location": "string",
      "OutscalePrivateIp": "string",
      "State": "string",
      "VirtualGatewayId": "string",
      "Vlan": 0
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

FlexibleGpu

CreateFlexibleGpu

POST /CreateFlexibleGpu

Allocates a flexible GPU (fGPU) to your account.
You can then attach this fGPU to a virtual machine (VM).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateFlexibleGpu \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateFlexibleGpu', params={ 'ModelName': 'string', 'SubregionName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateFlexibleGpu");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DeleteOnVmDeletion body boolean false If true, the fGPU is deleted when the VM is terminated.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ModelName body string true The model of GPU you want to allocate. For more information, see About Flexible GPUs.
SubregionName body string true The Subregion in which you want to create the fGPU.

Body parameter

{
  "DeleteOnVmDeletion": "false",
  "DryRun": true,
  "ModelName": "string",
  "SubregionName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateFlexibleGpuResponse

Example responses

200 Response

{
  "FlexibleGpu": {
    "DeleteOnVmDeletion": true,
    "FlexibleGpuId": "string",
    "ModelName": "string",
    "State": "string",
    "SubregionName": "string",
    "VmId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteFlexibleGpu

POST /DeleteFlexibleGpu

Releases a flexible GPU (fGPU) from your account.
The fGPU becomes free to be used by someone else.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteFlexibleGpu \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteFlexibleGpu', params={ 'FlexibleGpuId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteFlexibleGpu");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
FlexibleGpuId body string true The ID of the fGPU you want to delete.

Body parameter

{
  "DryRun": true,
  "FlexibleGpuId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteFlexibleGpuResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkFlexibleGpu

POST /LinkFlexibleGpu

Attaches one of your allocated flexible GPUs (fGPUs) to one of your virtual machines (VMs).
The fGPU is in the attaching state until the VM is stopped, after which it becomes attached.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkFlexibleGpu \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkFlexibleGpu', params={ 'FlexibleGpuId': 'string', 'VmId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkFlexibleGpu");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
FlexibleGpuId body string true The ID of the fGPU you want to attach.
VmId body string true The ID of the VM you want to attach the fGPU to.

Body parameter

{
  "DryRun": true,
  "FlexibleGpuId": "string",
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkFlexibleGpuResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadFlexibleGpuCatalog

POST /ReadFlexibleGpuCatalog

Lists all flexible GPUs available in the public catalog.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadFlexibleGpuCatalog \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadFlexibleGpuCatalog', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadFlexibleGpuCatalog");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadFlexibleGpuCatalogResponse

Example responses

200 Response

{
  "FlexibleGpuCatalog": [
    {
      "Generations": "string",
      "MaxCpu": 0,
      "MaxRam": 0,
      "ModelName": "string",
      "VRam": 0
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadFlexibleGpus

POST /ReadFlexibleGpus

Lists one or more flexible GPUs (fGPUs) allocated to your account.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadFlexibleGpus \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadFlexibleGpus', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadFlexibleGpus");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersFlexibleGpu false One or more filters.
» DeleteOnVmDeletion body boolean false Indicates whether the fGPU is deleted when terminating the VM.
» FlexibleGpuIds body [string] false One or more IDs of fGPUs.
» ModelNames body [string] false One or more models of fGPUs. For more information, see About Flexible GPUs.
» States body [string] false The states of the fGPUs (allocated | attaching | attached | detaching).
» SubregionNames body [string] false The Subregions where the fGPUs are located.
» VmIds body [string] false One or more IDs of VMs.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "DeleteOnVmDeletion": true,
    "FlexibleGpuIds": [
      "string"
    ],
    "ModelNames": [
      "string"
    ],
    "States": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "VmIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadFlexibleGpusResponse

Example responses

200 Response

{
  "FlexibleGpus": [
    {
      "DeleteOnVmDeletion": true,
      "FlexibleGpuId": "string",
      "ModelName": "string",
      "State": "string",
      "SubregionName": "string",
      "VmId": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UnlinkFlexibleGpu

POST /UnlinkFlexibleGpu

Detaches a flexible GPU (fGPU) from a virtual machine (VM).
The fGPU is in the detaching state until the VM is stopped, after which it becomes available for allocation again.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkFlexibleGpu \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkFlexibleGpu', params={ 'FlexibleGpuId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkFlexibleGpu");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
FlexibleGpuId body string true The ID of the fGPU you want to detach from your VM.

Body parameter

{
  "DryRun": true,
  "FlexibleGpuId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkFlexibleGpuResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateFlexibleGpu

POST /UpdateFlexibleGpu

Modifies a flexible GPU (fGPU) behavior.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateFlexibleGpu \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateFlexibleGpu', params={ 'FlexibleGpuId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateFlexibleGpu");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DeleteOnVmDeletion body boolean false If true, the fGPU is deleted when the VM is terminated.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
FlexibleGpuId body string true The ID of the fGPU you want to modify.

Body parameter

{
  "DeleteOnVmDeletion": true,
  "DryRun": true,
  "FlexibleGpuId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateFlexibleGpuResponse

Example responses

200 Response

{
  "FlexibleGpu": {
    "DeleteOnVmDeletion": true,
    "FlexibleGpuId": "string",
    "ModelName": "string",
    "State": "string",
    "SubregionName": "string",
    "VmId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

Health

ReadVmsHealth

POST /ReadVmsHealth

Lists the state of one or more back-end virtual machines (VMs) registered with a specified load balancer.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVmsHealth \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVmsHealth', params={ 'LoadBalancerName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVmsHealth");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
BackendVmIds body [string] false One or more IDs of back-end VMs.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer.

Body parameter

{
  "BackendVmIds": [
    "string"
  ],
  "DryRun": true,
  "LoadBalancerName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVmsHealthResponse

Example responses

200 Response

{
  "BackendVmHealth": [
    {
      "Description": "string",
      "State": "string",
      "StateReason": "string",
      "VmId": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

Image

CreateImage

POST /CreateImage

Creates an Outscale machine image (OMI) from an existing virtual machine (VM) which is either running or stopped.
This action also creates a snapshot of the root volume of the VM, as well as a snapshot of each Block Storage Unit (BSU) volume attached to the VM.

You can also use this method to copy an OMI to your account, from an account in the same Region. To do so, the owner of the source OMI must share it with your account. For more information about how to share an OMI with another account in the same Region, see UpdateImage.
To copy an OMI between accounts in different Regions, the owner of the source OMI must first export it to an Object Storage Unit (OSU) bucket using the CreateImageExportTask method, and then you need to create a copy of the image in your account.
The copy of the source OMI is independent and belongs to you.

You can also use this method to register an OMI to finalize its creation process.
You can register an OMI from a snapshot of a root device to create an OMI based on this snapshot. You can also register an OMI that has been exported to an OSU bucket to create a copy of it in your account. For more information about OMI export to an OSU bucket, see CreateImageExportTask.
You can register an OMI using a pre-signed URL of the manifest file of the OMI. You do not need any permission for this OMI, or the bucket in which it is contained. The manifest file is obsolete seven days after a completed export as it contains pre-signed URLs to the appropriate snapshots (pre-signed URLs are valid for only seven days).
Once the OMI is registered, you can launch a VM from this OMI. The copy of the source OMI is independent and belongs to you.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateImage \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateImage', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateImage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
Architecture body string false The architecture of the OMI (by default, i386).
BlockDeviceMappings body [BlockDeviceMappingImage] false One or more block device mappings.
» Bsu body BsuToCreate false Information about the BSU volume to create.
»» DeleteOnVmDeletion body boolean false Set to true by default, which means that the volume is deleted when the VM is terminated. If set to false, the volume is not deleted when the VM is terminated.
»» Iops body integer false The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000.
»» SnapshotId body string false The ID of the snapshot used to create the volume.
»» VolumeSize body integer false The size of the volume, in gibibytes (GiB).
»» VolumeType body string false The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created.
» DeviceName body string false The name of the device.
» VirtualDeviceName body string false The name of the virtual device (ephemeralN).
Description body string false A description for the new OMI.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
FileLocation body string false The pre-signed URL of the OMI manifest file, or the full path to the OMI stored in an OSU bucket. If you specify this parameter, a copy of the OMI is created in your account.
ImageName body string false A unique name for the new OMI.
NoReboot body boolean false If false, the VM shuts down before creating the OMI and then reboots. If true, the VM does not.
RootDeviceName body string false The name of the root device.
SourceImageId body string false The ID of the OMI you want to copy.
SourceRegionName body string false The name of the source Region, which must be the same as the Region of your account.
VmId body string false The ID of the VM from which you want to create the OMI.

Detailed descriptions

»» VolumeSize: The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.

»» VolumeType: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created.
For more information about volume types, see Volume Types and IOPS.

ImageName: A unique name for the new OMI.
Constraints: 3-128 alphanumeric characters, underscores (_), spaces ( ), parentheses (()), slashes (/), periods (.), or dashes (-).

Body parameter

{
  "Architecture": "string",
  "BlockDeviceMappings": [
    {
      "Bsu": {
        "DeleteOnVmDeletion": true,
        "Iops": 0,
        "SnapshotId": "string",
        "VolumeSize": 0,
        "VolumeType": "string"
      },
      "DeviceName": "string",
      "VirtualDeviceName": "string"
    }
  ],
  "Description": "string",
  "DryRun": true,
  "FileLocation": "string",
  "ImageName": "string",
  "NoReboot": true,
  "RootDeviceName": "string",
  "SourceImageId": "string",
  "SourceRegionName": "string",
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateImageResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Image": {
    "AccountAlias": "string",
    "AccountId": "string",
    "Architecture": "string",
    "BlockDeviceMappings": [
      {
        "Bsu": {
          "DeleteOnVmDeletion": true,
          "Iops": 0,
          "SnapshotId": "string",
          "VolumeSize": 0,
          "VolumeType": "string"
        },
        "DeviceName": "string",
        "VirtualDeviceName": "string"
      }
    ],
    "CreationDate": "2019-11-08",
    "Description": "string",
    "FileLocation": "string",
    "ImageId": "string",
    "ImageName": "string",
    "ImageType": "string",
    "PermissionsToLaunch": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "ProductCodes": [
      "string"
    ],
    "RootDeviceName": "string",
    "RootDeviceType": "string",
    "State": "string",
    "StateComment": {
      "StateCode": "string",
      "StateMessage": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateImageExportTask

POST /CreateImageExportTask

Exports an Outscale machine image (OMI) to an Object Storage Unit (OSU) bucket.
This action enables you to copy an OMI between accounts in different Regions. To copy an OMI in the same Region, you can also use the CreateImage method.
The copy of the OMI belongs to you and is independent from the source OMI.

[NOTE]
You cannot export a shared or public OMI, as they do not belong to you. To do so, you must first copy it to your account. The copy then belongs to you and you can export it.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateImageExportTask \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateImageExportTask', params={ 'ImageId': 'string', 'OsuExport': {
  "DiskImageFormat": "string",
  "OsuApiKey": {
    "ApiKeyId": "string",
    "SecretKey": "string"
  },
  "OsuBucket": "string",
  "OsuManifestUrl": "string",
  "OsuPrefix": "string"
}, '» DiskImageFormat': 'string', '» OsuBucket': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateImageExportTask");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ImageId body string true The ID of the OMI to export.
OsuExport body OsuExport true Information about the OSU export.
» DiskImageFormat body string true The format of the export disk (qcow2 | vdi | vmdk).
» OsuApiKey body OsuApiKey false Information about the OSU API key.
»» ApiKeyId body string false The API key of the OSU account that enables you to access the bucket.
»» SecretKey body string false The secret key of the OSU account that enables you to access the bucket.
» OsuBucket body string true The name of the OSU bucket you want to export the object to.
» OsuManifestUrl body string false The URL of the manifest file.
» OsuPrefix body string false The prefix for the key of the OSU object. This key follows this format: prefix + object_export_task_id + '.' + disk_image_format.

Body parameter

{
  "DryRun": true,
  "ImageId": "string",
  "OsuExport": {
    "DiskImageFormat": "string",
    "OsuApiKey": {
      "ApiKeyId": "string",
      "SecretKey": "string"
    },
    "OsuBucket": "string",
    "OsuManifestUrl": "string",
    "OsuPrefix": "string"
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateImageExportTaskResponse

Example responses

200 Response

{
  "ImageExportTask": {
    "Comment": "string",
    "ImageId": "string",
    "OsuExport": {
      "DiskImageFormat": "string",
      "OsuApiKey": {
        "ApiKeyId": "string",
        "SecretKey": "string"
      },
      "OsuBucket": "string",
      "OsuManifestUrl": "string",
      "OsuPrefix": "string"
    },
    "Progress": 0,
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "TaskId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteImage

POST /DeleteImage

Deletes an Outscale machine image (OMI) so that you cannot use it anymore to launch virtual machines (VMs). However, you can still use VMs already launched from this OMI.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteImage \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteImage', params={ 'ImageId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteImage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ImageId body string true The ID of the OMI you want to delete.

Body parameter

{
  "DryRun": true,
  "ImageId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteImageResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadImageExportTasks

POST /ReadImageExportTasks

Lists one or more image export tasks.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadImageExportTasks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadImageExportTasks', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadImageExportTasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersExportTask false One or more filters.
» TagKeys body [string] false The keys of the tags associated with the export tasks.
» TagValues body [string] false The values of the tags associated with the export tasks.
» Tags body [string] false The key/value combination of the tags associated with the export tasks, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» TaskIds body [string] false The IDs of the export tasks.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "TaskIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadImageExportTasksResponse

Example responses

200 Response

{
  "ImageExportTasks": [
    {
      "Comment": "string",
      "ImageId": "string",
      "OsuExport": {
        "DiskImageFormat": "string",
        "OsuApiKey": {
          "ApiKeyId": "string",
          "SecretKey": "string"
        },
        "OsuBucket": "string",
        "OsuManifestUrl": "string",
        "OsuPrefix": "string"
      },
      "Progress": 0,
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "TaskId": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadImages

POST /ReadImages

Lists one or more Outscale machine images (OMIs) you can use.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadImages \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadImages', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadImages");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersImage false One or more filters.
» AccountAliases body [string] false The account aliases of the owners of the OMIs.
» AccountIds body [string] false The account IDs of the owners of the OMIs. By default, all the OMIs for which you have launch permissions are described.
» Architectures body [string] false The architectures of the OMIs (i386 | x86_64).
» BlockDeviceMappingDeleteOnVmDeletion body boolean false Indicates whether the block device mapping is deleted when terminating the VM.
» BlockDeviceMappingDeviceNames body [string] false The device names for the volumes.
» BlockDeviceMappingSnapshotIds body [string] false The IDs of the snapshots used to create the volumes.
» BlockDeviceMappingVolumeSizes body [integer] false The sizes of the volumes, in gibibytes (GiB).
» BlockDeviceMappingVolumeTypes body [string] false The types of volumes (standard | gp2 | io1).
» Descriptions body [string] false The descriptions of the OMIs, provided when they were created.
» FileLocations body [string] false The locations where the OMI files are stored on Object Storage Unit (OSU).
» ImageIds body [string] false The IDs of the OMIs.
» ImageNames body [string] false The names of the OMIs, provided when they were created.
» PermissionsToLaunchAccountIds body [string] false The account IDs of the users who have launch permissions for the OMIs.
» PermissionsToLaunchGlobalPermission body boolean false If true, lists all public OMIs. If false, lists all private OMIs.
» RootDeviceNames body [string] false The device names of the root devices (for example, /dev/sda1).
» RootDeviceTypes body [string] false The types of root device used by the OMIs (always ebs).
» States body [string] false The states of the OMIs.
» TagKeys body [string] false The keys of the tags associated with the OMIs.
» TagValues body [string] false The values of the tags associated with the OMIs.
» Tags body [string] false The key/value combination of the tags associated with the OMIs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» VirtualizationTypes body [string] false The virtualization types (always hvm).

Body parameter

{
  "DryRun": true,
  "Filters": {
    "AccountAliases": [
      "string"
    ],
    "AccountIds": [
      "string"
    ],
    "Architectures": [
      "string"
    ],
    "BlockDeviceMappingDeleteOnVmDeletion": true,
    "BlockDeviceMappingDeviceNames": [
      "string"
    ],
    "BlockDeviceMappingSnapshotIds": [
      "string"
    ],
    "BlockDeviceMappingVolumeSizes": [
      0
    ],
    "BlockDeviceMappingVolumeTypes": [
      "string"
    ],
    "Descriptions": [
      "string"
    ],
    "FileLocations": [
      "string"
    ],
    "ImageIds": [
      "string"
    ],
    "ImageNames": [
      "string"
    ],
    "PermissionsToLaunchAccountIds": [
      "string"
    ],
    "PermissionsToLaunchGlobalPermission": true,
    "RootDeviceNames": [
      "string"
    ],
    "RootDeviceTypes": [
      "string"
    ],
    "States": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "VirtualizationTypes": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadImagesResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Images": [
    {
      "AccountAlias": "string",
      "AccountId": "string",
      "Architecture": "string",
      "BlockDeviceMappings": [
        {
          "Bsu": {
            "DeleteOnVmDeletion": true,
            "Iops": 0,
            "SnapshotId": "string",
            "VolumeSize": 0,
            "VolumeType": "string"
          },
          "DeviceName": "string",
          "VirtualDeviceName": "string"
        }
      ],
      "CreationDate": "2019-11-08",
      "Description": "string",
      "FileLocation": "string",
      "ImageId": "string",
      "ImageName": "string",
      "ImageType": "string",
      "PermissionsToLaunch": {
        "AccountIds": [
          "string"
        ],
        "GlobalPermission": true
      },
      "ProductCodes": [
        "string"
      ],
      "RootDeviceName": "string",
      "RootDeviceType": "string",
      "State": "string",
      "StateComment": {
        "StateCode": "string",
        "StateMessage": "string"
      },
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateImage

POST /UpdateImage

Modifies the specified attribute of an Outscale machine image (OMI).
You can specify only one attribute at a time. You can modify the permissions to access the OMI by adding or removing account IDs or groups. You can share an OMI with a user that is in the same Region. The user can create a copy of the OMI you shared, obtaining all the rights for the copy of the OMI. For more information, see CreateImage.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateImage \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateImage', params={ 'ImageId': 'string', 'PermissionsToLaunch': {
  "Additions": {
    "AccountIds": [
      "string"
    ],
    "GlobalPermission": true
  },
  "Removals": {
    "AccountIds": [
      "string"
    ],
    "GlobalPermission": true
  }
}}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateImage");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ImageId body string true The ID of the OMI you want to modify.
PermissionsToLaunch body PermissionsOnResourceCreation true Information about the permissions for the resource.
» Additions body PermissionsOnResource false Information about the users who have permissions for the resource.
»» AccountIds body [string] false The account ID of one or more users who have permissions for the resource.
»» GlobalPermission body boolean false If true, the resource is public. If false, the resource is private.
» Removals body PermissionsOnResource false Information about the users who have permissions for the resource.

Body parameter

{
  "DryRun": true,
  "ImageId": "string",
  "PermissionsToLaunch": {
    "Additions": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "Removals": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    }
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateImageResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Image": {
    "AccountAlias": "string",
    "AccountId": "string",
    "Architecture": "string",
    "BlockDeviceMappings": [
      {
        "Bsu": {
          "DeleteOnVmDeletion": true,
          "Iops": 0,
          "SnapshotId": "string",
          "VolumeSize": 0,
          "VolumeType": "string"
        },
        "DeviceName": "string",
        "VirtualDeviceName": "string"
      }
    ],
    "CreationDate": "2019-11-08",
    "Description": "string",
    "FileLocation": "string",
    "ImageId": "string",
    "ImageName": "string",
    "ImageType": "string",
    "PermissionsToLaunch": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "ProductCodes": [
      "string"
    ],
    "RootDeviceName": "string",
    "RootDeviceType": "string",
    "State": "string",
    "StateComment": {
      "StateCode": "string",
      "StateMessage": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

InternetService

CreateInternetService

POST /CreateInternetService

Creates an Internet service you can use with a Net.
An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private and a public IP addresses.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateInternetService \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateInternetService', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateInternetService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateInternetServiceResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "InternetService": {
    "InternetServiceId": "string",
    "NetId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteInternetService

POST /DeleteInternetService

Deletes an Internet service.
Before deleting an Internet service, you must detach it from any Net it is attached to.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteInternetService \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteInternetService', params={ 'InternetServiceId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteInternetService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
InternetServiceId body string true The ID of the Internet service you want to delete.

Body parameter

{
  "DryRun": true,
  "InternetServiceId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteInternetServiceResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkInternetService

POST /LinkInternetService

Attaches an Internet service to a Net.
To enable the connection between the Internet and a Net, you must attach an Internet service to this Net.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkInternetService \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkInternetService', params={ 'InternetServiceId': 'string', 'NetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkInternetService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
InternetServiceId body string true The ID of the Internet service you want to attach.
NetId body string true The ID of the Net to which you want to attach the Internet service.

Body parameter

{
  "DryRun": true,
  "InternetServiceId": "string",
  "NetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkInternetServiceResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadInternetServices

POST /ReadInternetServices

Lists one or more of your Internet services.
An Internet service enables your virtual machines (VMs) launched in a Net to connect to the Internet. By default, a Net includes an Internet service, and each Subnet is public. Every VM launched within a default Subnet has a private and a public IP addresses.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadInternetServices \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadInternetServices', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadInternetServices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersInternetService false One or more filters.
» InternetServiceIds body [string] false The IDs of the Internet services.
» TagKeys body [string] false The keys of the tags associated with the Internet services.
» TagValues body [string] false The values of the tags associated with the Internet services.
» Tags body [string] false The key/value combination of the tags associated with the Internet services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "InternetServiceIds": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadInternetServicesResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "InternetServices": [
    {
      "InternetServiceId": "string",
      "NetId": "string",
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UnlinkInternetService

POST /UnlinkInternetService

Detaches an Internet service from a Net.
This action disables and detaches an Internet service from a Net. The Net must not contain any running virtual machine (VM) using an External IP address (EIP).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkInternetService \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkInternetService', params={ 'InternetServiceId': 'string', 'NetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkInternetService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
InternetServiceId body string true The ID of the Internet service you want to detach.
NetId body string true The ID of the Net from which you want to detach the Internet service.

Body parameter

{
  "DryRun": true,
  "InternetServiceId": "string",
  "NetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkInternetServiceResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

Keypair

CreateKeypair

POST /CreateKeypair

Creates a 2048-bit RSA keypair with a specified name.
This action returns the private key that you need to save. The public key is stored by 3DS OUTSCALE.

You can also use this method to import a provided public key and create a keypair.
This action imports the public key of a keypair created by a third-party tool and uses it to create a new keypair. The private key is never provided to 3DS OUTSCALE.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateKeypair \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateKeypair', params={ 'KeypairName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateKeypair");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
KeypairName body string true A unique name for the keypair, with a maximum length of 255 ASCII printable characters.
PublicKey body string false The public key. If you are not using command line tools, it must be encoded in Base64.

Body parameter

{
  "DryRun": true,
  "KeypairName": "string",
  "PublicKey": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateKeypairResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
409 Conflict The HTTP 409 response (Conflict). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Keypair": {
    "KeypairFingerprint": "string",
    "KeypairName": "string",
    "PrivateKey": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteKeypair

POST /DeleteKeypair

Deletes the specified keypair.
This action deletes the public key stored by 3DS OUTSCALE, thus deleting the keypair.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteKeypair \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteKeypair', params={ 'KeypairName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteKeypair");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
KeypairName body string true The name of the keypair you want to delete.

Body parameter

{
  "DryRun": true,
  "KeypairName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteKeypairResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadKeypairs

POST /ReadKeypairs

Lists one or more of your keypairs.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadKeypairs \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadKeypairs', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadKeypairs");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersKeypair false One or more filters.
» KeypairFingerprints body [string] false The fingerprints of the keypairs.
» KeypairNames body [string] false The names of the keypairs.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "KeypairFingerprints": [
      "string"
    ],
    "KeypairNames": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadKeypairsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Keypairs": [
    {
      "KeypairFingerprint": "string",
      "KeypairName": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

Listener

CreateLoadBalancerListeners

POST /CreateLoadBalancerListeners

Creates one or more listeners for a specified load balancer.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancerListeners \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancerListeners', params={ 'Listeners': [
  {
    "BackendPort": 0,
    "BackendProtocol": "string",
    "LoadBalancerPort": 0,
    "LoadBalancerProtocol": "string",
    "ServerCertificateId": "string"
  }
], '» BackendPort': '0', '» LoadBalancerPort': '0', '» LoadBalancerProtocol': 'string', 'LoadBalancerName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancerListeners");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Listeners body [ListenerForCreation] true One or more listeners for the load balancer.
» BackendPort body integer true The port on which the back-end VM is listening (between 1 and 65535, both included).
» BackendProtocol body string false The protocol for routing traffic to back-end VMs (HTTP | HTTPS | TCP | SSL | UDP).
» LoadBalancerPort body integer true The port on which the load balancer is listening (between 1 and 65535, both included).
» LoadBalancerProtocol body string true The routing protocol (HTTP | HTTPS | TCP | SSL | UDP).
» ServerCertificateId body string false The ID of the server certificate.
LoadBalancerName body string true The name of the load balancer for which you want to create listeners.

Body parameter

{
  "DryRun": true,
  "Listeners": [
    {
      "BackendPort": 0,
      "BackendProtocol": "string",
      "LoadBalancerPort": 0,
      "LoadBalancerProtocol": "string",
      "ServerCertificateId": "string"
    }
  ],
  "LoadBalancerName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLoadBalancerListenersResponse

Example responses

200 Response

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerListeners

POST /DeleteLoadBalancerListeners

Deletes listeners of a specified load balancer.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancerListeners \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancerListeners', params={ 'LoadBalancerName': 'string', 'LoadBalancerPorts': [
  0
]}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancerListeners");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer for which you want to delete listeners.
LoadBalancerPorts body [integer] true One or more port numbers of the listeners you want to delete.

Body parameter

{
  "DryRun": true,
  "LoadBalancerName": "string",
  "LoadBalancerPorts": [
    0
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteLoadBalancerListenersResponse

Example responses

200 Response

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

LoadBalancer

CreateLoadBalancer

POST /CreateLoadBalancer

Creates a load balancer.
The load balancer is created with a unique Domain Name Service (DNS) name. It receives the incoming traffic and routes it to its registered virtual machines (VMs).
By default, this action creates an Internet-facing load balancer, resolving to public IP addresses. To create an internal load balancer in a Net, resolving to private IP addresses, use the LoadBalancerType parameter.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancer', params={ 'Listeners': [
  {
    "BackendPort": 0,
    "BackendProtocol": "string",
    "LoadBalancerPort": 0,
    "LoadBalancerProtocol": "string",
    "ServerCertificateId": "string"
  }
], '» BackendPort': '0', '» LoadBalancerPort': '0', '» LoadBalancerProtocol': 'string', 'LoadBalancerName': 'string', '» Key': 'string', '» Value': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Listeners body [ListenerForCreation] true One or more listeners to create.
» BackendPort body integer true The port on which the back-end VM is listening (between 1 and 65535, both included).
» BackendProtocol body string false The protocol for routing traffic to back-end VMs (HTTP | HTTPS | TCP | SSL | UDP).
» LoadBalancerPort body integer true The port on which the load balancer is listening (between 1 and 65535, both included).
» LoadBalancerProtocol body string true The routing protocol (HTTP | HTTPS | TCP | SSL | UDP).
» ServerCertificateId body string false The ID of the server certificate.
LoadBalancerName body string true The unique name of the load balancer (32 alphanumeric or hyphen characters maximum, but cannot start or end with a hyphen).
LoadBalancerType body string false The type of load balancer: internet-facing or internal. Use this parameter only for load balancers in a Net.
SecurityGroups body [string] false One or more IDs of security groups you want to assign to the load balancer.
Subnets body [string] false One or more IDs of Subnets in your Net that you want to attach to the load balancer.
SubregionNames body [string] false One or more names of Subregions (currently, only one Subregion is supported). This parameter is not required if you create a load balancer in a Net. To create an internal load balancer, use the LoadBalancerType parameter.
Tags body [ResourceTag] false One or more tags assigned to the load balancer.
» Key body string true The key of the tag, with a minimum of 1 character.
» Value body string true The value of the tag, between 0 and 255 characters.

Detailed descriptions

SecurityGroups: One or more IDs of security groups you want to assign to the load balancer.
In a Net, this attribute is required. In the public Cloud, it is optional and default security groups can be applied.

Body parameter

{
  "DryRun": true,
  "Listeners": [
    {
      "BackendPort": 0,
      "BackendProtocol": "string",
      "LoadBalancerPort": 0,
      "LoadBalancerProtocol": "string",
      "ServerCertificateId": "string"
    }
  ],
  "LoadBalancerName": "string",
  "LoadBalancerType": "string",
  "SecurityGroups": [
    "string"
  ],
  "Subnets": [
    "string"
  ],
  "SubregionNames": [
    "string"
  ],
  "Tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLoadBalancerResponse

Example responses

200 Response

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteLoadBalancer

POST /DeleteLoadBalancer

Deletes a specified load balancer.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancer', params={ 'LoadBalancerName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer you want to delete.

Body parameter

{
  "DryRun": true,
  "LoadBalancerName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteLoadBalancerResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeregisterVmsInLoadBalancer

POST /DeregisterVmsInLoadBalancer

Deregisters a specified virtual machine (VM) from a load balancer.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeregisterVmsInLoadBalancer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeregisterVmsInLoadBalancer', params={ 'BackendVmIds': [
  "string"
], 'LoadBalancerName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeregisterVmsInLoadBalancer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
BackendVmIds body [string] true One or more IDs of back-end VMs.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer.

Body parameter

{
  "BackendVmIds": [
    "string"
  ],
  "DryRun": true,
  "LoadBalancerName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeregisterVmsInLoadBalancerResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadLoadBalancers

POST /ReadLoadBalancers

Lists one or more load balancers and their attributes.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadLoadBalancers \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadLoadBalancers', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadLoadBalancers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersLoadBalancer false One or more filters.
» LoadBalancerNames body [string] false The names of the load balancers.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "LoadBalancerNames": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadLoadBalancersResponse

Example responses

200 Response

{
  "LoadBalancers": [
    {
      "AccessLog": {
        "IsEnabled": true,
        "OsuBucketName": "string",
        "OsuBucketPrefix": "string",
        "PublicationInterval": 0
      },
      "ApplicationStickyCookiePolicies": [
        {
          "CookieName": "string",
          "PolicyName": "string"
        }
      ],
      "BackendVmIds": [
        "string"
      ],
      "DnsName": "string",
      "HealthCheck": {
        "CheckInterval": 0,
        "HealthyThreshold": 0,
        "Path": "string",
        "Port": 0,
        "Protocol": "string",
        "Timeout": 0,
        "UnhealthyThreshold": 0
      },
      "Listeners": [
        {
          "BackendPort": 0,
          "BackendProtocol": "string",
          "LoadBalancerPort": 0,
          "LoadBalancerProtocol": "string",
          "PolicyNames": [
            "string"
          ],
          "ServerCertificateId": "string"
        }
      ],
      "LoadBalancerName": "string",
      "LoadBalancerStickyCookiePolicies": [
        {
          "PolicyName": "string"
        }
      ],
      "LoadBalancerType": "string",
      "NetId": "string",
      "SecurityGroups": [
        "string"
      ],
      "SourceSecurityGroup": {
        "SecurityGroupAccountId": "string",
        "SecurityGroupName": "string"
      },
      "Subnets": [
        "string"
      ],
      "SubregionNames": [
        "string"
      ],
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

RegisterVmsInLoadBalancer

POST /RegisterVmsInLoadBalancer

Registers one or more virtual machines (VMs) with a specified load balancer.
The VMs must be running in the same network as the load balancer (in the public Cloud or in the same Net). It may take a little time for a VM to be registered with the load balancer. Once the VM is registered with a load balancer, it receives traffic and requests from this load balancer and is called a back-end VM.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/RegisterVmsInLoadBalancer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/RegisterVmsInLoadBalancer', params={ 'BackendVmIds': [
  "string"
], 'LoadBalancerName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/RegisterVmsInLoadBalancer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
BackendVmIds body [string] true One or more IDs of back-end VMs.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer.

Detailed descriptions

BackendVmIds: One or more IDs of back-end VMs.
Specifying the same ID several times has no effect as each back-end VM has equal weight.

Body parameter

{
  "BackendVmIds": [
    "string"
  ],
  "DryRun": true,
  "LoadBalancerName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RegisterVmsInLoadBalancerResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateLoadBalancer

POST /UpdateLoadBalancer

Modifies the specified attributes of a load balancer.

You can set a new SSL certificate to an SSL or HTTPS listener of a load balancer.
This certificate replaces any certificate used on the same load balancer and port.

You can also replace the current set of policies for a load balancer with another specified one.
If the PolicyNames parameter is empty, all current policies are disabled.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateLoadBalancer \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateLoadBalancer', params={ '» CheckInterval': '0', '» HealthyThreshold': '0', '» Path': 'string', '» Port': '0', '» Protocol': 'string', '» Timeout': '0', '» UnhealthyThreshold': '0', 'LoadBalancerName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateLoadBalancer");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
AccessLog body AccessLog false Information about access logs.
» IsEnabled body boolean false If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the OsuBucketName parameter is required.
» OsuBucketName body string false The name of the Object Storage Unit (OSU) bucket for the access logs.
» OsuBucketPrefix body string false The path to the folder of the access logs in your Object Storage Unit (OSU) bucket (by default, the root level of your bucket).
» PublicationInterval body integer false The time interval for the publication of access logs in the Object Storage Unit (OSU) bucket, in minutes. This value can be either 5 or 60 (by default, 60).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
HealthCheck body HealthCheck false Information about the health check configuration.
» CheckInterval body integer true The number of seconds between two pings (between 5 and 600 both included).
» HealthyThreshold body integer true The number of consecutive successful pings before considering the VM as healthy (between 2 and 10 both included).
» Path body string true The path for HTTP or HTTPS requests.
» Port body integer true The port number (between 1 and 65535, both included).
» Protocol body string true The protocol for the URL of the VM (HTTP | HTTPS | TCP | SSL | UDP).
» Timeout body integer true The maximum waiting time for a response before considering the VM as unhealthy, in seconds (between 2 and 60 both included).
» UnhealthyThreshold body integer true The number of consecutive failed pings before considering the VM as unhealthy (between 2 and 10 both included).
LoadBalancerName body string true The name of the load balancer.
LoadBalancerPort body integer false The port on which the load balancer is listening (between 1 and 65535, both included).
PolicyNames body [string] false The list of policy names (must contain all the policies to be enabled).
ServerCertificateId body string false The Outscale Resource Name (ORN) of the SSL certificate.

Body parameter

{
  "AccessLog": {
    "IsEnabled": true,
    "OsuBucketName": "string",
    "OsuBucketPrefix": "string",
    "PublicationInterval": 0
  },
  "DryRun": true,
  "HealthCheck": {
    "CheckInterval": 0,
    "HealthyThreshold": 0,
    "Path": "string",
    "Port": 0,
    "Protocol": "string",
    "Timeout": 0,
    "UnhealthyThreshold": 0
  },
  "LoadBalancerName": "string",
  "LoadBalancerPort": 0,
  "PolicyNames": [
    "string"
  ],
  "ServerCertificateId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateLoadBalancerResponse

Example responses

200 Response

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

LoadBalancerPolicy

CreateLoadBalancerPolicy

POST /CreateLoadBalancerPolicy

Creates a stickiness policy with sticky session lifetimes defined by the browser lifetime.
The created policy can be used with HTTP or HTTPS listeners only.
If this policy is implemented by a load balancer, this load balancer uses this cookie in all incoming requests to direct them to the specified back-end server virtual machine (VM). If this cookie is not present, the load balancer sends the request to any other server according to its load-balancing algorithm.

You can also create a stickiness policy with sticky session lifetimes following the lifetime of an application-generated cookie.
Unlike the other type of stickiness policy, the lifetime of the special Load Balancer Unit (LBU) cookie follows the lifetime of the application-generated cookie specified in the policy configuration. The load balancer inserts a new stickiness cookie only when the application response includes a new application cookie.
The session stops being sticky if the application cookie is removed or expires, until a new application cookie is issued.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancerPolicy \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancerPolicy', params={ 'LoadBalancerName': 'string', 'PolicyName': 'string', 'PolicyType': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateLoadBalancerPolicy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
CookieName body string false The name of the application cookie used for stickiness. This parameter is required if you create a stickiness policy based on an application-generated cookie.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer for which you want to create a policy.
PolicyName body string true The name of the policy. This name must be unique and consist of alphanumeric characters and dashes (-).
PolicyType body string true The type of stickiness policy you want to create: app or load_balancer.

Body parameter

{
  "CookieName": "string",
  "DryRun": true,
  "LoadBalancerName": "string",
  "PolicyName": "string",
  "PolicyType": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateLoadBalancerPolicyResponse

Example responses

200 Response

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteLoadBalancerPolicy

POST /DeleteLoadBalancerPolicy

Deletes a specified policy from a load balancer.
In order to be deleted, the policy must not be enabled for any listener.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancerPolicy \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancerPolicy', params={ 'LoadBalancerName': 'string', 'PolicyName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteLoadBalancerPolicy");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LoadBalancerName body string true The name of the load balancer for which you want to delete a policy.
PolicyName body string true The name of the policy you want to delete.

Body parameter

{
  "DryRun": true,
  "LoadBalancerName": "string",
  "PolicyName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteLoadBalancerPolicyResponse

Example responses

200 Response

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

Location

ReadLocations

POST /ReadLocations

Lists the locations, corresponding to datacenters, where you can set up a DirectLink.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the Throttling error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadLocations \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadLocations', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadLocations");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadLocationsResponse

Example responses

200 Response

{
  "Locations": [
    {
      "Code": "string",
      "Name": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

NatService

CreateNatService

POST /CreateNatService

Creates a network address translation (NAT) service in the specified public Subnet of a Net.
A NAT service enables virtual machines (VMs) placed in the private Subnet of this Net to connect to the Internet, without being accessible from the Internet.
When creating a NAT service, you specify the allocation ID of the External IP (EIP) you want to use as public IP for the NAT service. Once the NAT service is created, you need to create a route in the route table of the private Subnet, with 0.0.0.0/0 as destination and the ID of the NAT service as target. For more information, see LinkPublicIP and CreateRoute.
This action also enables you to create multiple NAT services in the same Net (one per public Subnet).

[NOTE]
You cannot modify the EIP associated with a NAT service after its creation. To do so, you need to delete the NAT service and create a new one with another EIP.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateNatService \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateNatService', params={ 'PublicIpId': 'string', 'SubnetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateNatService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
PublicIpId body string true The allocation ID of the EIP to associate with the NAT service.
SubnetId body string true The ID of the Subnet in which you want to create the NAT service.

Detailed descriptions

PublicIpId: The allocation ID of the EIP to associate with the NAT service.
If the EIP is already associated with another resource, you must first disassociate it.

Body parameter

{
  "DryRun": true,
  "PublicIpId": "string",
  "SubnetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNatServiceResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "NatService": {
    "NatServiceId": "string",
    "NetId": "string",
    "PublicIps": [
      {
        "PublicIp": "string",
        "PublicIpId": "string"
      }
    ],
    "State": "string",
    "SubnetId": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteNatService

POST /DeleteNatService

Deletes a specified network address translation (NAT) service.
This action disassociates the External IP address (EIP) from the NAT service, but does not release this EIP from your account. However, it does not delete any NAT service routes in your route tables.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteNatService \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteNatService', params={ 'NatServiceId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteNatService");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NatServiceId body string true The ID of the NAT service you want to delete.

Body parameter

{
  "DryRun": true,
  "NatServiceId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNatServiceResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadNatServices

POST /ReadNatServices

Lists one or more network address translation (NAT) services.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadNatServices \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadNatServices', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadNatServices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersNatService false One or more filters.
» NatServiceIds body [string] false The IDs of the NAT services.
» NetIds body [string] false The IDs of the Nets in which the NAT services are.
» States body [string] false The states of the NAT services (pending | available | deleting | deleted).
» SubnetIds body [string] false The IDs of the Subnets in which the NAT services are.
» TagKeys body [string] false The keys of the tags associated with the NAT services.
» TagValues body [string] false The values of the tags associated with the NAT services.
» Tags body [string] false The key/value combination of the tags associated with the NAT services, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "NatServiceIds": [
      "string"
    ],
    "NetIds": [
      "string"
    ],
    "States": [
      "string"
    ],
    "SubnetIds": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadNatServicesResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "NatServices": [
    {
      "NatServiceId": "string",
      "NetId": "string",
      "PublicIps": [
        {
          "PublicIp": "string",
          "PublicIpId": "string"
        }
      ],
      "State": "string",
      "SubnetId": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

Net

CreateNet

POST /CreateNet

Creates a Net with a specified IP range.
The IP range (network range) of your Net must be between a /28 netmask (16 IP addresses) and a /16 netmask (65 536 IP addresses).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateNet \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateNet', params={ 'IpRange': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateNet");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
IpRange body string true The IP range for the Net, in CIDR notation (for example, 10.0.0.0/16).
Tenancy body string false The tenancy options for the VMs (default if a VM created in a Net can be launched with any tenancy, dedicated if it can be launched with dedicated tenancy VMs running on single-tenant hardware).

Body parameter

{
  "DryRun": true,
  "IpRange": "string",
  "Tenancy": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNetResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
409 Conflict The HTTP 409 response (Conflict). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Net": {
    "DhcpOptionsSetId": "string",
    "IpRange": "string",
    "NetId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "Tenancy": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteNet

POST /DeleteNet

Deletes a specified Net.
Before deleting the Net, you need to delete or detach all the resources associated with the Net:

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteNet \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteNet', params={ 'NetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteNet");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string true The ID of the Net you want to delete.

Body parameter

{
  "DryRun": true,
  "NetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNetResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadNets

POST /ReadNets

Lists one or more Nets.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadNets \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadNets', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadNets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersNet false One or more filters.
» DhcpOptionsSetIds body [string] false The IDs of the DHCP options sets.
» IpRanges body [string] false The IP ranges for the Nets, in CIDR notation (for example, 10.0.0.0/16).
» NetIds body [string] false The IDs of the Nets.
» States body [string] false The states of the Nets (pending | available).
» TagKeys body [string] false The keys of the tags associated with the Nets.
» TagValues body [string] false The values of the tags associated with the Nets.
» Tags body [string] false The key/value combination of the tags associated with the Nets, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "DhcpOptionsSetIds": [
      "string"
    ],
    "IpRanges": [
      "string"
    ],
    "NetIds": [
      "string"
    ],
    "States": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadNetsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Nets": [
    {
      "DhcpOptionsSetId": "string",
      "IpRange": "string",
      "NetId": "string",
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "Tenancy": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateNet

POST /UpdateNet

Associates a DHCP options set with a specified Net.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateNet \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateNet', params={ 'DhcpOptionsSetId': 'string', 'NetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateNet");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DhcpOptionsSetId body string true The ID of the DHCP options set (or default if you want to associate the default one).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string true The ID of the Net.

Body parameter

{
  "DhcpOptionsSetId": "string",
  "DryRun": true,
  "NetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateNetResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Net": {
    "DhcpOptionsSetId": "string",
    "IpRange": "string",
    "NetId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "Tenancy": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

NetAccessPoint

CreateNetAccessPoint

POST /CreateNetAccessPoint

Creates a Net access point to access a 3DS OUTSCALE service from this Net without using the Internet and External IP addresses.
You specify the service using its prefix list name. For more information, see DescribePrefixLists
To control the routing of traffic between the Net and the specified service, you can specify one or more route tables. Virtual machines placed in Subnets associated with the specified route table thus use the Net access point to access the service. When you specify a route table, a route is automatically added to it with the destination set to the prefix list ID of the service, and the target set to the ID of the access point.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateNetAccessPoint \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateNetAccessPoint', params={ 'NetId': 'string', 'ServiceName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateNetAccessPoint");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string true The ID of the Net.
RouteTableIds body [string] false One or more IDs of route tables to use for the connection.
ServiceName body string true The prefix list name corresponding to the service (for example, com.outscale.eu-west-2.osu for OSU).

Body parameter

{
  "DryRun": true,
  "NetId": "string",
  "RouteTableIds": [
    "string"
  ],
  "ServiceName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNetAccessPointResponse

Example responses

200 Response

{
  "NetAccessPoint": {
    "NetAccessPointId": "string",
    "NetId": "string",
    "RouteTableIds": [
      "string"
    ],
    "ServiceName": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteNetAccessPoint

POST /DeleteNetAccessPoint

Deletes one or more Net access point.
This action also deletes the corresponding routes added to the route tables you specified for the Net access point.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteNetAccessPoint \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteNetAccessPoint', params={ 'NetAccessPointId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteNetAccessPoint");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetAccessPointId body string true The ID of the Net access point.

Body parameter

{
  "DryRun": true,
  "NetAccessPointId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNetAccessPointResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadNetAccessPointServices

POST /ReadNetAccessPointServices

Describes 3DS OUTSCALE services available to create Net access points.
For more information, see CreateNetAccessPoint.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadNetAccessPointServices \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadNetAccessPointServices', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadNetAccessPointServices");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersService false One or more filters.
» ServiceIds body [string] false The IDs of the services.
» ServiceNames body [string] false The names of the prefix lists, which identify the 3DS OUTSCALE services they are associated with.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "ServiceIds": [
      "string"
    ],
    "ServiceNames": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadNetAccessPointServicesResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Services": [
    {
      "IpRanges": [
        "string"
      ],
      "ServiceId": "string",
      "ServiceName": "string"
    }
  ]
}

ReadNetAccessPoints

POST /ReadNetAccessPoints

Describes one or more Net access points.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadNetAccessPoints \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadNetAccessPoints', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadNetAccessPoints");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersNetAccessPoint false One or more filters.
» NetAccessPointIds body [string] false The IDs of the Net access points.
» NetIds body [string] false The IDs of the Nets.
» ServiceNames body [string] false The names of the prefix lists corresponding to the services. For more information, see DescribePrefixLists
» States body [string] false The states of the Net access points (pending | available | deleting | deleted).
» TagKeys body [string] false The keys of the tags associated with the Net access points.
» TagValues body [string] false The values of the tags associated with the Net access points.
» Tags body [string] false The key/value combination of the tags associated with the Net access points, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "NetAccessPointIds": [
      "string"
    ],
    "NetIds": [
      "string"
    ],
    "ServiceNames": [
      "string"
    ],
    "States": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadNetAccessPointsResponse

Example responses

200 Response

{
  "NetAccessPoints": [
    {
      "NetAccessPointId": "string",
      "NetId": "string",
      "RouteTableIds": [
        "string"
      ],
      "ServiceName": "string",
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateNetAccessPoint

POST /UpdateNetAccessPoint

Modifies the attributes of a Net access point.
This action enables you to add or remove route tables associated with the specified Net access point.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateNetAccessPoint \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateNetAccessPoint', params={ 'NetAccessPointId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateNetAccessPoint");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
AddRouteTableIds body [string] false One or more IDs of route tables to associate with the specified Net access point.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetAccessPointId body string true The ID of the Net access point.
RemoveRouteTableIds body [string] false One or more IDs of route tables to disassociate from the specified Net access point.

Body parameter

{
  "AddRouteTableIds": [
    "string"
  ],
  "DryRun": true,
  "NetAccessPointId": "string",
  "RemoveRouteTableIds": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateNetAccessPointResponse

Example responses

200 Response

{
  "NetAccessPoint": {
    "NetAccessPointId": "string",
    "NetId": "string",
    "RouteTableIds": [
      "string"
    ],
    "ServiceName": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

NetPeering

AcceptNetPeering

POST /AcceptNetPeering

Accepts a Net peering connection request.
To accept this request, you must be the owner of the peer Net. If you do not accept the request within 7 days, the state of the Net peering connection becomes expired.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/AcceptNetPeering \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/AcceptNetPeering', params={ 'NetPeeringId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/AcceptNetPeering");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetPeeringId body string true The ID of the Net peering connection you want to accept.

Body parameter

{
  "DryRun": true,
  "NetPeeringId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). AcceptNetPeeringResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
409 Conflict The HTTP 409 response (Conflict). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "NetPeering": {
    "AccepterNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "NetPeeringId": "string",
    "SourceNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "State": {
      "Message": "string",
      "Name": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateNetPeering

POST /CreateNetPeering

Requests a Net peering connection between a Net you own and a peer Net that belongs to you or another account.
This action creates a Net peering connection that remains in the pending-acceptance state until it is accepted by the owner of the peer Net. If the owner of the peer Net does not accept the request within 7 days, the state of the Net peering connection becomes expired. For more information, see AcceptNetPeering.

[NOTE]
The two Nets must not have overlapping IP ranges. Otherwise, the Net peering connection is in the failed state.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateNetPeering \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateNetPeering', params={ 'AccepterNetId': 'string', 'SourceNetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateNetPeering");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
AccepterNetId body string true The ID of the Net you want to connect with.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
SourceNetId body string true The ID of the Net you send the peering request from.

Body parameter

{
  "AccepterNetId": "string",
  "DryRun": true,
  "SourceNetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNetPeeringResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "NetPeering": {
    "AccepterNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "NetPeeringId": "string",
    "SourceNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "State": {
      "Message": "string",
      "Name": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteNetPeering

POST /DeleteNetPeering

Deletes a Net peering connection.
If the Net peering connection is in the active state, it can be deleted either by the owner of the requester Net or the owner of the peer Net.
If it is in the pending-acceptance state, it can be deleted only by the owner of the requester Net.
If it is in the rejected, failed, or expired states, it cannot be deleted.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteNetPeering \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteNetPeering', params={ 'NetPeeringId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteNetPeering");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetPeeringId body string true The ID of the Net peering connection you want to delete.

Body parameter

{
  "DryRun": true,
  "NetPeeringId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNetPeeringResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
409 Conflict The HTTP 409 response (Conflict). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadNetPeerings

POST /ReadNetPeerings

Lists one or more peering connections between two Nets.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadNetPeerings \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadNetPeerings', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadNetPeerings");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersNetPeering false One or more filters.
» AccepterNetAccountIds body [string] false The account IDs of the owners of the peer Nets.
» AccepterNetIpRanges body [string] false The IP ranges of the peer Nets, in CIDR notation (for example, 10.0.0.0/24).
» AccepterNetNetIds body [string] false The IDs of the peer Nets.
» NetPeeringIds body [string] false The IDs of the Net peering connections.
» SourceNetAccountIds body [string] false The account IDs of the owners of the peer Nets.
» SourceNetIpRanges body [string] false The IP ranges of the peer Nets.
» SourceNetNetIds body [string] false The IDs of the peer Nets.
» StateMessages body [string] false Additional information about the states of the Net peering connections.
» StateNames body [string] false The states of the Net peering connections (pending-acceptance | active | rejected | failed | expired | deleted).
» TagKeys body [string] false The keys of the tags associated with the Net peering connections.
» TagValues body [string] false The values of the tags associated with the Net peering connections.
» Tags body [string] false The key/value combination of the tags associated with the Net peering connections, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "AccepterNetAccountIds": [
      "string"
    ],
    "AccepterNetIpRanges": [
      "string"
    ],
    "AccepterNetNetIds": [
      "string"
    ],
    "NetPeeringIds": [
      "string"
    ],
    "SourceNetAccountIds": [
      "string"
    ],
    "SourceNetIpRanges": [
      "string"
    ],
    "SourceNetNetIds": [
      "string"
    ],
    "StateMessages": [
      "string"
    ],
    "StateNames": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadNetPeeringsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "NetPeerings": [
    {
      "AccepterNet": {
        "AccountId": "string",
        "IpRange": "string",
        "NetId": "string"
      },
      "NetPeeringId": "string",
      "SourceNet": {
        "AccountId": "string",
        "IpRange": "string",
        "NetId": "string"
      },
      "State": {
        "Message": "string",
        "Name": "string"
      },
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

RejectNetPeering

POST /RejectNetPeering

Rejects a Net peering connection request.
The Net peering connection must be in the pending-acceptance state to be rejected. The rejected Net peering connection is then in the rejected state.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/RejectNetPeering \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/RejectNetPeering', params={ 'NetPeeringId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/RejectNetPeering");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetPeeringId body string true The ID of the Net peering connection you want to reject.

Body parameter

{
  "DryRun": true,
  "NetPeeringId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RejectNetPeeringResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
409 Conflict The HTTP 409 response (Conflict). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

Nic

CreateNic

POST /CreateNic

Creates a network interface card (NIC) in the specified Subnet.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateNic \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateNic', params={ 'SubnetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateNic");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
Description body string false A description for the NIC.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
PrivateIps body [PrivateIpLight] false The primary private IP address for the NIC.

» IsPrimary body boolean false If true, the IP address is the primary private IP address of the NIC.
» PrivateIp body string false The private IP address of the NIC.
SecurityGroupIds body [string] false One or more IDs of security groups for the NIC.
SubnetId body string true The ID of the Subnet in which you want to create the NIC.

Detailed descriptions

PrivateIps: The primary private IP address for the NIC.

This IP address must be within the IP address range of the Subnet that you specify with the SubnetId attribute.
If you do not specify this attribute, a random private IP address is selected within the IP address range of the Subnet.

Body parameter

{
  "Description": "string",
  "DryRun": true,
  "PrivateIps": [
    {
      "IsPrimary": true,
      "PrivateIp": "string"
    }
  ],
  "SecurityGroupIds": [
    "string"
  ],
  "SubnetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateNicResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Nic": {
    "AccountId": "string",
    "Description": "string",
    "IsSourceDestChecked": true,
    "LinkNic": {
      "DeleteOnVmDeletion": true,
      "DeviceNumber": 0,
      "LinkNicId": "string",
      "State": "string",
      "VmAccountId": "string",
      "VmId": "string"
    },
    "LinkPublicIp": {
      "LinkPublicIpId": "string",
      "PublicDnsName": "string",
      "PublicIp": "string",
      "PublicIpAccountId": "string",
      "PublicIpId": "string"
    },
    "MacAddress": "string",
    "NetId": "string",
    "NicId": "string",
    "PrivateDnsName": "string",
    "PrivateIps": [
      {
        "IsPrimary": true,
        "LinkPublicIp": {
          "LinkPublicIpId": "string",
          "PublicDnsName": "string",
          "PublicIp": "string",
          "PublicIpAccountId": "string",
          "PublicIpId": "string"
        },
        "PrivateDnsName": "string",
        "PrivateIp": "string"
      }
    ],
    "SecurityGroups": [
      {
        "SecurityGroupId": "string",
        "SecurityGroupName": "string"
      }
    ],
    "State": "string",
    "SubnetId": "string",
    "SubregionName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteNic

POST /DeleteNic

Deletes the specified network interface card (NIC).
The network interface must not be attached to any virtual machine (VM).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteNic \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteNic', params={ 'NicId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteNic");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NicId body string true The ID of the NIC you want to delete.

Body parameter

{
  "DryRun": true,
  "NicId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteNicResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkNic

POST /LinkNic

Attaches a network interface card (NIC) to a virtual machine (VM).
The interface and the VM must be in the same Subregion. The VM can be either running or stopped. The NIC must be in the available state.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkNic \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkNic', params={ 'DeviceNumber': '0', 'NicId': 'string', 'VmId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkNic");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DeviceNumber body integer true The index of the VM device for the NIC attachment (between 1 and 7, both included).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NicId body string true The ID of the NIC you want to attach.
VmId body string true The ID of the VM to which you want to attach the NIC.

Body parameter

{
  "DeviceNumber": 0,
  "DryRun": true,
  "NicId": "string",
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkNicResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "LinkNicId": "string",
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkPrivateIps

POST /LinkPrivateIps

Assigns one or more secondary private IP addresses to a specified network interface card (NIC). This action is only available in a Net. The private IP addresses to be assigned can be added individually using the PrivateIps parameter, or you can specify the number of private IP addresses to be automatically chosen within the Subnet range using the SecondaryPrivateIpCount parameter. You can specify only one of these two parameters. If none of these parameters are specified, a private IP address is chosen within the Subnet range.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkPrivateIps \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkPrivateIps', params={ 'NicId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkPrivateIps");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
AllowRelink body boolean false If true, allows an IP address that is already assigned to another NIC in the same Subnet to be assigned to the NIC you specified.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NicId body string true The ID of the NIC.
PrivateIps body [string] false The secondary private IP address or addresses you want to assign to the NIC within the IP address range of the Subnet.
SecondaryPrivateIpCount body integer false The number of secondary private IP addresses to assign to the NIC.

Body parameter

{
  "AllowRelink": true,
  "DryRun": true,
  "NicId": "string",
  "PrivateIps": [
    "string"
  ],
  "SecondaryPrivateIpCount": 0
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkPrivateIpsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadNics

POST /ReadNics

Lists one or more network interface cards (NICs).
A NIC is a virtual network interface that you can attach to a virtual machine (VM) in a Net.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadNics \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadNics', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadNics");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersNic false One or more filters.
» LinkNicSortNumbers body [integer] false The device numbers the NICs are attached to.
» LinkNicVmIds body [string] false The IDs of the VMs the NICs are attached to.
» NicIds body [string] false The IDs of the NICs.
» PrivateIpsPrivateIps body [string] false The private IP addresses of the NICs.
» SubnetIds body [string] false The IDs of the Subnets for the NICs.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "LinkNicSortNumbers": [
      0
    ],
    "LinkNicVmIds": [
      "string"
    ],
    "NicIds": [
      "string"
    ],
    "PrivateIpsPrivateIps": [
      "string"
    ],
    "SubnetIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadNicsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Nics": [
    {
      "AccountId": "string",
      "Description": "string",
      "IsSourceDestChecked": true,
      "LinkNic": {
        "DeleteOnVmDeletion": true,
        "DeviceNumber": 0,
        "LinkNicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      },
      "LinkPublicIp": {
        "LinkPublicIpId": "string",
        "PublicDnsName": "string",
        "PublicIp": "string",
        "PublicIpAccountId": "string",
        "PublicIpId": "string"
      },
      "MacAddress": "string",
      "NetId": "string",
      "NicId": "string",
      "PrivateDnsName": "string",
      "PrivateIps": [
        {
          "IsPrimary": true,
          "LinkPublicIp": {
            "LinkPublicIpId": "string",
            "PublicDnsName": "string",
            "PublicIp": "string",
            "PublicIpAccountId": "string",
            "PublicIpId": "string"
          },
          "PrivateDnsName": "string",
          "PrivateIp": "string"
        }
      ],
      "SecurityGroups": [
        {
          "SecurityGroupId": "string",
          "SecurityGroupName": "string"
        }
      ],
      "State": "string",
      "SubnetId": "string",
      "SubregionName": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UnlinkNic

POST /UnlinkNic

Detaches a network interface card (NIC) from a virtual machine (VM).
The primary NIC cannot be detached.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkNic \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkNic', params={ 'LinkNicId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkNic");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LinkNicId body string true The ID of the attachment operation.

Body parameter

{
  "DryRun": true,
  "LinkNicId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkNicResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

UnlinkPrivateIps

POST /UnlinkPrivateIps

Unassigns one or more secondary private IPs from a network interface card (NIC).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkPrivateIps \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkPrivateIps', params={ 'NicId': 'string', 'PrivateIps': [
  "string"
]}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkPrivateIps");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NicId body string true The ID of the NIC.
PrivateIps body [string] true One or more secondary private IP addresses you want to unassign from the NIC.

Body parameter

{
  "DryRun": true,
  "NicId": "string",
  "PrivateIps": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkPrivateIpsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateNic

POST /UpdateNic

Modifies the specified network interface card (NIC). You can specify only one attribute at a time.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateNic \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateNic', params={ 'NicId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateNic");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
Description body string false A new description for the NIC.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LinkNic body LinkNicToUpdate false Information about the NIC attachment. If you are modifying the DeleteOnVmDeletion attribute, you must specify the ID of the NIC attachment.
» DeleteOnVmDeletion body boolean false If true, the NIC is deleted when the VM is terminated.
» LinkNicId body string false The ID of the NIC attachment.
NicId body string true The ID of the NIC you want to modify.
SecurityGroupIds body [string] false One or more IDs of security groups for the NIC.

Detailed descriptions

SecurityGroupIds: One or more IDs of security groups for the NIC.
You must specify at least one group, even if you use the default security group in the Net.

Body parameter

{
  "Description": "string",
  "DryRun": true,
  "LinkNic": {
    "DeleteOnVmDeletion": true,
    "LinkNicId": "string"
  },
  "NicId": "string",
  "SecurityGroupIds": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateNicResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "Nic": {
    "AccountId": "string",
    "Description": "string",
    "IsSourceDestChecked": true,
    "LinkNic": {
      "DeleteOnVmDeletion": true,
      "DeviceNumber": 0,
      "LinkNicId": "string",
      "State": "string",
      "VmAccountId": "string",
      "VmId": "string"
    },
    "LinkPublicIp": {
      "LinkPublicIpId": "string",
      "PublicDnsName": "string",
      "PublicIp": "string",
      "PublicIpAccountId": "string",
      "PublicIpId": "string"
    },
    "MacAddress": "string",
    "NetId": "string",
    "NicId": "string",
    "PrivateDnsName": "string",
    "PrivateIps": [
      {
        "IsPrimary": true,
        "LinkPublicIp": {
          "LinkPublicIpId": "string",
          "PublicDnsName": "string",
          "PublicIp": "string",
          "PublicIpAccountId": "string",
          "PublicIpId": "string"
        },
        "PrivateDnsName": "string",
        "PrivateIp": "string"
      }
    ],
    "SecurityGroups": [
      {
        "SecurityGroupId": "string",
        "SecurityGroupName": "string"
      }
    ],
    "State": "string",
    "SubnetId": "string",
    "SubregionName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

ProductType

ReadProductTypes

POST /ReadProductTypes

Describes one or more product types.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadProductTypes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadProductTypes', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadProductTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersProductType false One or more filters.
» ProductTypeIds body [string] false The IDs of the product types.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "ProductTypeIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadProductTypesResponse

Example responses

200 Response

{
  "ProductTypes": [
    {
      "Description": "string",
      "ProductTypeId": "string",
      "Vendor": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

PublicIp

CreatePublicIp

POST /CreatePublicIp

Acquires an External IP address (EIP) for your account.
An EIP is a static IP address designed for dynamic Cloud computing. It can be used for virtual machines (VMs) in the public Cloud (standard) or in a Net, for a network interface card (NIC), or for a NAT service.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreatePublicIp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreatePublicIp', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreatePublicIp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreatePublicIpResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "PublicIp": {
    "LinkPublicIpId": "string",
    "NicAccountId": "string",
    "NicId": "string",
    "PrivateIp": "string",
    "PublicIp": "string",
    "PublicIpId": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VmId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeletePublicIp

POST /DeletePublicIp

Releases an External IP address (EIP).
You can release an EIP associated with your account. This address is released in the EIP pool and can be used by someone else. Before releasing an EIP, ensure you updated all your resources communicating with this address.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeletePublicIp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeletePublicIp', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeletePublicIp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
PublicIp body string false The EIP. In the public Cloud, this parameter is required.
PublicIpId body string false The ID representing the association of the EIP with the VM or the NIC. In a Net, this parameter is required.

Body parameter

{
  "DryRun": true,
  "PublicIp": "string",
  "PublicIpId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeletePublicIpResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkPublicIp

POST /LinkPublicIp

Associates an External IP address (EIP) with a virtual machine (VM) or a network interface card (NIC), in the public Cloud or in a Net. You can associate an EIP with only one VM or network interface at a time.
To associate an EIP in a Net, ensure that the Net has an Internet service attached. For more information, see the LinkInternetService method.
By default, the EIP is disassociated every time you stop and start the VM. For a persistent association, you can add the osc.fcu.eip.auto-attach tag to the VM with the EIP as value. For more information, see the CreateTags method.

[NOTE]
You can associate an EIP with a network address translation (NAT) service only when creating the NAT service. To modify its EIP, you need to delete the NAT service and re-create it with the new EIP. For more information, see the CreateNatService method.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkPublicIp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkPublicIp', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkPublicIp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
AllowRelink body boolean false - If true, allows the EIP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NicId body string false (Net only) The ID of the NIC. This parameter is required if the VM has more than one NIC attached. Otherwise, you need to specify the VmId parameter instead. You cannot specify both parameters at the same time.
PrivateIp body string false (Net only) The primary or secondary private IP address of the specified NIC. By default, the primary private IP address.
PublicIp body string false The EIP. In the public Cloud, this parameter is required.
PublicIpId body string false The allocation ID of the EIP. In a Net, this parameter is required.
VmId body string false The ID of the VM.

Detailed descriptions

AllowRelink: - If true, allows the EIP to be associated with the VM or NIC that you specify even if it is already associated with another VM or NIC.

(By default, true in the public Cloud, false in a Net.)

VmId: The ID of the VM.

Body parameter

{
  "AllowRelink": true,
  "DryRun": true,
  "NicId": "string",
  "PrivateIp": "string",
  "PublicIp": "string",
  "PublicIpId": "string",
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkPublicIpResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "LinkPublicIpId": "string",
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadPublicIps

POST /ReadPublicIps

Lists one or more External IP addresses (EIPs) allocated to your account.
By default, this action returns information about all your EIPs: available, associated with a virtual machine (VM) or network interface card (NIC), or used for a NAT service.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadPublicIps \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadPublicIps', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadPublicIps");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersPublicIp false One or more filters.
» LinkPublicIpIds body [string] false The IDs representing the associations of EIPs with VMs or NICs.
» NicAccountIds body [string] false The account IDs of the owners of the NICs.
» NicIds body [string] false The IDs of the NICs.
» Placements body [string] false Whether the EIPs are for use in the public Cloud or in a Net.
» PrivateIps body [string] false The private IP addresses associated with the EIPs.
» PublicIpIds body [string] false The IDs of the External IP addresses (EIPs).
» PublicIps body [string] false The External IP addresses (EIPs).
» TagKeys body [string] false The keys of the tags associated with the EIPs.
» TagValues body [string] false The values of the tags associated with the EIPs.
» Tags body [string] false The key/value combination of the tags associated with the EIPs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» VmIds body [string] false The IDs of the VMs.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "LinkPublicIpIds": [
      "string"
    ],
    "NicAccountIds": [
      "string"
    ],
    "NicIds": [
      "string"
    ],
    "Placements": [
      "string"
    ],
    "PrivateIps": [
      "string"
    ],
    "PublicIpIds": [
      "string"
    ],
    "PublicIps": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "VmIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadPublicIpsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "PublicIps": [
    {
      "LinkPublicIpId": "string",
      "NicAccountId": "string",
      "NicId": "string",
      "PrivateIp": "string",
      "PublicIp": "string",
      "PublicIpId": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "VmId": "string"
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

UnlinkPublicIp

POST /UnlinkPublicIp

Disassociates an External IP address (EIP) from the virtual machine (VM) or network interface card (NIC) it is associated with.

[NOTE]
To disassociate a Public IP from a NAT service, you need to delete the NAT service. For more information, see the DeleteNatGateway method.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkPublicIp \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkPublicIp', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkPublicIp");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LinkPublicIpId body string false (Required in a Net) The ID representing the association of the EIP with the VM or the NIC.
PublicIp body string false The External IP address. In the public Cloud, this parameter is required.

Body parameter

{
  "DryRun": true,
  "LinkPublicIpId": "string",
  "PublicIp": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkPublicIpResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

PublicIpRange

ReadPublicIpRanges

POST /ReadPublicIpRanges

Returns the public IPv4 addresses in CIDR notation for the Region specified in the endpoint of the request. For more information, see Regions, Endpoints and Availability Zones Reference.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadPublicIpRanges \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadPublicIpRanges', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadPublicIpRanges");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadPublicIpRangesResponse

Example responses

200 Response

{
  "PublicIps": [
    "string"
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

Quota

ReadQuotas

POST /ReadQuotas

Describes one or more of your quotas.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadQuotas \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadQuotas', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadQuotas");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersQuota false One or more filters.
» Collections body [string] false The group names of the quotas.
» QuotaNames body [string] false The names of the quotas.
» QuotaTypes body [string] false The resource IDs if these are resource-specific quotas, global if they are not.
» ShortDescriptions body [string] false The description of the quotas.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "Collections": [
      "string"
    ],
    "QuotaNames": [
      "string"
    ],
    "QuotaTypes": [
      "string"
    ],
    "ShortDescriptions": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadQuotasResponse

Example responses

200 Response

{
  "QuotaTypes": [
    {
      "QuotaType": "string",
      "Quotas": [
        {
          "AccountId": "string",
          "Description": "string",
          "MaxValue": 0,
          "Name": "string",
          "QuotaCollection": "string",
          "ShortDescription": "string",
          "UsedValue": 0
        }
      ]
    }
  ],
  "ResponseContext": {
    "RequestId": "string"
  }
}

Route

CreateRoute

POST /CreateRoute

Creates a route in a specified route table within a specified Net.
You must specify one of the following elements as the target:

The routing algorithm is based on the most specific match.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateRoute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateRoute', params={ 'DestinationIpRange': 'string', 'RouteTableId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateRoute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DestinationIpRange body string true The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
GatewayId body string false The ID of an Internet service or virtual gateway attached to your Net.
NatServiceId body string false The ID of a NAT service.
NetPeeringId body string false The ID of a Net peering connection.
NicId body string false The ID of a NIC.
RouteTableId body string true The ID of the route table for which you want to create a route.
VmId body string false The ID of a NAT VM in your Net (attached to exactly one NIC).

Body parameter

{
  "DestinationIpRange": "string",
  "DryRun": true,
  "GatewayId": "string",
  "NatServiceId": "string",
  "NetPeeringId": "string",
  "NicId": "string",
  "RouteTableId": "string",
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateRouteResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

DeleteRoute

POST /DeleteRoute

Deletes a route from a specified route table.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteRoute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteRoute', params={ 'DestinationIpRange': 'string', 'RouteTableId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteRoute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DestinationIpRange body string true The exact IP range for the route.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
RouteTableId body string true The ID of the route table from which you want to delete a route.

Body parameter

{
  "DestinationIpRange": "string",
  "DryRun": true,
  "RouteTableId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteRouteResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

UpdateRoute

POST /UpdateRoute

Replaces an existing route within a route table in a Net.
You must specify one of the following elements as the target:

The routing algorithm is based on the most specific match.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateRoute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateRoute', params={ 'DestinationIpRange': 'string', 'RouteTableId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateRoute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DestinationIpRange body string true The IP range used for the destination match, in CIDR notation (for example, 10.0.0.0/24).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
GatewayId body string false The ID of an Internet service or virtual gateway attached to your Net.
NatServiceId body string false The ID of a NAT service.
NetPeeringId body string false The ID of a Net peering connection.
NicId body string false The ID of a network interface card (NIC).
RouteTableId body string true The ID of the route table.
VmId body string false The ID of a NAT VM in your Net.

Body parameter

{
  "DestinationIpRange": "string",
  "DryRun": true,
  "GatewayId": "string",
  "NatServiceId": "string",
  "NetPeeringId": "string",
  "NicId": "string",
  "RouteTableId": "string",
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateRouteResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

RouteTable

CreateRouteTable

POST /CreateRouteTable

Creates a route table for a specified Net.
You can then add routes and associate this route table with a Subnet.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateRouteTable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateRouteTable', params={ 'NetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateRouteTable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string true The ID of the Net for which you want to create a route table.

Body parameter

{
  "DryRun": true,
  "NetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateRouteTableResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

DeleteRouteTable

POST /DeleteRouteTable

Deletes a specified route table.
Before deleting a route table, you must disassociate it from any Subnet. You cannot delete the main route table.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteRouteTable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteRouteTable', params={ 'RouteTableId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteRouteTable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
RouteTableId body string true The ID of the route table you want to delete.

Body parameter

{
  "DryRun": true,
  "RouteTableId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteRouteTableResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkRouteTable

POST /LinkRouteTable

Associates a Subnet with a route table.
The Subnet and the route table must be in the same Net. The traffic is routed according to the route table defined within this Net. You can associate a route table with several Subnets.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkRouteTable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkRouteTable', params={ 'RouteTableId': 'string', 'SubnetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkRouteTable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
RouteTableId body string true The ID of the route table.
SubnetId body string true The ID of the Subnet.

Body parameter

{
  "DryRun": true,
  "RouteTableId": "string",
  "SubnetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkRouteTableResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "LinkRouteTableId": "string",
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadRouteTables

POST /ReadRouteTables

Lists one or more of your route tables.
In your Net, each Subnet must be associated with a route table. If a Subnet is not explicitly associated with a route table, it is implicitly associated with the main route table of the Net.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadRouteTables \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadRouteTables', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadRouteTables");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersRouteTable false One or more filters.
» LinkRouteTableLinkRouteTableIds body [string] false The IDs of the associations between the route tables and the Subnets.
» LinkSubnetIds body [string] false The IDs of the Subnets involved in the associations.
» NetIds body [string] false The IDs of the Nets for the route tables.
» RouteCreationMethods body [string] false The methods used to create a route.
» RouteDestinationIpRanges body [string] false The IP ranges specified in routes in the tables.
» RouteGatewayIds body [string] false The IDs of the gateways specified in routes in the tables.
» RouteNatServiceIds body [string] false The IDs of the NAT services specified in routes in the tables.
» RouteNetPeeringIds body [string] false The IDs of the Net peering connections specified in routes in the tables.
» RouteStates body [string] false The states of routes in the route tables (active | blackhole). The blackhole state indicates that the target of the route is not available.
» RouteTableIds body [string] false The IDs of the route tables.
» RouteVmIds body [string] false The IDs of the VMs specified in routes in the tables.
» TagKeys body [string] false The keys of the tags associated with the route tables.
» TagValues body [string] false The values of the tags associated with the route tables.
» Tags body [string] false The key/value combination of the tags associated with the route tables, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "LinkRouteTableLinkRouteTableIds": [
      "string"
    ],
    "LinkSubnetIds": [
      "string"
    ],
    "NetIds": [
      "string"
    ],
    "RouteCreationMethods": [
      "string"
    ],
    "RouteDestinationIpRanges": [
      "string"
    ],
    "RouteGatewayIds": [
      "string"
    ],
    "RouteNatServiceIds": [
      "string"
    ],
    "RouteNetPeeringIds": [
      "string"
    ],
    "RouteStates": [
      "string"
    ],
    "RouteTableIds": [
      "string"
    ],
    "RouteVmIds": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadRouteTablesResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTables": [
    {
      "LinkRouteTables": [
        {
          "LinkRouteTableId": "string",
          "Main": true,
          "RouteTableId": "string",
          "SubnetId": "string"
        }
      ],
      "NetId": "string",
      "RoutePropagatingVirtualGateways": [
        {
          "VirtualGatewayId": "string"
        }
      ],
      "RouteTableId": "string",
      "Routes": [
        {
          "CreationMethod": "string",
          "DestinationIpRange": "string",
          "DestinationServiceId": "string",
          "GatewayId": "string",
          "NatServiceId": "string",
          "NetAccessPointId": "string",
          "NetPeeringId": "string",
          "NicId": "string",
          "State": "string",
          "VmAccountId": "string",
          "VmId": "string"
        }
      ],
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ]
}

UnlinkRouteTable

POST /UnlinkRouteTable

Disassociates a Subnet from a route table.
After disassociation, the Subnet can no longer use the routes in this route table, but uses the routes in the main route table of the Net instead.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkRouteTable \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkRouteTable', params={ 'LinkRouteTableId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkRouteTable");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
LinkRouteTableId body string true The ID of the association between the route table and the Subnet.

Body parameter

{
  "DryRun": true,
  "LinkRouteTableId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkRouteTableResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

SecurityGroup

CreateSecurityGroup

POST /CreateSecurityGroup

Creates a security group.
This action creates a security group either in the public Cloud or in a specified Net. By default, a default security group for use in the public Cloud and a default security group for use in a Net are created.
When launching a virtual machine (VM), if no security group is explicitly specified, the appropriate default security group is assigned to the VM. Default security groups include a default rule granting VMs network access to each other.
When creating a security group, you specify a name. Two security groups for use in the public Cloud or for use in a Net cannot have the same name.
You can have up to 500 security groups in the public Cloud. You can create up to 500 security groups per Net.
To add or remove rules, use the CreateSecurityGroupRule method.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateSecurityGroup \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateSecurityGroup', params={ 'Description': 'string', 'SecurityGroupName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateSecurityGroup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
Description body string true A description for the security group, with a maximum length of 255 ASCII printable characters.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string false The ID of the Net for the security group.
SecurityGroupName body string true (Public Cloud only) The name of the security group.

Detailed descriptions

SecurityGroupName: (Public Cloud only) The name of the security group.
This name must be unique and contain between 1 and 255 ASCII characters. Accented letters are not allowed.

Body parameter

{
  "Description": "string",
  "DryRun": true,
  "NetId": "string",
  "SecurityGroupName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSecurityGroupResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SecurityGroup": {
    "AccountId": "string",
    "Description": "string",
    "InboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "NetId": "string",
    "OutboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "SecurityGroupId": "string",
    "SecurityGroupName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

DeleteSecurityGroup

POST /DeleteSecurityGroup

Deletes a specified security group.
You can specify either the name of the security group or its ID.
This action fails if the specified group is associated with a virtual machine (VM) or referenced by another security group.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteSecurityGroup \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteSecurityGroup', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteSecurityGroup");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
SecurityGroupId body string false The ID of the security group you want to delete.
SecurityGroupName body string false (Public Cloud only) The name of the security group.

Body parameter

{
  "DryRun": true,
  "SecurityGroupId": "string",
  "SecurityGroupName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSecurityGroupResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadSecurityGroups

POST /ReadSecurityGroups

Lists one or more security groups.
You can specify either the name of the security groups or their IDs.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadSecurityGroups \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadSecurityGroups', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadSecurityGroups");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersSecurityGroup false One or more filters.
» AccountIds body [string] false The account IDs of the owners of the security groups.
» SecurityGroupIds body [string] false The IDs of the security groups.
» SecurityGroupNames body [string] false The names of the security groups.
» TagKeys body [string] false The keys of the tags associated with the security groups.
» TagValues body [string] false The values of the tags associated with the security groups.
» Tags body [string] false The key/value combination of the tags associated with the security groups, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "AccountIds": [
      "string"
    ],
    "SecurityGroupIds": [
      "string"
    ],
    "SecurityGroupNames": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadSecurityGroupsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SecurityGroups": [
    {
      "AccountId": "string",
      "Description": "string",
      "InboundRules": [
        {
          "FromPortRange": 0,
          "IpProtocol": "string",
          "IpRanges": [
            "string"
          ],
          "SecurityGroupsMembers": [
            {
              "AccountId": "string",
              "SecurityGroupId": "string",
              "SecurityGroupName": "string"
            }
          ],
          "ServiceIds": [
            "string"
          ],
          "ToPortRange": 0
        }
      ],
      "NetId": "string",
      "OutboundRules": [
        {
          "FromPortRange": 0,
          "IpProtocol": "string",
          "IpRanges": [
            "string"
          ],
          "SecurityGroupsMembers": [
            {
              "AccountId": "string",
              "SecurityGroupId": "string",
              "SecurityGroupName": "string"
            }
          ],
          "ServiceIds": [
            "string"
          ],
          "ToPortRange": 0
        }
      ],
      "SecurityGroupId": "string",
      "SecurityGroupName": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ]
}

SecurityGroupRule

CreateSecurityGroupRule

POST /CreateSecurityGroupRule

Configures the rules for a security group.
The modifications are effective at virtual machine (VM) level as quickly as possible, but a small delay may occur.

You can add one or more egress rules to a security group for use with a Net.
It allows VMs to send traffic to either one or more destination IP address ranges or destination security groups for the same Net.
We recommend using a set of IP permissions to authorize outbound access to a destination security group. We also recommended this method to create a rule with a specific IP protocol and a specific port range. In a set of IP permissions, we recommend to specify the the protocol.

You can also add one or more ingress rules to a security group.
In the public Cloud, this action allows one or more IP address ranges to access a security group for your account, or allows one or more security groups (source groups) to access a security group for your own 3DS OUTSCALE account or another one.
In a Net, this action allows one or more IP address ranges to access a security group for your Net, or allows one or more other security groups (source groups) to access a security group for your Net. All the security groups must be for the same Net.

[NOTE]
By default, traffic between two security groups is allowed through both public and private IP addresses. To restrict it to private IP addresses only, contact our Support team: support@outscale.com.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateSecurityGroupRule \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateSecurityGroupRule', params={ 'Flow': 'string', 'SecurityGroupId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateSecurityGroupRule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Flow body string true The direction of the flow: Inbound or Outbound. You can specify Outbound for Nets only.
FromPortRange body integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
IpProtocol body string false The IP protocol name (tcp, udp, icmp) or protocol number. By default, -1, which means all protocols.
IpRange body string false The IP range for the security group rule, in CIDR notation (for example, 10.0.0.0/16).
Rules body [SecurityGroupRule] false Information about the security group rule to create.
» FromPortRange body integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
» IpProtocol body string false The IP protocol name (tcp, udp, icmp) or protocol number. By default, -1, which means all protocols.
» IpRanges body [string] false One or more IP ranges for the security group rules, in CIDR notation (for example, 10.0.0.0/16).
» SecurityGroupsMembers body [SecurityGroupsMember] false Information about one or more members of a security group.
»» AccountId body string false The account ID of a user.
»» SecurityGroupId body string false The ID of the security group.
»» SecurityGroupName body string false (Public Cloud only) The name of the security group.
» ServiceIds body [string] false One or more service IDs to allow traffic from a Net to access the corresponding 3DS OUTSCALE services. For more information, see ReadNetAccessPointServices.
» ToPortRange body integer false The end of the port range for the TCP and UDP protocols, or an ICMP type number.
SecurityGroupAccountIdToLink body string false The account ID of the owner of the security group for which you want to create a rule.
SecurityGroupId body string true The ID of the security group for which you want to create a rule.
SecurityGroupNameToLink body string false The ID of the source security group. If you are in the Public Cloud, you can also specify the name of the source security group.
ToPortRange body integer false The end of the port range for the TCP and UDP protocols, or an ICMP type number.

Body parameter

{
  "DryRun": true,
  "Flow": "string",
  "FromPortRange": 0,
  "IpProtocol": "string",
  "IpRange": "string",
  "Rules": [
    {
      "FromPortRange": 0,
      "IpProtocol": "string",
      "IpRanges": [
        "string"
      ],
      "SecurityGroupsMembers": [
        {
          "AccountId": "string",
          "SecurityGroupId": "string",
          "SecurityGroupName": "string"
        }
      ],
      "ServiceIds": [
        "string"
      ],
      "ToPortRange": 0
    }
  ],
  "SecurityGroupAccountIdToLink": "string",
  "SecurityGroupId": "string",
  "SecurityGroupNameToLink": "string",
  "ToPortRange": 0
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSecurityGroupRuleResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SecurityGroup": {
    "AccountId": "string",
    "Description": "string",
    "InboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "NetId": "string",
    "OutboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "SecurityGroupId": "string",
    "SecurityGroupName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

DeleteSecurityGroupRule

POST /DeleteSecurityGroupRule

Deletes one or more inbound or outbound rules from a security group. For the rule to be deleted, the values specified in the deletion request must exactly match the value of the existing rule.
In case of TCP and UDP protocols, you have to indicate the destination port or range of ports. In case of ICMP protocol, you have to specify the ICMP type and code.
Rules (IP permissions) consist of the protocol, IP address range or source security group.
To remove outbound access to a destination security group, we recommend to use a set of IP permissions. We also recommend to specify the protocol in a set of IP permissions.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteSecurityGroupRule \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteSecurityGroupRule', params={ 'Flow': 'string', 'SecurityGroupId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteSecurityGroupRule");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Flow body string true The direction of the flow: Inbound or Outbound. You can specify Outbound for Nets only.
FromPortRange body integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
IpProtocol body string false The IP protocol name (tcp, udp, icmp) or protocol number. By default, -1, which means all protocols.
IpRange body string false The IP range for the security group rule, in CIDR notation (for example, 10.0.0.0/16).
Rules body [SecurityGroupRule] false One or more rules you want to delete from the security group.
» FromPortRange body integer false The beginning of the port range for the TCP and UDP protocols, or an ICMP type number.
» IpProtocol body string false The IP protocol name (tcp, udp, icmp) or protocol number. By default, -1, which means all protocols.
» IpRanges body [string] false One or more IP ranges for the security group rules, in CIDR notation (for example, 10.0.0.0/16).
» SecurityGroupsMembers body [SecurityGroupsMember] false Information about one or more members of a security group.
»» AccountId body string false The account ID of a user.
»» SecurityGroupId body string false The ID of the security group.
»» SecurityGroupName body string false (Public Cloud only) The name of the security group.
» ServiceIds body [string] false One or more service IDs to allow traffic from a Net to access the corresponding 3DS OUTSCALE services. For more information, see ReadNetAccessPointServices.
» ToPortRange body integer false The end of the port range for the TCP and UDP protocols, or an ICMP type number.
SecurityGroupAccountIdToUnlink body string false The account ID of the owner of the security group you want to delete a rule from.
SecurityGroupId body string true The ID of the security group you want to delete a rule from.
SecurityGroupNameToUnlink body string false The ID of the source security group. If you are in the Public Cloud, you can also specify the name of the source security group.
ToPortRange body integer false The end of the port range for the TCP and UDP protocols, or an ICMP type number.

Body parameter

{
  "DryRun": true,
  "Flow": "string",
  "FromPortRange": 0,
  "IpProtocol": "string",
  "IpRange": "string",
  "Rules": [
    {
      "FromPortRange": 0,
      "IpProtocol": "string",
      "IpRanges": [
        "string"
      ],
      "SecurityGroupsMembers": [
        {
          "AccountId": "string",
          "SecurityGroupId": "string",
          "SecurityGroupName": "string"
        }
      ],
      "ServiceIds": [
        "string"
      ],
      "ToPortRange": 0
    }
  ],
  "SecurityGroupAccountIdToUnlink": "string",
  "SecurityGroupId": "string",
  "SecurityGroupNameToUnlink": "string",
  "ToPortRange": 0
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSecurityGroupRuleResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SecurityGroup": {
    "AccountId": "string",
    "Description": "string",
    "InboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "NetId": "string",
    "OutboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "SecurityGroupId": "string",
    "SecurityGroupName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

Snapshot

CreateSnapshot

POST /CreateSnapshot

Creates a snapshot of a Block storage Unit (BSU) volume.
Snapshots are point-in-time images of a volume you can use to back up your data or to create replicas of this volume at the time the snapshot was created.

You can also use this method to copy a snapshot to your account, from an account in the same Region.
To do so, the owner of the source snapshot must share it with your account. For more information about how to share a snapshot with another account, see UpdateSnapshot.
The copy of the source snapshot is independent and belongs to you.

To copy a snapshot between accounts in different Regions, the owner of the source snapshot must export it to an Object Storage Unit (OSU) bucket using the CreateSnapshotExportTask method. You then need to import it from the OSU bucket to create a copy of this snapshot in your account.
You can import a snapshot using a pre-signed URL. You do not need any permission for this snapshot, or the bucket in which it is contained. The pre-signed URL is valid for seven days (you can regenerate a new one if needed).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateSnapshot \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateSnapshot', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateSnapshot");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
Description body string false A description for the snapshot.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
FileLocation body string false The pre-signed URL of the snapshot you want to import from the OSU bucket.
SnapshotSize body integer false The size of the snapshot created in your account, in gibibytes (GiB). This size must be exactly the same as the source snapshot one. The maximum allowed size is 14,901 GiB.
SourceRegionName body string false The name of the source Region, which must be the same as the Region of your account.
SourceSnapshotId body string false The ID of the snapshot you want to copy.
VolumeId body string false The ID of the volume you want to create a snapshot of.

Body parameter

{
  "Description": "string",
  "DryRun": true,
  "FileLocation": "string",
  "SnapshotSize": 0,
  "SourceRegionName": "string",
  "SourceSnapshotId": "string",
  "VolumeId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSnapshotResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Snapshot": {
    "AccountAlias": "string",
    "AccountId": "string",
    "Description": "string",
    "PermissionsToCreateVolume": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "Progress": 0,
    "SnapshotId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VolumeId": "string",
    "VolumeSize": 0
  }
}

CreateSnapshotExportTask

POST /CreateSnapshotExportTask

Exports a snapshot to an Object Storage Unit (OSU) bucket.
This action enables you to create a backup of your snapshot or to copy it to another account. You, or other users you send a pre-signed URL to, can then download this snapshot from the OSU bucket using the CreateSnapshot method.
This procedure enables you to copy a snapshot between accounts within the same Region or in different Regions. To copy a snapshot within the same Region, you can also use the CreateSnapshot direct method. The copy of the source snapshot is independent and belongs to you.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateSnapshotExportTask \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateSnapshotExportTask', params={ 'OsuExport': {
  "DiskImageFormat": "string",
  "OsuApiKey": {
    "ApiKeyId": "string",
    "SecretKey": "string"
  },
  "OsuBucket": "string",
  "OsuManifestUrl": "string",
  "OsuPrefix": "string"
}, '» DiskImageFormat': 'string', '» OsuBucket': 'string', 'SnapshotId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateSnapshotExportTask");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
OsuExport body OsuExport true Information about the OSU export.
» DiskImageFormat body string true The format of the export disk (qcow2 | vdi | vmdk).
» OsuApiKey body OsuApiKey false Information about the OSU API key.
»» ApiKeyId body string false The API key of the OSU account that enables you to access the bucket.
»» SecretKey body string false The secret key of the OSU account that enables you to access the bucket.
» OsuBucket body string true The name of the OSU bucket you want to export the object to.
» OsuManifestUrl body string false The URL of the manifest file.
» OsuPrefix body string false The prefix for the key of the OSU object. This key follows this format: prefix + object_export_task_id + '.' + disk_image_format.
SnapshotId body string true The ID of the snapshot to export.

Body parameter

{
  "DryRun": true,
  "OsuExport": {
    "DiskImageFormat": "string",
    "OsuApiKey": {
      "ApiKeyId": "string",
      "SecretKey": "string"
    },
    "OsuBucket": "string",
    "OsuManifestUrl": "string",
    "OsuPrefix": "string"
  },
  "SnapshotId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSnapshotExportTaskResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SnapshotExportTask": {
    "Comment": "string",
    "OsuExport": {
      "DiskImageFormat": "string",
      "OsuApiKey": {
        "ApiKeyId": "string",
        "SecretKey": "string"
      },
      "OsuBucket": "string",
      "OsuManifestUrl": "string",
      "OsuPrefix": "string"
    },
    "Progress": 0,
    "SnapshotId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "TaskId": "string"
  }
}

DeleteSnapshot

POST /DeleteSnapshot

Deletes a specified snapshot.
You cannot delete a snapshot that is currently used by an Outscale machine image (OMI). To do so, you first need to delete the corresponding OMI. For more information, see the DeleteImage method.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteSnapshot \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteSnapshot', params={ 'SnapshotId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteSnapshot");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
SnapshotId body string true The ID of the snapshot you want to delete.

Body parameter

{
  "DryRun": true,
  "SnapshotId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSnapshotResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadSnapshotExportTasks

POST /ReadSnapshotExportTasks

Lists one or more snapshot export tasks.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadSnapshotExportTasks \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadSnapshotExportTasks', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadSnapshotExportTasks");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersExportTask false One or more filters.
» TagKeys body [string] false The keys of the tags associated with the export tasks.
» TagValues body [string] false The values of the tags associated with the export tasks.
» Tags body [string] false The key/value combination of the tags associated with the export tasks, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» TaskIds body [string] false The IDs of the export tasks.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "TaskIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadSnapshotExportTasksResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SnapshotExportTasks": [
    {
      "Comment": "string",
      "OsuExport": {
        "DiskImageFormat": "string",
        "OsuApiKey": {
          "ApiKeyId": "string",
          "SecretKey": "string"
        },
        "OsuBucket": "string",
        "OsuManifestUrl": "string",
        "OsuPrefix": "string"
      },
      "Progress": 0,
      "SnapshotId": "string",
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "TaskId": "string"
    }
  ]
}

ReadSnapshots

POST /ReadSnapshots

Lists one or more snapshots that are available to you and the permissions to create volumes from them.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadSnapshots \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadSnapshots', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadSnapshots");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersSnapshot false One or more filters.
» AccountAliases body [string] false The account aliases of the owners of the snapshots.
» AccountIds body [string] false The account IDs of the owners of the snapshots.
» Descriptions body [string] false The descriptions of the snapshots.
» PermissionsToCreateVolumeAccountIds body [string] false The account IDs of one or more users who have permissions to create volumes.
» PermissionsToCreateVolumeGlobalPermission body boolean false If true, lists all public volumes. If false, lists all private volumes.
» Progresses body [integer] false The progresses of the snapshots, as a percentage.
» SnapshotIds body [string] false The IDs of the snapshots.
» States body [string] false The states of the snapshots (in-queue | pending | completed).
» TagKeys body [string] false The keys of the tags associated with the snapshots.
» TagValues body [string] false The values of the tags associated with the snapshots.
» Tags body [string] false The key/value combination of the tags associated with the snapshots, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» VolumeIds body [string] false The IDs of the volumes used to create the snapshots.
» VolumeSizes body [integer] false The sizes of the volumes used to create the snapshots, in gibibytes (GiB).

Body parameter

{
  "DryRun": true,
  "Filters": {
    "AccountAliases": [
      "string"
    ],
    "AccountIds": [
      "string"
    ],
    "Descriptions": [
      "string"
    ],
    "PermissionsToCreateVolumeAccountIds": [
      "string"
    ],
    "PermissionsToCreateVolumeGlobalPermission": true,
    "Progresses": [
      0
    ],
    "SnapshotIds": [
      "string"
    ],
    "States": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "VolumeIds": [
      "string"
    ],
    "VolumeSizes": [
      0
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadSnapshotsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Snapshots": [
    {
      "AccountAlias": "string",
      "AccountId": "string",
      "Description": "string",
      "PermissionsToCreateVolume": {
        "AccountIds": [
          "string"
        ],
        "GlobalPermission": true
      },
      "Progress": 0,
      "SnapshotId": "string",
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "VolumeId": "string",
      "VolumeSize": 0
    }
  ]
}

UpdateSnapshot

POST /UpdateSnapshot

Modifies the permissions for a specified snapshot.
You can add or remove permissions for specified account IDs or groups. You can share a snapshot with a user that is in the same Region. The user can create a copy of the snapshot you shared, obtaining all the rights for the copy of the snapshot.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateSnapshot \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateSnapshot', params={ 'PermissionsToCreateVolume': {
  "Additions": {
    "AccountIds": [
      "string"
    ],
    "GlobalPermission": true
  },
  "Removals": {
    "AccountIds": [
      "string"
    ],
    "GlobalPermission": true
  }
}, 'SnapshotId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateSnapshot");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
PermissionsToCreateVolume body PermissionsOnResourceCreation true Information about the permissions for the resource.
» Additions body PermissionsOnResource false Information about the users who have permissions for the resource.
»» AccountIds body [string] false The account ID of one or more users who have permissions for the resource.
»» GlobalPermission body boolean false If true, the resource is public. If false, the resource is private.
» Removals body PermissionsOnResource false Information about the users who have permissions for the resource.
SnapshotId body string true The ID of the snapshot.

Body parameter

{
  "DryRun": true,
  "PermissionsToCreateVolume": {
    "Additions": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "Removals": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    }
  },
  "SnapshotId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateSnapshotResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Snapshot": {
    "AccountAlias": "string",
    "AccountId": "string",
    "Description": "string",
    "PermissionsToCreateVolume": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "Progress": 0,
    "SnapshotId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VolumeId": "string",
    "VolumeSize": 0
  }
}

Subnet

CreateSubnet

POST /CreateSubnet

Creates a Subnet in an existing Net.
To create a Subnet in a Net, you have to provide the ID of the Net and the IP range for the Subnet (its network range). Once the Subnet is created, you cannot modify its IP range.
The IP range of the Subnet can be either the same as the Net one if you create only a single Subnet in this Net, or a subset of the Net one. In case of several Subnets in a Net, their IP ranges must not overlap. The smallest Subnet you can create uses a /30 netmask (four IP addresses).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateSubnet \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateSubnet', params={ 'IpRange': 'string', 'NetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateSubnet");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
IpRange body string true The IP range in the Subnet, in CIDR notation (for example, 10.0.0.0/16).
NetId body string true The ID of the Net for which you want to create a Subnet.
SubregionName body string false The name of the Subregion in which you want to create the Subnet.

Body parameter

{
  "DryRun": true,
  "IpRange": "string",
  "NetId": "string",
  "SubregionName": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateSubnetResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
409 Conflict The HTTP 409 response (Conflict). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Subnet": {
    "AvailableIpsCount": 0,
    "IpRange": "string",
    "MapPublicIpOnLaunch": true,
    "NetId": "string",
    "State": "string",
    "SubnetId": "string",
    "SubregionName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

DeleteSubnet

POST /DeleteSubnet

Deletes a specified Subnet.
You must terminate all the running virtual machines (VMs) in the Subnet before deleting it.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteSubnet \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteSubnet', params={ 'SubnetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteSubnet");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
SubnetId body string true The ID of the Subnet you want to delete.

Body parameter

{
  "DryRun": true,
  "SubnetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteSubnetResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadSubnets

POST /ReadSubnets

Lists one or more of your Subnets.
If you do not specify any Subnet ID, this action describes all of your Subnets.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadSubnets \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadSubnets', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadSubnets");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersSubnet false One or more filters.
» AvailableIpsCounts body [integer] false The number of available IPs.
» IpRanges body [string] false The IP ranges in the Subnets, in CIDR notation (for example, 10.0.0.0/16).
» NetIds body [string] false The IDs of the Nets in which the Subnets are.
» States body [string] false The states of the Subnets (pending | available).
» SubnetIds body [string] false The IDs of the Subnets.
» SubregionNames body [string] false The names of the Subregions in which the Subnets are located.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "AvailableIpsCounts": [
      0
    ],
    "IpRanges": [
      "string"
    ],
    "NetIds": [
      "string"
    ],
    "States": [
      "string"
    ],
    "SubnetIds": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadSubnetsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Subnets": [
    {
      "AvailableIpsCount": 0,
      "IpRange": "string",
      "MapPublicIpOnLaunch": true,
      "NetId": "string",
      "State": "string",
      "SubnetId": "string",
      "SubregionName": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ]
    }
  ]
}

UpdateSubnet

POST /UpdateSubnet

Modifies the specified attribute of a Subnet.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateSubnet \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateSubnet', params={ 'MapPublicIpOnLaunch': 'true', 'SubnetId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateSubnet");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
MapPublicIpOnLaunch body boolean true If true, a public IP address is assigned to the network interface cards (NICs) created in the specified Subnet.
SubnetId body string true The ID of the Subnet.

Body parameter

{
  "DryRun": true,
  "MapPublicIpOnLaunch": true,
  "SubnetId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateSubnetResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Subnet": {
    "AvailableIpsCount": 0,
    "IpRange": "string",
    "MapPublicIpOnLaunch": true,
    "NetId": "string",
    "State": "string",
    "SubnetId": "string",
    "SubregionName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

Subregion

ReadSubregions

POST /ReadSubregions

Lists one or more of the enabled Subregions that you can access in the current Region.

[NOTE]

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadSubregions \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadSubregions', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadSubregions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersSubregion false One or more filters.
» SubregionNames body [string] false The names of the Subregions.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "SubregionNames": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadSubregionsResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Subregions": [
    {
      "RegionName": "string",
      "State": "string",
      "SubregionName": "string"
    }
  ]
}

Tag

CreateTags

POST /CreateTags

Adds one or more tags to the specified resources.
If a tag with the same key already exists for the resource, the tag value is replaced.
You can tag the following resources using their IDs:

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateTags \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateTags', params={ 'ResourceIds': [
  "string"
], 'Tags': [
  {
    "Key": "string",
    "Value": "string"
  }
], '» Key': 'string', '» Value': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateTags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ResourceIds body [string] true One or more resource IDs.
Tags body [ResourceTag] true One or more tags to add to the specified resources.
» Key body string true The key of the tag, with a minimum of 1 character.
» Value body string true The value of the tag, between 0 and 255 characters.

Body parameter

{
  "DryRun": true,
  "ResourceIds": [
    "string"
  ],
  "Tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateTagsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteTags

POST /DeleteTags

Deletes one or more tags from the specified resources.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteTags \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteTags', params={ 'ResourceIds': [
  "string"
], 'Tags': [
  {
    "Key": "string",
    "Value": "string"
  }
], '» Key': 'string', '» Value': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteTags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ResourceIds body [string] true One or more resource IDs.
Tags body [ResourceTag] true One or more tags to delete (if you set a tag value, only the tags matching exactly this value are deleted).
» Key body string true The key of the tag, with a minimum of 1 character.
» Value body string true The value of the tag, between 0 and 255 characters.

Body parameter

{
  "DryRun": true,
  "ResourceIds": [
    "string"
  ],
  "Tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteTagsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadTags

POST /ReadTags

Lists one or more tags for your resources.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadTags \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadTags', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadTags");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersTag false One or more filters.
» Keys body [string] false The keys of the tags that are assigned to the resources. You can use this filter alongside the Values filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter.
» ResourceIds body [string] false The IDs of the resources with which the tags are associated.
» ResourceTypes body [string] false The resource type (instance | image | volume | snapshot | public-ip | security-group | route-table | network-interface | vpc | subnet | network-link | vpc-endpoint | nat-gateway | internet-gateway | customer-gateway | vpn-gateway | vpn-connection | dhcp-options | task).
» Values body [string] false The values of the tags that are assigned to the resources. You can use this filter alongside the TagKeys filter. In that case, you filter the resources corresponding to each tag, regardless of the other filter.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "Keys": [
      "string"
    ],
    "ResourceIds": [
      "string"
    ],
    "ResourceTypes": [
      "string"
    ],
    "Values": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadTagsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Tags": [
    {
      "Key": "string",
      "ResourceId": "string",
      "ResourceType": "string",
      "Value": "string"
    }
  ]
}

Task

DeleteExportTask

POST /DeleteExportTask

Deletes an export task.
If the export task is not running, the command fails and an error is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteExportTask \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteExportTask', params={ 'ExportTaskId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteExportTask");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ExportTaskId body string true The ID of the export task to delete.

Body parameter

{
  "DryRun": true,
  "ExportTaskId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteExportTaskResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

VirtualGateway

CreateVirtualGateway

POST /CreateVirtualGateway

Creates a virtual gateway.
A virtual gateway is the access point on the Net side of a VPN connection.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateVirtualGateway \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateVirtualGateway', params={ 'ConnectionType': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateVirtualGateway");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
ConnectionType body string true The type of VPN connection supported by the virtual gateway (only ipsec.1 is supported).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.

Body parameter

{
  "ConnectionType": "string",
  "DryRun": true
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVirtualGatewayResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "VirtualGateway": {
    "ConnectionType": "string",
    "NetToVirtualGatewayLinks": [
      {
        "NetId": "string",
        "State": "string"
      }
    ],
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VirtualGatewayId": "string"
  }
}

DeleteVirtualGateway

POST /DeleteVirtualGateway

Deletes a specified virtual gateway.
Before deleting a virtual gateway, we recommend to detach it from the Net and delete the VPN connection.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteVirtualGateway \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteVirtualGateway', params={ 'VirtualGatewayId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteVirtualGateway");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VirtualGatewayId body string true The ID of the virtual gateway you want to delete.

Body parameter

{
  "DryRun": true,
  "VirtualGatewayId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVirtualGatewayResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkVirtualGateway

POST /LinkVirtualGateway

Attaches a virtual gateway to a Net.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkVirtualGateway \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkVirtualGateway', params={ 'NetId': 'string', 'VirtualGatewayId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkVirtualGateway");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string true The ID of the Net to which you want to attach the virtual gateway.
VirtualGatewayId body string true The ID of the virtual gateway.

Body parameter

{
  "DryRun": true,
  "NetId": "string",
  "VirtualGatewayId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkVirtualGatewayResponse

Example responses

200 Response

{
  "NetToVirtualGatewayLink": {
    "NetId": "string",
    "State": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadVirtualGateways

POST /ReadVirtualGateways

Lists one or more virtual gateways.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVirtualGateways \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVirtualGateways', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVirtualGateways");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersVirtualGateway false One or more filters.
» ConnectionTypes body [string] false The types of the virtual gateways (only ipsec.1 is supported).
» LinkNetIds body [string] false The IDs of the Nets the virtual gateways are attached to.
» LinkStates body [string] false The current states of the attachments between the virtual gateways and the Nets (attaching | attached | detaching | detached).
» States body [string] false The states of the virtual gateways (pending | available | deleting | deleted).
» TagKeys body [string] false The keys of the tags associated with the virtual gateways.
» TagValues body [string] false The values of the tags associated with the virtual gateways.
» Tags body [string] false The key/value combination of the tags associated with the virtual gateways, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» VirtualGatewayIds body [string] false The IDs of the virtual gateways.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "ConnectionTypes": [
      "string"
    ],
    "LinkNetIds": [
      "string"
    ],
    "LinkStates": [
      "string"
    ],
    "States": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "VirtualGatewayIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVirtualGatewaysResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "VirtualGateways": [
    {
      "ConnectionType": "string",
      "NetToVirtualGatewayLinks": [
        {
          "NetId": "string",
          "State": "string"
        }
      ],
      "State": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "VirtualGatewayId": "string"
    }
  ]
}

UnlinkVirtualGateway

POST /UnlinkVirtualGateway

Detaches a virtual gateway from a Net.
You must wait until the virtual gateway is in the detached state before you can attach another Net to it or delete the Net it was previously attached to.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkVirtualGateway \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkVirtualGateway', params={ 'NetId': 'string', 'VirtualGatewayId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkVirtualGateway");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
NetId body string true The ID of the Net from which you want to detach the virtual gateway.
VirtualGatewayId body string true The ID of the virtual gateway.

Body parameter

{
  "DryRun": true,
  "NetId": "string",
  "VirtualGatewayId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkVirtualGatewayResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

UpdateRoutePropagation

POST /UpdateRoutePropagation

Configures the propagation of routes to a specified route table of a Net by a virtual gateway.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateRoutePropagation \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateRoutePropagation', params={ 'Enable': 'true', 'RouteTableId': 'string', 'VirtualGatewayId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateRoutePropagation");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Enable body boolean true If true, a virtual gateway can propagate routes to a specified route table of a Net. If false, the propagation is disabled.
RouteTableId body string true The ID of the route table.
VirtualGatewayId body string true The ID of the virtual gateway.

Body parameter

{
  "DryRun": true,
  "Enable": true,
  "RouteTableId": "string",
  "VirtualGatewayId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateRoutePropagationResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

Vm

CreateVms

POST /CreateVms

Creates new virtual machines (VMs), and then launches them.
This action enables you to create a specified number of VMs using an Outscale machine image (OMI) that you are allowed to use, and then to automatically launch them.
The VMs remain in the pending state until they are created and ready to be used. Once automatically launched, they are in the running state.
To check the state of your VMs, call the ReadVms method.
If not specified, the security group used by the service is the default one.
The metadata server enables you to get the public key provided when the VM is launched. Official OMIs contain a script to get this public key and put it inside the VM to provide secure access without password.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateVms \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateVms', params={ 'ImageId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateVms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
BlockDeviceMappings body [BlockDeviceMappingVmCreation] false One or more block device mappings.
» Bsu body BsuToCreate false Information about the BSU volume to create.
»» DeleteOnVmDeletion body boolean false Set to true by default, which means that the volume is deleted when the VM is terminated. If set to false, the volume is not deleted when the VM is terminated.
»» Iops body integer false The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000.
»» SnapshotId body string false The ID of the snapshot used to create the volume.
»» VolumeSize body integer false The size of the volume, in gibibytes (GiB).
»» VolumeType body string false The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created.
» DeviceName body string false The name of the device.
» NoDevice body string false Removes the device which is included in the block device mapping of the OMI.
» VirtualDeviceName body string false The name of the virtual device (ephemeralN).
BootOnCreation body boolean false By default or if true, the VM is started on creation. If false, the VM is stopped on creation.
BsuOptimized body boolean false If true, the VM is created with optimized BSU I/O.
ClientToken body string false A unique identifier which enables you to manage the idempotency.
DeletionProtection body boolean false If true, you cannot terminate the VM using Cockpit, the CLI or the API. If false, you can.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ImageId body string true The ID of the OMI used to create the VM. You can find the list of OMIs by calling the ReadImages method.
KeypairName body string false The name of the keypair.
MaxVmsCount body integer false The maximum number of VMs you want to create. If all the VMs cannot be created, the largest possible number of VMs above MinVmsCount is created.
MinVmsCount body integer false The minimum number of VMs you want to create. If this number of VMs cannot be created, no VMs are created.
Nics body [NicForVmCreation] false One or more NICs. If you specify this parameter, you must define one NIC as the primary network interface of the VM with 0 as its device number.
» DeleteOnVmDeletion body boolean false If true, the NIC is deleted when the VM is terminated. You can specify true only if you create a NIC when creating a VM.
» Description body string false The description of the NIC, if you are creating a NIC when creating the VM.
» DeviceNumber body integer false The index of the VM device for the NIC attachment (between 0 and 7, both included). This parameter is required if you create a NIC when creating the VM.
» NicId body string false The ID of the NIC, if you are attaching an existing NIC when creating a VM.
» PrivateIps body [PrivateIpLight] false One or more private IP addresses to assign to the NIC, if you create a NIC when creating a VM. Only one private IP address can be the primary private IP address.
»» IsPrimary body boolean false If true, the IP address is the primary private IP address of the NIC.
»» PrivateIp body string false The private IP address of the NIC.
» SecondaryPrivateIpCount body integer false The number of secondary private IP addresses, if you create a NIC when creating a VM. This parameter cannot be specified if you specified more than one private IP address in the PrivateIps parameter.
» SecurityGroupIds body [string] false One or more IDs of security groups for the NIC, if you acreate a NIC when creating a VM.
» SubnetId body string false The ID of the Subnet for the NIC, if you create a NIC when creating a VM.
Performance body string false The performance of the VM (standard | high | highest).
Placement body Placement false Information about the placement of the VM.
» SubregionName body string false The name of the Subregion.
» Tenancy body string false The tenancy of the VM (default | dedicated).
PrivateIps body [string] false One or more private IP addresses of the VM.
SecurityGroupIds body [string] false One or more IDs of security group for the VMs.
SecurityGroups body [string] false One or more names of security groups for the VMs.
SubnetId body string false The ID of the Subnet in which you want to create the VM.
UserData body string false Data or a script used to add a specific configuration to the VM when creating it. If you are not using a command line tool, this must be Base64-encoded.
VmInitiatedShutdownBehavior body string false The VM behavior when you stop it. By default or if set to stop, the VM stops. If set to restart, the VM stops then automatically restarts. If set to terminate, the VM stops and is terminated.
VmType body string false The type of VM (tinav2.c1r2 by default).

Detailed descriptions

»» VolumeSize: The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.

»» VolumeType: The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created.
For more information about volume types, see Volume Types and IOPS.

VmType: The type of VM (tinav2.c1r2 by default).
For more information, see Instance Types.

Enumerated Values

Parameter Value
Performance medium
Performance high
Performance highest

Body parameter

{
  "BlockDeviceMappings": [
    {
      "Bsu": {
        "DeleteOnVmDeletion": true,
        "Iops": 0,
        "SnapshotId": "string",
        "VolumeSize": 0,
        "VolumeType": "string"
      },
      "DeviceName": "string",
      "NoDevice": "string",
      "VirtualDeviceName": "string"
    }
  ],
  "BootOnCreation": true,
  "BsuOptimized": true,
  "ClientToken": "string",
  "DeletionProtection": true,
  "DryRun": true,
  "ImageId": "string",
  "KeypairName": "string",
  "MaxVmsCount": 0,
  "MinVmsCount": 0,
  "Nics": [
    {
      "DeleteOnVmDeletion": true,
      "Description": "string",
      "DeviceNumber": 0,
      "NicId": "string",
      "PrivateIps": [
        {
          "IsPrimary": true,
          "PrivateIp": "string"
        }
      ],
      "SecondaryPrivateIpCount": 0,
      "SecurityGroupIds": [
        "string"
      ],
      "SubnetId": "string"
    }
  ],
  "Performance": "high",
  "Placement": {
    "SubregionName": "string",
    "Tenancy": "string"
  },
  "PrivateIps": [
    "string"
  ],
  "SecurityGroupIds": [
    "string"
  ],
  "SecurityGroups": [
    "string"
  ],
  "SubnetId": "string",
  "UserData": "string",
  "VmInitiatedShutdownBehavior": "string",
  "VmType": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVmsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Vms": [
    {
      "Architecture": "string",
      "BlockDeviceMappings": [
        {
          "Bsu": {
            "DeleteOnVmDeletion": true,
            "LinkDate": "2019-11-08",
            "State": "string",
            "VolumeId": "string"
          },
          "DeviceName": "string"
        }
      ],
      "BsuOptimized": true,
      "ClientToken": "string",
      "DeletionProtection": true,
      "Hypervisor": "string",
      "ImageId": "string",
      "IsSourceDestChecked": true,
      "KeypairName": "string",
      "LaunchNumber": 0,
      "NetId": "string",
      "Nics": [
        {
          "AccountId": "string",
          "Description": "string",
          "IsSourceDestChecked": true,
          "LinkNic": {
            "DeleteOnVmDeletion": true,
            "DeviceNumber": 0,
            "LinkNicId": "string",
            "State": "string"
          },
          "LinkPublicIp": {
            "PublicDnsName": "string",
            "PublicIp": "string",
            "PublicIpAccountId": "string"
          },
          "MacAddress": "string",
          "NetId": "string",
          "NicId": "string",
          "PrivateDnsName": "string",
          "PrivateIps": [
            {
              "IsPrimary": true,
              "LinkPublicIp": {
                "PublicDnsName": "string",
                "PublicIp": "string",
                "PublicIpAccountId": "string"
              },
              "PrivateDnsName": "string",
              "PrivateIp": "string"
            }
          ],
          "SecurityGroups": [
            {
              "SecurityGroupId": "string",
              "SecurityGroupName": "string"
            }
          ],
          "State": "string",
          "SubnetId": "string"
        }
      ],
      "OsFamily": "string",
      "Performance": "string",
      "Placement": {
        "SubregionName": "string",
        "Tenancy": "string"
      },
      "PrivateDnsName": "string",
      "PrivateIp": "string",
      "ProductCodes": [
        "string"
      ],
      "PublicDnsName": "string",
      "PublicIp": "string",
      "ReservationId": "string",
      "RootDeviceName": "string",
      "RootDeviceType": "string",
      "SecurityGroups": [
        {
          "SecurityGroupId": "string",
          "SecurityGroupName": "string"
        }
      ],
      "State": "string",
      "StateReason": "string",
      "SubnetId": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "UserData": "string",
      "VmId": "string",
      "VmInitiatedShutdownBehavior": "string",
      "VmType": "string"
    }
  ]
}

DeleteVms

POST /DeleteVms

Performs a shut down for at least one virtual machine (VM).
This operation is idempotent, that means that all calls succeed if you terminate a VM more than once.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteVms \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteVms', params={ 'VmIds': [
  "string"
]}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteVms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VmIds body [string] true One or more IDs of VMs.

Body parameter

{
  "DryRun": true,
  "VmIds": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVmsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Vms": [
    {
      "CurrentState": "string",
      "PreviousState": "string",
      "VmId": "string"
    }
  ]
}

ReadAdminPassword

POST /ReadAdminPassword

Retrieves the administrator password for a Windows running virtual machine (VM).
The administrator password is encrypted using the keypair you specified when launching the VM.

[NOTE]
The administrator password is generated only on the first boot of the Windows VM. It is not returned after the first boot.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadAdminPassword \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadAdminPassword', params={ 'VmId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadAdminPassword");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VmId body string true The ID of the VM.

Body parameter

{
  "DryRun": true,
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadAdminPasswordResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "AdminPassword": "string",
  "ResponseContext": {
    "RequestId": "string"
  },
  "VmId": "string"
}

ReadConsoleOutput

POST /ReadConsoleOutput

Gets the console output for a virtual machine (VM). This console provides the most recent 64 KiB output.

[NOTE]
On Windows VMs, the console is handled only on the first boot. It returns no output after the first boot.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadConsoleOutput \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadConsoleOutput', params={ 'VmId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadConsoleOutput");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VmId body string true The ID of the VM.

Body parameter

{
  "DryRun": true,
  "VmId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadConsoleOutputResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ConsoleOutput": "string",
  "ResponseContext": {
    "RequestId": "string"
  },
  "VmId": "string"
}

ReadVmTypes

POST /ReadVmTypes

Lists one or more predefined VM types.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVmTypes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVmTypes', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVmTypes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersVmType false One or more filters.
» BsuOptimized body boolean false Indicates whether the VM is optimized for BSU I/O.
» MemorySizes body [integer] false The amounts of memory, in bytes.
» VcoreCounts body [integer] false The numbers of vCores.
» VmTypeNames body [string] false The names of the VM types. For more information, see Instance Types.
» VolumeCounts body [integer] false The maximum number of ephemeral storage disks.
» VolumeSizes body [integer] false The size of one ephemeral storage disk, in gibibytes (GiB).

Body parameter

{
  "DryRun": true,
  "Filters": {
    "BsuOptimized": true,
    "MemorySizes": [
      0
    ],
    "VcoreCounts": [
      0
    ],
    "VmTypeNames": [
      "string"
    ],
    "VolumeCounts": [
      0
    ],
    "VolumeSizes": [
      0
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVmTypesResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "VmTypes": [
    {
      "BsuOptimized": true,
      "MaxPrivateIps": 0,
      "MemorySize": 0,
      "VcoreCount": 0,
      "VmTypeName": "string",
      "VolumeCount": 0,
      "VolumeSize": 0
    }
  ]
}

ReadVms

POST /ReadVms

Lists one or more of your virtual machines (VMs).
If you provide one or more VM IDs, this action returns a description for all of these VMs. If you do not provide any VM ID, this action returns a description for all of the VMs that belong to you. If you provide an invalid VM ID, an error is returned. If you provide the ID of a VM that does not belong to you, the description of this VM is not included in the response. The refresh interval for data returned by this action is one hour, meaning that a terminated VM may appear in the response.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVms \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVms', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersVm false One or more filters.
» TagKeys body [string] false The keys of the tags associated with the VMs.
» TagValues body [string] false The values of the tags associated with the VMs.
» Tags body [string] false The key/value combination of the tags associated with the VMs, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» VmIds body [string] false One or more IDs of VMs.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "VmIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVmsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Vms": [
    {
      "Architecture": "string",
      "BlockDeviceMappings": [
        {
          "Bsu": {
            "DeleteOnVmDeletion": true,
            "LinkDate": "2019-11-08",
            "State": "string",
            "VolumeId": "string"
          },
          "DeviceName": "string"
        }
      ],
      "BsuOptimized": true,
      "ClientToken": "string",
      "DeletionProtection": true,
      "Hypervisor": "string",
      "ImageId": "string",
      "IsSourceDestChecked": true,
      "KeypairName": "string",
      "LaunchNumber": 0,
      "NetId": "string",
      "Nics": [
        {
          "AccountId": "string",
          "Description": "string",
          "IsSourceDestChecked": true,
          "LinkNic": {
            "DeleteOnVmDeletion": true,
            "DeviceNumber": 0,
            "LinkNicId": "string",
            "State": "string"
          },
          "LinkPublicIp": {
            "PublicDnsName": "string",
            "PublicIp": "string",
            "PublicIpAccountId": "string"
          },
          "MacAddress": "string",
          "NetId": "string",
          "NicId": "string",
          "PrivateDnsName": "string",
          "PrivateIps": [
            {
              "IsPrimary": true,
              "LinkPublicIp": {
                "PublicDnsName": "string",
                "PublicIp": "string",
                "PublicIpAccountId": "string"
              },
              "PrivateDnsName": "string",
              "PrivateIp": "string"
            }
          ],
          "SecurityGroups": [
            {
              "SecurityGroupId": "string",
              "SecurityGroupName": "string"
            }
          ],
          "State": "string",
          "SubnetId": "string"
        }
      ],
      "OsFamily": "string",
      "Performance": "string",
      "Placement": {
        "SubregionName": "string",
        "Tenancy": "string"
      },
      "PrivateDnsName": "string",
      "PrivateIp": "string",
      "ProductCodes": [
        "string"
      ],
      "PublicDnsName": "string",
      "PublicIp": "string",
      "ReservationId": "string",
      "RootDeviceName": "string",
      "RootDeviceType": "string",
      "SecurityGroups": [
        {
          "SecurityGroupId": "string",
          "SecurityGroupName": "string"
        }
      ],
      "State": "string",
      "StateReason": "string",
      "SubnetId": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "UserData": "string",
      "VmId": "string",
      "VmInitiatedShutdownBehavior": "string",
      "VmType": "string"
    }
  ]
}

ReadVmsState

POST /ReadVmsState

Lists the status of one or more virtual machines (VMs).

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVmsState \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVmsState', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVmsState");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
AllVms body boolean false If true, includes the status of all VMs. By default or if set to false, only includes the status of running VMs.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersVmsState false One or more filters.
» SubregionNames body [string] false The names of the Subregions of the VMs.
» VmIds body [string] false One or more IDs of VMs.
» VmStates body [string] false The states of the VMs (pending | running | shutting-down | terminated | stopping | stopped).

Body parameter

{
  "AllVms": true,
  "DryRun": true,
  "Filters": {
    "SubregionNames": [
      "string"
    ],
    "VmIds": [
      "string"
    ],
    "VmStates": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVmsStateResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "VmStates": [
    {
      "MaintenanceEvents": [
        {
          "Code": "string",
          "Description": "string",
          "NotAfter": "2019-11-08",
          "NotBefore": "2019-11-08"
        }
      ],
      "SubregionName": "string",
      "VmId": "string",
      "VmState": "string"
    }
  ]
}

RebootVms

POST /RebootVms

Reboots one or more virtual machines (VMs).
This operation sends a reboot request to one or more specified VMs. This is an asynchronous action that queues this reboot request. This action only reboots VMs that are valid and that belong to you.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/RebootVms \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/RebootVms', params={ 'VmIds': [
  "string"
]}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/RebootVms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VmIds body [string] true One or more IDs of the VMs you want to reboot.

Body parameter

{
  "DryRun": true,
  "VmIds": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). RebootVmsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

StartVms

POST /StartVms

Start one or more virtual machines (VMs).
You can start only VMs that are valid and that belong to you.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/StartVms \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/StartVms', params={ 'VmIds': [
  "string"
]}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/StartVms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VmIds body [string] true One or more IDs of VMs.

Body parameter

{
  "DryRun": true,
  "VmIds": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). StartVmsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Vms": [
    {
      "CurrentState": "string",
      "PreviousState": "string",
      "VmId": "string"
    }
  ]
}

StopVms

POST /StopVms

Stops one or more running virtual machines (VMs).
You can stop only VMs that are valid and that belong to you. Data stored in the VM RAM is lost.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/StopVms \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/StopVms', params={ 'VmIds': [
  "string"
]}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/StopVms");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ForceStop body boolean false Forces the VM to stop.
VmIds body [string] true One or more IDs of VMs.

Body parameter

{
  "DryRun": true,
  "ForceStop": true,
  "VmIds": [
    "string"
  ]
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). StopVmsResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Vms": [
    {
      "CurrentState": "string",
      "PreviousState": "string",
      "VmId": "string"
    }
  ]
}

UpdateVm

POST /UpdateVm

Modifies a specific attribute of a virtual machine (VM).
You can modify only one attribute at a time. You can modify the IsSourceDestChecked attribute only if the VM is in a Net.
You must stop the VM before modifying the following attributes:

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UpdateVm \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UpdateVm', params={ 'VmId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UpdateVm");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
BlockDeviceMappings body [BlockDeviceMappingVmUpdate] false One or more block device mappings of the VM. This parameter modifies the DeleteOnDeletion attribute for volumes attached to the VM.
» Bsu body BsuToUpdateVm false Information about the BSU volume.
»» DeleteOnVmDeletion body boolean false If true, the volume is deleted when the VM is terminated.
»» VolumeId body string false The ID of the volume.
» DeviceName body string false The name of the device.
» NoDevice body string false Removes the device which is included in the block device mapping of the OMI.
» VirtualDeviceName body string false The name of the virtual device (ephemeralN).
BsuOptimized body boolean false If true, the VM is optimized for BSU I/O.
DeletionProtection body boolean false If true, you cannot terminate the VM using Cockpit, the CLI or the API. If false, you can.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
IsSourceDestChecked body boolean false (Net only) If true, the source/destination check is enabled. If false, it is disabled. This value must be false for a NAT VM to perform network address translation (NAT) in a Net.
KeypairName body string false The name of the keypair.
Performance body string false The performance of the VM (standard | high | highest).
SecurityGroupIds body [string] false One or more IDs of security groups for the VM.
UserData body string false The Base64-encoded MIME user data.
VmId body string true The ID of the VM.
VmInitiatedShutdownBehavior body string false The VM behavior when you stop it. By default or if set to stop, the VM stops. If set to restart, the VM stops then automatically restarts. If set to terminate, the VM stops and is terminated.
VmType body string false The type of VM. For more information, see Instance Types.

Detailed descriptions

KeypairName: The name of the keypair.
To complete the replacement, manually replace the old public key with the new public key in the ~/.ssh/authorized_keys file located in the VM. Restart the VM to apply the change.

Enumerated Values

Parameter Value
Performance medium
Performance high
Performance highest

Body parameter

{
  "BlockDeviceMappings": [
    {
      "Bsu": {
        "DeleteOnVmDeletion": true,
        "VolumeId": "string"
      },
      "DeviceName": "string",
      "NoDevice": "string",
      "VirtualDeviceName": "string"
    }
  ],
  "BsuOptimized": true,
  "DeletionProtection": true,
  "DryRun": true,
  "IsSourceDestChecked": true,
  "KeypairName": "string",
  "Performance": "medium",
  "SecurityGroupIds": [
    "string"
  ],
  "UserData": "string",
  "VmId": "string",
  "VmInitiatedShutdownBehavior": "string",
  "VmType": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UpdateVmResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Vm": {
    "Architecture": "string",
    "BlockDeviceMappings": [
      {
        "Bsu": {
          "DeleteOnVmDeletion": true,
          "LinkDate": "2019-11-08",
          "State": "string",
          "VolumeId": "string"
        },
        "DeviceName": "string"
      }
    ],
    "BsuOptimized": true,
    "ClientToken": "string",
    "DeletionProtection": true,
    "Hypervisor": "string",
    "ImageId": "string",
    "IsSourceDestChecked": true,
    "KeypairName": "string",
    "LaunchNumber": 0,
    "NetId": "string",
    "Nics": [
      {
        "AccountId": "string",
        "Description": "string",
        "IsSourceDestChecked": true,
        "LinkNic": {
          "DeleteOnVmDeletion": true,
          "DeviceNumber": 0,
          "LinkNicId": "string",
          "State": "string"
        },
        "LinkPublicIp": {
          "PublicDnsName": "string",
          "PublicIp": "string",
          "PublicIpAccountId": "string"
        },
        "MacAddress": "string",
        "NetId": "string",
        "NicId": "string",
        "PrivateDnsName": "string",
        "PrivateIps": [
          {
            "IsPrimary": true,
            "LinkPublicIp": {
              "PublicDnsName": "string",
              "PublicIp": "string",
              "PublicIpAccountId": "string"
            },
            "PrivateDnsName": "string",
            "PrivateIp": "string"
          }
        ],
        "SecurityGroups": [
          {
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "State": "string",
        "SubnetId": "string"
      }
    ],
    "OsFamily": "string",
    "Performance": "string",
    "Placement": {
      "SubregionName": "string",
      "Tenancy": "string"
    },
    "PrivateDnsName": "string",
    "PrivateIp": "string",
    "ProductCodes": [
      "string"
    ],
    "PublicDnsName": "string",
    "PublicIp": "string",
    "ReservationId": "string",
    "RootDeviceName": "string",
    "RootDeviceType": "string",
    "SecurityGroups": [
      {
        "SecurityGroupId": "string",
        "SecurityGroupName": "string"
      }
    ],
    "State": "string",
    "StateReason": "string",
    "SubnetId": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "UserData": "string",
    "VmId": "string",
    "VmInitiatedShutdownBehavior": "string",
    "VmType": "string"
  }
}

Volume

CreateVolume

POST /CreateVolume

Creates a Block Storage Unit (BSU) volume in a specified Region.
BSU volumes can be attached to a virtual machine (VM) in the same Subregion. You can create a new empty volume or restore a volume from an existing snapshot.
You can create the following volume types: Enterprise (io1) for provisioned IOPS SSD volumes, Performance (gp2) for general purpose SSD volumes, or Magnetic (standard) volumes.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateVolume \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateVolume', params={ 'SubregionName': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateVolume");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Iops body integer false The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000.
Size body integer false The size of the volume, in gibibytes (GiB). The maximum allowed size for a volume is 14,901 GiB.
SnapshotId body string false The ID of the snapshot from which you want to create the volume.
SubregionName body string true The Subregion in which you want to create the volume.
VolumeType body string false The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created.

Detailed descriptions

VolumeType: The type of volume you want to create (io1 | gp2 | standard). If not specified, a standard volume is created.
For more information about volume types, see Volume Types and IOPS.

Body parameter

{
  "DryRun": true,
  "Iops": 0,
  "Size": 0,
  "SnapshotId": "string",
  "SubregionName": "string",
  "VolumeType": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVolumeResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Volume": {
    "Iops": 0,
    "LinkedVolumes": [
      {
        "DeleteOnVmDeletion": true,
        "DeviceName": "string",
        "State": "string",
        "VmId": "string",
        "VolumeId": "string"
      }
    ],
    "Size": 0,
    "SnapshotId": "string",
    "State": "string",
    "SubregionName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VolumeId": "string",
    "VolumeType": "string"
  }
}

DeleteVolume

POST /DeleteVolume

Deletes a specified Block Storage Unit (BSU) volume.
You can delete available volumes only, that is, volumes that are not attached to a virtual machine (VM).

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteVolume \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteVolume', params={ 'VolumeId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteVolume");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VolumeId body string true The ID of the volume you want to delete.

Body parameter

{
  "DryRun": true,
  "VolumeId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVolumeResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

LinkVolume

POST /LinkVolume

Attaches a Block Storage Unit (BSU) volume to a virtual machine (VM).
The volume and the VM must be in the same Subregion. The VM can be running or stopped. The volume is attached to the specified VM device.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/LinkVolume \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/LinkVolume', params={ 'DeviceName': 'string', 'VmId': 'string', 'VolumeId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/LinkVolume");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DeviceName body string true The name of the device.
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VmId body string true The ID of the VM you want to attach the volume to.
VolumeId body string true The ID of the volume you want to attach.

Body parameter

{
  "DeviceName": "string",
  "DryRun": true,
  "VmId": "string",
  "VolumeId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). LinkVolumeResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadVolumes

POST /ReadVolumes

Lists one or more specified Block Storage Unit (BSU) volumes.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVolumes \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVolumes', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVolumes");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersVolume false One or more filters.
» CreationDates body [string] false The dates and times at which the volumes were created.
» LinkVolumeDeleteOnVmDeletion body boolean false Indicates whether the volumes are deleted when terminating the VMs.
» LinkVolumeDeviceNames body [string] false The VM device names.
» LinkVolumeLinkDates body [string] false The dates and times at which the volumes were created.
» LinkVolumeLinkStates body [string] false The attachment states of the volumes (attaching | detaching | attached | detached).
» LinkVolumeVmIds body [string] false One or more IDs of VMs.
» SnapshotIds body [string] false The snapshots from which the volumes were created.
» SubregionNames body [string] false The names of the Subregions in which the volumes were created.
» TagKeys body [string] false The keys of the tags associated with the volumes.
» TagValues body [string] false The values of the tags associated with the volumes.
» Tags body [string] false The key/value combination of the tags associated with the volumes, in the following format: "Filters":{"Tags":["TAGKEY=TAGVALUE"]}.
» VolumeIds body [string] false The IDs of the volumes.
» VolumeSizes body [integer] false The sizes of the volumes, in gibibytes (GiB).
» VolumeStates body [string] false The states of the volumes (creating | available | in-use | deleting | error).
» VolumeTypes body [string] false The types of the volumes (standard | gp2 | io1).

Body parameter

{
  "DryRun": true,
  "Filters": {
    "CreationDates": [
      "2019-11-08"
    ],
    "LinkVolumeDeleteOnVmDeletion": true,
    "LinkVolumeDeviceNames": [
      "string"
    ],
    "LinkVolumeLinkDates": [
      "2019-11-08"
    ],
    "LinkVolumeLinkStates": [
      "string"
    ],
    "LinkVolumeVmIds": [
      "string"
    ],
    "SnapshotIds": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "TagKeys": [
      "string"
    ],
    "TagValues": [
      "string"
    ],
    "Tags": [
      "string"
    ],
    "VolumeIds": [
      "string"
    ],
    "VolumeSizes": [
      0
    ],
    "VolumeStates": [
      "string"
    ],
    "VolumeTypes": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVolumesResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "Volumes": [
    {
      "Iops": 0,
      "LinkedVolumes": [
        {
          "DeleteOnVmDeletion": true,
          "DeviceName": "string",
          "State": "string",
          "VmId": "string",
          "VolumeId": "string"
        }
      ],
      "Size": 0,
      "SnapshotId": "string",
      "State": "string",
      "SubregionName": "string",
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "VolumeId": "string",
      "VolumeType": "string"
    }
  ]
}

UnlinkVolume

POST /UnlinkVolume

Detaches a Block Storage Unit (BSU) volume from a virtual machine (VM).
To detach the root device of a VM, this VM must be stopped.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/UnlinkVolume \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/UnlinkVolume', params={ 'VolumeId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/UnlinkVolume");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
ForceUnlink body boolean false Forces the detachment of the volume in case of previous failure. Important: This action may damage your data or file systems.
VolumeId body string true The ID of the volume you want to detach.

Body parameter

{
  "DryRun": true,
  "ForceUnlink": true,
  "VolumeId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). UnlinkVolumeResponse
400 Bad Request The HTTP 400 response (Bad Request). ErrorResponse
401 Unauthorized The HTTP 401 response (Unauthorized). ErrorResponse
500 Internal Server Error The HTTP 500 response (Internal Server Error). ErrorResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

VpnConnection

CreateVpnConnection

POST /CreateVpnConnection

Creates a VPN connection between a specified virtual gateway and a specified client gateway.
You can create only one VPN connection between a virtual gateway and a client gateway.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateVpnConnection \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateVpnConnection', params={ 'ClientGatewayId': 'string', 'ConnectionType': 'string', 'VirtualGatewayId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateVpnConnection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
ClientGatewayId body string true The ID of the client gateway.
ConnectionType body string true The type of VPN connection (only ipsec.1 is supported).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
StaticRoutesOnly body boolean false If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
VirtualGatewayId body string true The ID of the virtual gateway.

Body parameter

{
  "ClientGatewayId": "string",
  "ConnectionType": "string",
  "DryRun": true,
  "StaticRoutesOnly": true,
  "VirtualGatewayId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpnConnectionResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "VpnConnection": {
    "ClientGatewayConfiguration": "string",
    "ClientGatewayId": "string",
    "ConnectionType": "string",
    "Routes": [
      {
        "DestinationIpRange": "string",
        "RouteType": "string",
        "State": "string"
      }
    ],
    "State": "string",
    "StaticRoutesOnly": true,
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VirtualGatewayId": "string",
    "VpnConnectionId": "string"
  }
}

CreateVpnConnectionRoute

POST /CreateVpnConnectionRoute

Creates a static route to a VPN connection.
This enables you to select the network flows sent by the virtual gateway to the target VPN connection.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/CreateVpnConnectionRoute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/CreateVpnConnectionRoute', params={ 'DestinationIpRange': 'string', 'VpnConnectionId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/CreateVpnConnectionRoute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DestinationIpRange body string true The network prefix of the route, in CIDR notation (for example, 10.12.0.0/16).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VpnConnectionId body string true The ID of the target VPN connection of the static route.

Body parameter

{
  "DestinationIpRange": "string",
  "DryRun": true,
  "VpnConnectionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). CreateVpnConnectionRouteResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteVpnConnection

POST /DeleteVpnConnection

Deletes a specified VPN connection.
If you want to delete a Net and all its dependencies, we recommend to detach the virtual gateway from the Net and delete the Net before deleting the VPN connection. This enables you to delete the Net without waiting for the VPN connection to be deleted.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteVpnConnection \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteVpnConnection', params={ 'VpnConnectionId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteVpnConnection");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VpnConnectionId body string true The ID of the VPN connection you want to delete.

Body parameter

{
  "DryRun": true,
  "VpnConnectionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpnConnectionResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

DeleteVpnConnectionRoute

POST /DeleteVpnConnectionRoute

Deletes a static route to a VPN connection previously created using the CreateVpnConnectionRoute method.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/DeleteVpnConnectionRoute \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY' \
  -D ''

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/DeleteVpnConnectionRoute', params={ 'DestinationIpRange': 'string', 'VpnConnectionId': 'string'}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/DeleteVpnConnectionRoute");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DestinationIpRange body string true The network prefix of the route to delete, in CIDR notation (for example, 10.12.0.0/16).
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
VpnConnectionId body string true The ID of the target VPN connection of the static route to delete.

Body parameter

{
  "DestinationIpRange": "string",
  "DryRun": true,
  "VpnConnectionId": "string"
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). DeleteVpnConnectionRouteResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  }
}

ReadVpnConnections

POST /ReadVpnConnections

Describes one or more VPN connections.

[NOTE]
If you exceed the number of identical requests allowed for a configured time period, the RequestLimitExceeded error message is returned.

Code samples

curl -X POST https://api.{region}.outscale.com/oapi/v0/ReadVpnConnections \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('https://api.{region}.outscale.com/oapi/v0/ReadVpnConnections', params={}, headers = headers)

print r.json()

URL obj = new URL("https://api.{region}.outscale.com/oapi/v0/ReadVpnConnections");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

Parameters

Parameter In Type Required Description
DryRun body boolean false If true, checks whether you have the required permissions to perform the action.
Filters body FiltersVpnConnection false One or more filters.
» BgpAsns body [integer] false The Border Gateway Protocol (BGP) Autonomous System Numbers (ASNs) of the connections.
» ClientGatewayIds body [string] false The IDs of the client gateways.
» ConnectionTypes body [string] false The types of the VPN connections (only ipsec.1 is supported).
» RouteDestinationIpRanges body [string] false The destination IP ranges.
» States body [string] false The states of the VPN connections (pending | available | deleting | deleted).
» StaticRoutesOnly body boolean false If false, the VPN connection uses dynamic routing with Border Gateway Protocol (BGP). If true, routing is controlled using static routes. For more information about how to create and delete static routes, see CreateVpnConnectionRoute and DeleteVpnConnectionRoute.
» VirtualGatewayIds body [string] false The IDs of the virtual gateways.
» VpnConnectionIds body [string] false The IDs of the VPN connections.

Body parameter

{
  "DryRun": true,
  "Filters": {
    "BgpAsns": [
      0
    ],
    "ClientGatewayIds": [
      "string"
    ],
    "ConnectionTypes": [
      "string"
    ],
    "RouteDestinationIpRanges": [
      "string"
    ],
    "States": [
      "string"
    ],
    "StaticRoutesOnly": true,
    "VirtualGatewayIds": [
      "string"
    ],
    "VpnConnectionIds": [
      "string"
    ]
  }
}

Responses

Status Meaning Description Schema
200 OK The HTTP 200 response (OK). ReadVpnConnectionsResponse

Example responses

200 Response

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "VpnConnections": [
    {
      "ClientGatewayConfiguration": "string",
      "ClientGatewayId": "string",
      "ConnectionType": "string",
      "Routes": [
        {
          "DestinationIpRange": "string",
          "RouteType": "string",
          "State": "string"
        }
      ],
      "State": "string",
      "StaticRoutesOnly": true,
      "Tags": [
        {
          "Key": "string",
          "Value": "string"
        }
      ],
      "VirtualGatewayId": "string",
      "VpnConnectionId": "string"
    }
  ]
}

Schemas

AcceptNetPeeringResponse

Properties

Name Type Required Restrictions Description
NetPeering NetPeering false none Information about the Net peering connection.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "NetPeering": {
    "AccepterNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "NetPeeringId": "string",
    "SourceNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "State": {
      "Message": "string",
      "Name": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

AccepterNet

Information about the accepter Net.

Properties

Name Type Required Restrictions Description
AccountId string false none The account ID of the owner of the accepter Net.
IpRange string false none The IP range for the accepter Net, in CIDR notation (for example, 10.0.0.0/16).
NetId string false none The ID of the accepter Net.

Schema

{
  "AccountId": "string",
  "IpRange": "string",
  "NetId": "string"
}

AccessLog

Information about access logs.

Properties

Name Type Required Restrictions Description
IsEnabled boolean false none If true, access logs are enabled for your load balancer. If false, they are not. If you set this to true in your request, the OsuBucketName parameter is required.
OsuBucketName string false none The name of the Object Storage Unit (OSU) bucket for the access logs.
OsuBucketPrefix string false none The path to the folder of the access logs in your Object Storage Unit (OSU) bucket (by default, the root level of your bucket).
PublicationInterval integer false none The time interval for the publication of access logs in the Object Storage Unit (OSU) bucket, in minutes. This value can be either 5 or 60 (by default, 60).

Schema

{
  "IsEnabled": true,
  "OsuBucketName": "string",
  "OsuBucketPrefix": "string",
  "PublicationInterval": 0
}

ApplicationStickyCookiePolicy

Information about the stickiness policy.

Properties

Name Type Required Restrictions Description
CookieName string false none The name of the application cookie used for stickiness.
PolicyName string false none The mnemonic name for the policy being created. The name must be unique within a set of policies for this load balancer.

Schema

{
  "CookieName": "string",
  "PolicyName": "string"
}

BackendVmHealth

Information about the health of a back-end VM.

Properties

Name Type Required Restrictions Description
Description string false none The description of the state of the back-end VM.
State string false none The state of the back-end VM (InService | OutOfService | Unknown).
StateReason string false none Information about the cause of OutOfService VMs.
Specifically, whether the cause is Elastic Load Balancing or the VM (ELB | Instance | N/A).
VmId string false none The ID of the back-end VM.

Schema

{
  "Description": "string",
  "State": "string",
  "StateReason": "string",
  "VmId": "string"
}

BlockDeviceMappingCreated

Information about the created block device mapping.

Properties

Name Type Required Restrictions Description
Bsu BsuCreated false none Information about the created BSU volume.
DeviceName string false none The name of the device.

Schema

{
  "Bsu": {
    "DeleteOnVmDeletion": true,
    "LinkDate": "2019-11-08",
    "State": "string",
    "VolumeId": "string"
  },
  "DeviceName": "string"
}

BlockDeviceMappingImage

One or more parameters used to automatically set up volumes when the VM is created.

Properties

Name Type Required Restrictions Description
Bsu BsuToCreate false none Information about the BSU volume to create.
DeviceName string false none The name of the device.
VirtualDeviceName string false none The name of the virtual device (ephemeralN).

Schema

{
  "Bsu": {
    "DeleteOnVmDeletion": true,
    "Iops": 0,
    "SnapshotId": "string",
    "VolumeSize": 0,
    "VolumeType": "string"
  },
  "DeviceName": "string",
  "VirtualDeviceName": "string"
}

BlockDeviceMappingVmCreation

Information about the block device mapping.

Properties

Name Type Required Restrictions Description
Bsu BsuToCreate false none Information about the BSU volume to create.
DeviceName string false none The name of the device.
NoDevice string false none Removes the device which is included in the block device mapping of the OMI.
VirtualDeviceName string false none The name of the virtual device (ephemeralN).

Schema

{
  "Bsu": {
    "DeleteOnVmDeletion": true,
    "Iops": 0,
    "SnapshotId": "string",
    "VolumeSize": 0,
    "VolumeType": "string"
  },
  "DeviceName": "string",
  "NoDevice": "string",
  "VirtualDeviceName": "string"
}

BlockDeviceMappingVmUpdate

Information about the block device mapping.

Properties

Name Type Required Restrictions Description
Bsu BsuToUpdateVm false none Information about the BSU volume.
DeviceName string false none The name of the device.
NoDevice string false none Removes the device which is included in the block device mapping of the OMI.
VirtualDeviceName string false none The name of the virtual device (ephemeralN).

Schema

{
  "Bsu": {
    "DeleteOnVmDeletion": true,
    "VolumeId": "string"
  },
  "DeviceName": "string",
  "NoDevice": "string",
  "VirtualDeviceName": "string"
}

BsuCreated

Information about the created BSU volume.

Properties

Name Type Required Restrictions Description
DeleteOnVmDeletion boolean false none Set to true by default, which means that the volume is deleted when the VM is terminated. If set to false, the volume is not deleted when the VM is terminated.
LinkDate string(date) false none The time and date of attachment of the volume to the VM.
State string false none The state of the volume.
VolumeId string false none The ID of the volume.

Schema

{
  "DeleteOnVmDeletion": true,
  "LinkDate": "2019-11-08",
  "State": "string",
  "VolumeId": "string"
}

BsuToCreate

Information about the BSU volume to create.

Properties

Name Type Required Restrictions Description
DeleteOnVmDeletion boolean false none Set to true by default, which means that the volume is deleted when the VM is terminated. If set to false, the volume is not deleted when the VM is terminated.
Iops integer false none The number of I/O operations per second (IOPS). This parameter must be specified only if you create an io1 volume. The maximum number of IOPS allowed for io1 volumes is 13000.
SnapshotId string false none The ID of the snapshot used to create the volume.
VolumeSize integer false none The size of the volume, in gibibytes (GiB).
If you specify a snapshot ID, the volume size must be at least equal to the snapshot size.
If you specify a snapshot ID but no volume size, the volume is created with a size similar to the snapshot one.
VolumeType string false none The type of the volume (standard | io1 | gp2). If not specified in the request, a standard volume is created.
For more information about volume types, see Volume Types and IOPS.

Schema

{
  "DeleteOnVmDeletion": true,
  "Iops": 0,
  "SnapshotId": "string",
  "VolumeSize": 0,
  "VolumeType": "string"
}

BsuToUpdateVm

Information about the BSU volume.

Properties

Name Type Required Restrictions Description
DeleteOnVmDeletion boolean false none If true, the volume is deleted when the VM is terminated.
VolumeId string false none The ID of the volume.

Schema

{
  "DeleteOnVmDeletion": true,
  "VolumeId": "string"
}

ClientGateway

Information about the client gateway.

Properties

Name Type Required Restrictions Description
BgpAsn integer false none An unsigned 32-bits Autonomous System Number (ASN) used by the Border Gateway Protocol (BGP) to find out the path to your client gateway through the Internet network.
ClientGatewayId string false none The ID of the client gateway.
ConnectionType string false none The type of communication tunnel used by the client gateway (only ipsec.1 is supported).
PublicIp string false none The public IPv4 address of the client gateway (must be a fixed address into a NATed network).
State string false none The state of the client gateway (pending | available | deleting | deleted).
Tags [ResourceTag] false none One or more tags associated with the client gateway.

Schema

{
  "BgpAsn": 0,
  "ClientGatewayId": "string",
  "ConnectionType": "string",
  "PublicIp": "string",
  "State": "string",
  "Tags": [
    {
      "Key": "string",
      "Value": "string"
    }
  ]
}

CreateClientGatewayResponse

Properties

Name Type Required Restrictions Description
ClientGateway ClientGateway false none Information about the client gateway.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "ClientGateway": {
    "BgpAsn": 0,
    "ClientGatewayId": "string",
    "ConnectionType": "string",
    "PublicIp": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateDhcpOptionsResponse

Properties

Name Type Required Restrictions Description
DhcpOptionsSet DhcpOptionsSet false none Information about the DHCP options set.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "DhcpOptionsSet": {
    "Default": true,
    "DhcpOptionsName": "string",
    "DhcpOptionsSetId": "string",
    "DomainName": "string",
    "DomainNameServers": [
      "string"
    ],
    "NtpServers": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateDirectLinkInterfaceResponse

Properties

Name Type Required Restrictions Description
DirectLinkInterface DirectLinkInterfaces false none Information about the DirectLink interfaces.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "DirectLinkInterface": {
    "AccountId": "string",
    "BgpAsn": 0,
    "BgpKey": "string",
    "ClientPrivateIp": "string",
    "DirectLinkId": "string",
    "DirectLinkInterfaceId": "string",
    "DirectLinkInterfaceName": "string",
    "InterfaceType": "string",
    "Location": "string",
    "OutscalePrivateIp": "string",
    "State": "string",
    "VirtualGatewayId": "string",
    "Vlan": 0
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateDirectLinkResponse

Properties

Name Type Required Restrictions Description
DirectLink DirectLink false none Information about the DirectLink.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "DirectLink": {
    "AccountId": "string",
    "Bandwidth": "string",
    "DirectLinkId": "string",
    "DirectLinkName": "string",
    "Location": "string",
    "RegionName": "string",
    "State": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateFlexibleGpuResponse

Properties

Name Type Required Restrictions Description
FlexibleGpu FlexibleGpu false none Information about the flexible GPU (fGPU).
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "FlexibleGpu": {
    "DeleteOnVmDeletion": true,
    "FlexibleGpuId": "string",
    "ModelName": "string",
    "State": "string",
    "SubregionName": "string",
    "VmId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateImageExportTaskResponse

Properties

Name Type Required Restrictions Description
ImageExportTask ImageExportTask false none Information about the OMI export task.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "ImageExportTask": {
    "Comment": "string",
    "ImageId": "string",
    "OsuExport": {
      "DiskImageFormat": "string",
      "OsuApiKey": {
        "ApiKeyId": "string",
        "SecretKey": "string"
      },
      "OsuBucket": "string",
      "OsuManifestUrl": "string",
      "OsuPrefix": "string"
    },
    "Progress": 0,
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "TaskId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateImageResponse

Properties

Name Type Required Restrictions Description
Image Image false none Information about the OMI.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "Image": {
    "AccountAlias": "string",
    "AccountId": "string",
    "Architecture": "string",
    "BlockDeviceMappings": [
      {
        "Bsu": {
          "DeleteOnVmDeletion": true,
          "Iops": 0,
          "SnapshotId": "string",
          "VolumeSize": 0,
          "VolumeType": "string"
        },
        "DeviceName": "string",
        "VirtualDeviceName": "string"
      }
    ],
    "CreationDate": "2019-11-08",
    "Description": "string",
    "FileLocation": "string",
    "ImageId": "string",
    "ImageName": "string",
    "ImageType": "string",
    "PermissionsToLaunch": {
      "AccountIds": [
        "string"
      ],
      "GlobalPermission": true
    },
    "ProductCodes": [
      "string"
    ],
    "RootDeviceName": "string",
    "RootDeviceType": "string",
    "State": "string",
    "StateComment": {
      "StateCode": "string",
      "StateMessage": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateInternetServiceResponse

Properties

Name Type Required Restrictions Description
InternetService InternetService false none Information about the Internet service.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "InternetService": {
    "InternetServiceId": "string",
    "NetId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateKeypairResponse

Properties

Name Type Required Restrictions Description
Keypair KeypairCreated false none Information about the created keypair.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "Keypair": {
    "KeypairFingerprint": "string",
    "KeypairName": "string",
    "PrivateKey": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateLoadBalancerListenersResponse

Properties

Name Type Required Restrictions Description
LoadBalancer LoadBalancer false none Information about the load balancer.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateLoadBalancerPolicyResponse

Properties

Name Type Required Restrictions Description
LoadBalancer LoadBalancer false none Information about the load balancer.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateLoadBalancerResponse

Properties

Name Type Required Restrictions Description
LoadBalancer LoadBalancer false none Information about the load balancer.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "LoadBalancer": {
    "AccessLog": {
      "IsEnabled": true,
      "OsuBucketName": "string",
      "OsuBucketPrefix": "string",
      "PublicationInterval": 0
    },
    "ApplicationStickyCookiePolicies": [
      {
        "CookieName": "string",
        "PolicyName": "string"
      }
    ],
    "BackendVmIds": [
      "string"
    ],
    "DnsName": "string",
    "HealthCheck": {
      "CheckInterval": 0,
      "HealthyThreshold": 0,
      "Path": "string",
      "Port": 0,
      "Protocol": "string",
      "Timeout": 0,
      "UnhealthyThreshold": 0
    },
    "Listeners": [
      {
        "BackendPort": 0,
        "BackendProtocol": "string",
        "LoadBalancerPort": 0,
        "LoadBalancerProtocol": "string",
        "PolicyNames": [
          "string"
        ],
        "ServerCertificateId": "string"
      }
    ],
    "LoadBalancerName": "string",
    "LoadBalancerStickyCookiePolicies": [
      {
        "PolicyName": "string"
      }
    ],
    "LoadBalancerType": "string",
    "NetId": "string",
    "SecurityGroups": [
      "string"
    ],
    "SourceSecurityGroup": {
      "SecurityGroupAccountId": "string",
      "SecurityGroupName": "string"
    },
    "Subnets": [
      "string"
    ],
    "SubregionNames": [
      "string"
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateNatServiceResponse

Properties

Name Type Required Restrictions Description
NatService NatService false none Information about the NAT service.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "NatService": {
    "NatServiceId": "string",
    "NetId": "string",
    "PublicIps": [
      {
        "PublicIp": "string",
        "PublicIpId": "string"
      }
    ],
    "State": "string",
    "SubnetId": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateNetAccessPointResponse

Properties

Name Type Required Restrictions Description
NetAccessPoint NetAccessPoint false none Information about the Net access point.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "NetAccessPoint": {
    "NetAccessPointId": "string",
    "NetId": "string",
    "RouteTableIds": [
      "string"
    ],
    "ServiceName": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateNetPeeringResponse

Properties

Name Type Required Restrictions Description
NetPeering NetPeering false none Information about the Net peering connection.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "NetPeering": {
    "AccepterNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "NetPeeringId": "string",
    "SourceNet": {
      "AccountId": "string",
      "IpRange": "string",
      "NetId": "string"
    },
    "State": {
      "Message": "string",
      "Name": "string"
    },
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateNetResponse

Properties

Name Type Required Restrictions Description
Net Net false none Information about the Net.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "Net": {
    "DhcpOptionsSetId": "string",
    "IpRange": "string",
    "NetId": "string",
    "State": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "Tenancy": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateNicResponse

Properties

Name Type Required Restrictions Description
Nic Nic false none Information about the NIC.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "Nic": {
    "AccountId": "string",
    "Description": "string",
    "IsSourceDestChecked": true,
    "LinkNic": {
      "DeleteOnVmDeletion": true,
      "DeviceNumber": 0,
      "LinkNicId": "string",
      "State": "string",
      "VmAccountId": "string",
      "VmId": "string"
    },
    "LinkPublicIp": {
      "LinkPublicIpId": "string",
      "PublicDnsName": "string",
      "PublicIp": "string",
      "PublicIpAccountId": "string",
      "PublicIpId": "string"
    },
    "MacAddress": "string",
    "NetId": "string",
    "NicId": "string",
    "PrivateDnsName": "string",
    "PrivateIps": [
      {
        "IsPrimary": true,
        "LinkPublicIp": {
          "LinkPublicIpId": "string",
          "PublicDnsName": "string",
          "PublicIp": "string",
          "PublicIpAccountId": "string",
          "PublicIpId": "string"
        },
        "PrivateDnsName": "string",
        "PrivateIp": "string"
      }
    ],
    "SecurityGroups": [
      {
        "SecurityGroupId": "string",
        "SecurityGroupName": "string"
      }
    ],
    "State": "string",
    "SubnetId": "string",
    "SubregionName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreatePublicIpResponse

Properties

Name Type Required Restrictions Description
PublicIp PublicIp false none Information about the public IP.
ResponseContext ResponseContext false none Information about the context of the response.

Schema

{
  "PublicIp": {
    "LinkPublicIpId": "string",
    "NicAccountId": "string",
    "NicId": "string",
    "PrivateIp": "string",
    "PublicIp": "string",
    "PublicIpId": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ],
    "VmId": "string"
  },
  "ResponseContext": {
    "RequestId": "string"
  }
}

CreateRouteResponse

Properties

Name Type Required Restrictions Description
ResponseContext ResponseContext false none Information about the context of the response.
RouteTable RouteTable false none Information about the route table.

Schema

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

CreateRouteTableResponse

Properties

Name Type Required Restrictions Description
ResponseContext ResponseContext false none Information about the context of the response.
RouteTable RouteTable false none Information about the route table.

Schema

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "RouteTable": {
    "LinkRouteTables": [
      {
        "LinkRouteTableId": "string",
        "Main": true,
        "RouteTableId": "string",
        "SubnetId": "string"
      }
    ],
    "NetId": "string",
    "RoutePropagatingVirtualGateways": [
      {
        "VirtualGatewayId": "string"
      }
    ],
    "RouteTableId": "string",
    "Routes": [
      {
        "CreationMethod": "string",
        "DestinationIpRange": "string",
        "DestinationServiceId": "string",
        "GatewayId": "string",
        "NatServiceId": "string",
        "NetAccessPointId": "string",
        "NetPeeringId": "string",
        "NicId": "string",
        "State": "string",
        "VmAccountId": "string",
        "VmId": "string"
      }
    ],
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

CreateSecurityGroupResponse

Properties

Name Type Required Restrictions Description
ResponseContext ResponseContext false none Information about the context of the response.
SecurityGroup SecurityGroup false none Information about the security group.

Schema

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SecurityGroup": {
    "AccountId": "string",
    "Description": "string",
    "InboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "NetId": "string",
    "OutboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId": "string",
            "SecurityGroupId": "string",
            "SecurityGroupName": "string"
          }
        ],
        "ServiceIds": [
          "string"
        ],
        "ToPortRange": 0
      }
    ],
    "SecurityGroupId": "string",
    "SecurityGroupName": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  }
}

CreateSecurityGroupRuleResponse

Properties

Name Type Required Restrictions Description
ResponseContext ResponseContext false none Information about the context of the response.
SecurityGroup SecurityGroup false none Information about the security group.

Schema

{
  "ResponseContext": {
    "RequestId": "string"
  },
  "SecurityGroup": {
    "AccountId": "string",
    "Description": "string",
    "InboundRules": [
      {
        "FromPortRange": 0,
        "IpProtocol": "string",
        "IpRanges": [
          "string"
        ],
        "SecurityGroupsMembers": [
          {
            "AccountId