Get a Cloud Instance's current state/information

GET /pcloud/v1/cloud-instances/{cloud_instance_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance.list

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-instance.read

Request

Response

The tenant ID that owns this cloud instance

usage

error

string

Get all cloud connections in this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-connection.list

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.list

Request

Response

200 - OK

cloudConnections

error

string

Create a new cloud connection

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-connection.create

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.create

Request

Request Body

CloudConnectionCreate

Parameters for the creation of a new cloud connection

classic

object

enabled

boolean

enable classic endpoint destination (default=false)

gre

object

globalRouting

boolean

enable global routing for this cloud connection (default=false)

metered

boolean

enable metered for this cloud connection (default=false)

name

Required *

string

name of the cloud connection

speed

Required *

integer

speed of the cloud connection (speed in megabits per second)

subnets

array

list of subnets to attach to cloud connection

transitEnabled

boolean

enable transit gateway for this cloud connection (default=false)

vpc

object

enabled

boolean

enable vpc for this cloud connection (default=false)

vpcs

array

vpc connections

Response

userIPAddress

string

user IP address

vpc

string

error

string

Get all virtual private cloud connections in this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections-virtual-private-clouds

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-connection-vpc.list

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.list

Request

Response

200 - OK

virtualPrivateClouds

error

string

Delete a Cloud Connection

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-connection.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.delete

Request

Response

200 - OK

202 - Accepted

href

string

Link to job resource

id

error

string

Get a cloud connection's state/information

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-connection.read

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.read

Request

Response

string

Update a Cloud Connection

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-connection.update

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.update

Request

Request Body

CloudConnectionUpdate

Parameters to update a Cloud Connection

classic

object

enabled

boolean

enable classic endpoint destination (default=false)

gre

object

globalRouting

boolean

enable global routing for this cloud connection (default=false)

metered

boolean

enable metered for this cloud connection (default=false)

name

string

name of the cloud connection

speed

integer

speed of the cloud connection (speed in megabits per second)

vpc

object

enabled

boolean

enable vpc for this cloud connection (default=false)

vpcs

array

vpc connections

Response

userIPAddress

string

user IP address

vpc

object

202 - Accepted

href

string

Link to job resource

id

error

string

Detach a network from a Cloud Connection

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-connection-network.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.delete

Request

Response

200 - OK

202 - Accepted

href

string

Link to job resource

id

error

string

Attach a network to the cloud connection

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-connection-network.update

Auditing

Calling this method generates the following auditing event.

power-iaas.cloud-connection.update

Request

Response

200 - OK

202 - Accepted

href

string

Link to job resource

id

error

string

Get detail of last cos-image import job

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cos-image.read

Auditing

Calling this method generates the following auditing event.

power-iaas.image.read

Request

Response

200 - OK

createTimestamp

string

string

error

string

Create an cos-image import job

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cos-image.create

Auditing

Calling this method generates the following auditing event.

power-iaas.image.import

Request

Request Body

CreateCosImageImportJob

Parameters for the creation of a new cos-image import job

accessKey

string

Cloud Object Storage access key; required for buckets with private access

object

Import details for SAP images

licenseType

Required *

string

Origin of the license of the product

product

Required *

string

Product within the image

vendor

Required *

object

List of user tags

Response

202 - Accepted, cos-image import successfully added to the jobs queue

href

string

Link to job resource

id

error

string

Get events from this cloud instance since a specific timestamp

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/events

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.event.list

Auditing

Calling this method generates the following auditing event.

power-iaas.event.list

Request

Path Parameters

Query Parameters

time

string

(deprecated - use from_time) A time in either ISO 8601 or unix epoch format

from_time

string

A from query time in either ISO 8601 or unix epoch format

to_time

string

A to query time in either ISO 8601 or unix epoch format

Response

200 - OK

events

error

string

Get a single event

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/events/{event_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.event.read

Auditing

Calling this method generates the following auditing event.

power-iaas.event.read

Request

Path Parameters

Query Parameters

Response

string

List all images for this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/images

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance-image.list

Auditing

Calling this method generates the following auditing event.

power-iaas.image.list

Request

Response

200 - OK

images

error

string

Create a new Image (from available images)

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/images

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-image.create

Auditing

Calling this method generates the following auditing event.

power-iaas.image.import

string

Source of the image > Note: url option is deprecated, this option is supported till Oct 2022

storageAffinity

object

The storage affinity data; ignored if storagePool is provided; Used only when importing an image from cloud storage.

affinityPVMInstance

string

PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and affinityVolume is not provided

state

string

Image State

storagePool

string

Storage pool where the image resides

storageType

string

Storage type for image

taskref

object

userTags

object

List of user tags

volumes

array

object

state

string

Image State

storagePool

string

Storage pool where the image resides

storageType

string

Storage type for image

taskref

object

userTags

object

List of user tags

volumes

error

string

Delete an Image from a Cloud Instance

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-image.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.image.delete

Request

Response

200 - OK

Detailed info of an image

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance-image.read

Auditing

Calling this method generates the following auditing event.

power-iaas.image.read

Request

Response

state

string

Image State

storagePool

string

Storage pool where the image resides

storageType

string

Storage type for image

taskref

object

userTags

object

List of user tags

volumes

error

string

Export an image

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}/export

This API is deprecated for /pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export.

>Note: Support for this API is available till Oct 2022.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.image-export.create

Auditing

Calling this method generates the following auditing event.

power-iaas.image.export

Request

Request Body

ExportImage

Parameters for exporting an image

accessKey

Required *

string

Cloud Object Storage Access key

bucketName

Required *

string

Cloud Object Storage Bucket name

region

string

Cloud Object Storage Region; required for IBM COS

secretKey

string

Cloud Object Storage Secret key

Response

202 - Accepted

List up to the last 5 jobs initiated by the cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.job.list

Auditing

Calling this method generates the following auditing event.

power-iaas.job.list

Request

Path Parameters

Query Parameters

operation.id

string

Operation ID to filter jobs (optional)

operation.target

string

Operation target to filter jobs (optional)

operation.action

string

Operation action to filter jobs (optional) vmCapture - includes operation action value (vmCapture) imageExport - includes operation action value (imageExport) imageImport - includes operation action value (imageImport) storage - includes operation action values (vmCapture,imageExport,imageImport)

Response

200 - OK

jobs

error

string

Delete a cloud instance job

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.job.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.job.delete

Request

Response

200 - OK

List the detail of a job

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.job.read

Auditing

Calling this method generates the following auditing event.

power-iaas.job.read

Request

Response

200 - OK

createTimestamp

string

string

error

string

Get the disaster recovery site details for the current location

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/locations/disaster-recovery

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.disaster-recovery.read

Auditing

Calling this method generates the following auditing event.

power-iaas.disaster-recovery.read

Request

Response

200 - OK

location

string

regionZone of a site

replicationSites

error

string

Get all networks in this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/networks

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network.list

Auditing

Calling this method generates the following auditing event.

power-iaas.network.list

Request

Path Parameters

Query Parameters

filter

string

A filter expression that filters resources listed in the response

Response

200 - OK

networks

error

string

Create a new Network

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/networks

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network.create

Auditing

Calling this method generates the following auditing event.

power-iaas.network.create

string

Type of Network - 'vlan' (private network), 'pub-vlan' (public network)

userTags

object

List of user tags

Response

200 - OK

accessConfig

List of user tags

vlanID

error

string

Delete a Network

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.network.delete

Request

Response

200 - OK

Get a network's current state/information

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network.read

Auditing

Calling this method generates the following auditing event.

power-iaas.network.read

Request

Response

200 - OK

accessConfig

error

string

Update a Network

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network.update

Replaces the current IP Address Ranges

name

string

Replaces the current Network Name

Response

200 - OK

accessConfig

error

string

Get all ports for this network

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports

This API is deprecated for /v1/networks/{network_id}/network-interfaces.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-port.list

Auditing

Calling this method generates the following auditing event.

power-iaas.port.list

Request

Response

200 - OK

ports

error

string

Perform port addition, deletion, and listing

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports

This API is deprecated for /v1/networks/{network_id}/network-interfaces.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-port.create

Auditing

Calling this method generates the following auditing event.

power-iaas.port.create

Request

Request Body

NetworkPortCreate

Create a Network Port

description

string

Description of the port (not unique or indexable)

ipAddress

string

The requested ip address of this port

Response

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-port.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.port.delete

Request

Response

200 - OK

power-iaas.cloud-instance.read
power-iaas.network-port.read

Auditing

Calling this method generates the following auditing event.

power-iaas.port.read

Request

Response

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-port.update

Auditing

Calling this method generates the following auditing event.

power-iaas.port.update

Request

Request Body

NetworkPortUpdate

Parameters for updating a Port

description

string

Description of the port (not unique or indexable)

pvmInstanceID

string

If supplied populated it attaches to the PVMInstanceID, if empty detaches from PVMInstanceID

Response

string

Get all Server Placement Groups

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.placement-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.placement-group.list

Request

Response

200 - OK

placementGroups

error

string

Create a new Server Placement Group

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.placement-group.create

Auditing

Calling this method generates the following auditing event.

power-iaas.placement-group.create

Request

Request Body

PlacementGroupCreate

Parameters for the creation of a new Server Placement Group

name

Required *

string

The name of the Placement Group

policy

Required *

string

The Placement Group Policy

userTags

object

List of user tags

Response

error

string

Delete Server Placement Group

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.placement-group.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.placement-group.delete

Request

Response

200 - OK

Get Server Placement Group detail

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.placement-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.placement-group.read

Request

Response

error

string

Remove Server from Placement Group

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}/members

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.placement-group-member.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.placement-groups.update

Request

Request Body

PlacementGroupServer

Parameters for removing a Server in a Placement Group

id

Required *

string

The ID of the Server

Response

error

string

Add Server to Placement Group

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}/members

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.placement-group-member.create

Auditing

Calling this method generates the following auditing event.

power-iaas.placement-groups.update

Request

Request Body

PlacementGroupServer

Parameters for adding a server to a Server Placement Group

id

Required *

string

The ID of the Server

Response

error

string

List of available resources within a particular Pod

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pod-capacity

Applicable to satellite locations only.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.pod-capacity.view

Auditing

Calling this method generates the following auditing event.

power-iaas.pod-capacity.list

Request

Response

200 - OK

PodData

Description of a PPCaaS Pod

StorageControllers

List of available storage controllers within a particular DataCenter

SystemPools

error

string

Get all the pvm instances for this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance.list

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.list

Request

Response

200 - OK

pvmInstances

error

string

Create a new Power VM Instance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.create

Request

Request Body

PVMInstanceCreate

Parameters for the creation of a new Power VM Instance

allowRemoteRestart

boolean

if set to false, automated remote restart is disabled for the VM

defaultTrustedProfile

object

default IAM trusted profile to use for this virtual server instance

autolink

boolean

If set to true, the system will create a link to the specified trusted profile during server creation. Regardless of whether a link is created by the system or manually using the IAM Identity service, it will be automatically deleted when the server is deleted.

target

Required *

object

trusted profile associated with the VM. Specify one of crn, id or name

deploymentTarget

object

The deployment of a dedicated host

id

Required *

string

The uuid of the host group or host

type

Required *

string

specify if deploying to a host group or a host

deploymentType

string

The custom deployment type

imageID

Required *

string

Image ID of the image to use for the server

keyPairName

string

The name of the SSH key pair provided to the server for authenticating users (looked up in the tenant's list of keys)

licenseRepositoryCapacity

integer

The VTL license repository capacity TiB value

memory

Required *

number

Amount of memory allocated (in GiB)

metadataService

object

The metadata service configuration

enabled

Required *

processors

Required *

number

Number of processors allocated

replicantAffinityPolicy

string

Affinity policy for replicants being created; affinity for the same host, anti-affinity for different hosts, none for no preference

replicantNamingScheme

string

How to name the created vms

replicants

number

Number of duplicate instances to create in this request

serverName

affinityPolicy

softwareTier

object

IBMi licensing software tier for the VSI.

volumeIDs

array

List of volume IDs

vpmemVolumes

array

The vPMEM volumes information

Path Parameters

Query Parameters

skipHostValidation

boolean

Option to skip host validation on PVMInstance Create API

Response

200 - OK

201 - Created

202 - Accepted

Delete a PCloud PVM Instance

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.delete

Request

Request Body

PVMInstanceDelete

Parameters to delete a PVM Instance

retainVSN

boolean

Indicates if the Virtual Serial Number attached to a PVM Instance is retained or not

Path Parameters

Query Parameters

delete_data_volumes

boolean

Indicates if all data volumes attached to the PVMInstance should be deleted when deleting the PVMInstance. Shared data volumes will be deleted if there are no other PVMInstances attached.

Response

200 - OK

Get a PVM Instance's current state or information

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance.read

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.read

Request

Response

List of volume IDs

vpmemVolumes

error

string

Update a PCloud PVM Instance

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance.update

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.update

assigned

Required *

integer

The active virtual Cores

max

integer

The maximum DLPAR range for virtual Cores (Display only support)

min

integer

The minimum DLPAR range for virtual Cores (Display only support)

Response

virtualCores

error

string

Perform an action on a PVMInstance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/action

Corresponding actions are 'start', 'stop', 'reboot', 'immediate-shutdown', 'reset'

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance.action

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.start
power-iaas.pvm-instance.stop
power-iaas.pvm-instance.immediate-shutdown
power-iaas.pvm-instance.renew
power-iaas.pvm-instance.unknown

Request

Request Body

PVMInstanceAction

Parameters for the desired action

action

Required *

string

Name of the action to take; can be 'dhcp-ip-sync' (on-prem only), 'dumprestart', 'hard-reboot', 'immediate-shutdown', 'reset-state', 'soft-reboot', 'start', 'stop'

Response

200 - OK

Capture a PVMInstance and create a deployable image

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture

This API is deprecated for /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture.

>Note: Support for this API is available till Oct 2022.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-capture.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.capture

Request

Request Body

PVMInstanceCapture

Parameters for the capture PVMInstance

captureDestination

Required *

string

Destination for the deployable image

captureName

Required *

object

List of user tags

Response

200 - OK

202 - Accepted, upload to cloud storage in progress

List all console languages

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-console.read

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.monitor

Request

Response

200 - OK

consoleLanguages

error

string

Generate the noVNC Console URL

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-console.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.monitor

Request

Response

201 - Created

consoleURL

error

string

Update PVMInstance console language code

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-console.update

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.monitor

Request

Request Body

ConsoleLanguage

Parameters to update a PVMInstance console required codepage

code

Required *

string

language code

language

string

language description

Response

200 - OK

code

string

language code

language

error

string

Get all networks for this PVM Instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-network.list

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-network.list

Request

Response

200 - OK

networks

error

string

Perform network addition

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-network.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-network.create

Request

Request Body

PVMInstanceAddNetwork

Add network to PVM Instance parameters

ipAddress

string

The requested ip address of this network interface. Only valid when networkID is specified.

networkID

string

ID of the network. Required if externalNetworkInterfaceCRN is not specified. Cannot be combined with externalNetworkInterfaceCRN.

networkSecurityGroupIDs

array

Network security groups that the network interface is a member of. There is a limit of 1 network security group in the array. If not specified, default network security group is used. Only valid when networkID is specified.

Response

error

string

Remove all Address of Network from a PVM Instance

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-network.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-network.delete

Request

Request Body

PVMInstanceRemoveNetwork

Remove a network from PVM Instance parameters

macAddress

string

The mac address of the network interface to be removed

Response

200 - OK

Get a PVM Instance's network information

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-network.read

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-network.read

Request

Response

200 - OK

networks

error

string

Perform an operation on a PVMInstance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/operations

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance.operation

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.operation

string

Name of the operation to execute; can be job or boot

Response

200 - OK

Get all snapshots for this PVM Instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-snapshot.list

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.list

Request

Response

200 - OK

snapshots

error

string

Create a PVM Instance snapshot

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-snapshot.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.snapshot

Request

Request Body

SnapshotCreate

PVM Instance snapshot create parameters

description

string

Description of the PVM instance snapshot

name

Required *

string

Name of the PVM instance snapshot to create

userTags

object

List of user tags

volumeIDs

array

List of volumes to include in the PVM instance snapshot

Response

202 - Accepted

crn

object

The CRN for this resource

snapshotID

string

ID of the PVM instance snapshot

userTags

error

string

Restore a PVM Instance snapshot

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots/{snapshot_id}/restore

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-snapshot.restore

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.read

Request

Request Body

SnapshotRestore

PVM Instance snapshot restore parameters

force

boolean

By default the VM must be shutoff during a snapshot restore, force set to true will relax the VM shutoff pre-condition.

Response

Detailed information for the last PVM instance snapshot action

volumeSnapshots

error

string

Unassign Virtual Serial Number from a PVM Instance

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-virtual-serial-number.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-virtual-serial-number.delete

Request

Request Body

DeleteServerVirtualSerialNumber

Parameters to unassign a Virtual Serial Number attached to a PVM Instance

retainVSN

boolean

Indicates if the Virtual Serial Number attached to a PVM Instance is retained or not

Response

202 - Accepted

Get a PVM Instance's Virtual Serial Number Information

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-virtual-serial-number.read

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-virtual-serial-number.read

Request

Response

200 - OK

description

string

Description of the Virtual Serial Number

pvmInstanceID

string

ID of the PVM Instance Virtual Serial Number is attached to.

serial

string

Virtual Serial Number assigned to the PVM Instance

softwareTier

error

string

Assign Virtual Serial Number to a PVM Instance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-virtual-serial-number.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-virtual-serial-number.create

Request

Request Body

AddServerVirtualSerialNumber

Parameters to assign Virtual Serial Number to a PVM Instance

description

string

Description of the Virtual Serial Number

serial

Required *

string

Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.

Response

202 - Accepted

description

string

Description of the Virtual Serial Number

pvmInstanceID

string

ID of the PVM Instance Virtual Serial Number is attached to.

serial

string

Virtual Serial Number assigned to the PVM Instance

softwareTier

error

string

Update a Virtual Serial Number

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-virtual-serial-number.update

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-virtual-serial-number.update

Request

Request Body

UpdateServerVirtualSerialNumber

Parameters to update a Virtual Serial Number description

description

string

Description of the Virtual Serial Number

softwareTier

object

IBMi licensing software tier for the VSI.

Response

200 - OK

description

string

Description of the Virtual Serial Number

pvmInstanceID

string

ID of the PVM Instance Virtual Serial Number is attached to.

serial

string

Virtual Serial Number assigned to the PVM Instance

softwareTier

object

IBMi licensing software tier for the VSI.

202 - Accepted

description

string

Description of the Virtual Serial Number

pvmInstanceID

string

ID of the PVM Instance Virtual Serial Number is attached to.

serial

string

Virtual Serial Number assigned to the PVM Instance

softwareTier

error

string

List all volumes attached to a PVM Instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-volume.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.list

Request

Response

200 - OK

volumes

error

string

Detach a volume from a PVMInstance

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-volume.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.configure

Request

Response

202 - Accepted

Detailed info of a volume attached to a PVMInstance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-volume.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.read

Request

Response

Volume type, name of storage template used to create the volume

wwn

error

string

Attach a volume to a PVMInstance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}

Attach a volume to a PVMInstance. > Note: Recommended for attaching data volumes. In the case of VMRM, it is recommended to use the 'Attach all volumes to a PVM instance' API for attaching the first boot volume.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-volume.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.configure

Request

Response

200 - OK

Update a volume attached to a PVMInstance

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-volume.update

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.configure

Request

Request Body

PVMInstanceVolumeUpdate

Parameters to update a volume attached to a PVMInstance

deleteOnTermination

Required *

boolean

Indicates if the volume should be deleted when the PVMInstance is terminated.

Response

200 - OK

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-boot-volume.update

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.configure

Request

Response

200 - OK

List all vPMEM volumes attached to this PVM Instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/vpmem-volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-vpmem-volume.list

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-vpmem-volume.list

Request

Response

200 - OK

volumes

error

string

Create a vPMEM volume to be attached to this PVM Instance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/vpmem-volumes

vPMEM volumes of PVM Instances using SAP profiles will be carved out of profile total memory. Other cases are in addition to total memory.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-vpmem-volume.create

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-vpmem-volume.create

Request

Request Body

VPMemVolumeAttach

PVM Instance vPMEM volume create parameters

userTags

object

List of user tags

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/vpmem-volumes/{vpmem_volume_id}

vPMEM volumes of PVM Instances using SAP profiles will return carved out memory. Other cases are a reduction from total memory.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-vpmem-volume.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-vpmem-volume.delete

Request

Response

202 - Accepted

Get information about a vPMEM volume

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/vpmem-volumes/{vpmem_volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-vpmem-volume.read

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-vpmem-volume.read

Request

Response

The date and time when the volume was updated

uuid

error

string

Update a vPMEM volume attached to this PVM Instance

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/vpmem-volumes/{vpmem_volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-vpmem-volume.update

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance-vpmem-volume.update

Request

Request Body

VPMemVolumeUpdate

Parameters to update a vPMEM volume

name

Required *

string

Volume base name

Response

The date and time when the volume was updated

uuid

error

string

Get list of SAP profiles

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/sap

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.sap.list

Auditing

Calling this method generates the following auditing event.

power-iaas.sap.list

Request

Path Parameters

Query Parameters

profile_prefix

string

SAP profile prefix to filter by

profile_family

string

SAP profile family to filter by

Response

200 - OK

profiles

error

string

Create a new SAP PVM Instance

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/sap

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.sap.create

Auditing

Calling this method generates the following auditing event.

power-iaas.sap.create

The deployment of a dedicated host

id

Required *

string

The uuid of the host group or host

type

Indicates whether the metadata service endpoint will be available to the virtual server

name

Required *

string

Name of the sap pvm-instance

networks

Required *

array

The pvm instance networks information

pinPolicy

string

Specify PVM pin policy

placementGroup

string

The placement group for the server

preferredProcessorCompatibilityMode

string

Preferred processor compatibility mode

profileID

Required *

string

array

The vPMEM volumes information. Only one volume is supported at this time.

Response

200 - OK

201 - Created

202 - Accepted

Get the information on an SAP profile

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/sap/{sap_profile_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.sap.read

Auditing

Calling this method generates the following auditing event.

power-iaas.sap.read

Request

Response

200 - OK

error

string

List all shared processor pools

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/shared-processor-pools

Lists all shared processor pools belonging to the specified workspace.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.shared-processor-pool.list

Auditing

Calling this method generates the following auditing event.

power-iaas.shared-processor-pool.list

Request

Response

200 - OK

sharedProcessorPools

error

string

Create a new shared processor pool

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/shared-processor-pools

Creates a new shared processor pool (SPP) in the specified workspace.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.shared-processor-pool.create

Auditing

Calling this method generates the following auditing event.

power-iaas.shared-processor-pool.create

The number of processor cores to reserve for the shared processor pool.

userTags

object

List of user tags

Response

error

string

Delete a shared processor pool

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/shared-processor-pools/{shared_processor_pool_id}

Deletes a shared processor pool (SPP) from the specified workspace. The pool must have no virtual server instances deployed before it can be deleted.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.shared-processor-pool.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.shared-processor-pool.delete

Request

Response

200 - OK

power-iaas.cloud-instance.read
power-iaas.shared-processor-pool.read

Auditing

Calling this method generates the following auditing event.

power-iaas.shared-processor-pool.read

Request

Response

200 - OK

power-iaas.cloud-instance.modify
power-iaas.shared-processor-pool.update

Auditing

Calling this method generates the following auditing event.

power-iaas.shared-processor-pool.update

Request

Request Body

SharedProcessorPoolUpdate

The shared processor pool update parameters.

name

string

The new name for the shared processor pool.

reservedCores

integer

The number of processor cores to reserve for the shared processor pool. The value cannot be decreased below the pool's currently allocated cores. Increasing the value is subject to available capacity on the host.

Response

error

string

List all PVM instance snapshots for this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance-snapshot.list

Auditing

Calling this method generates the following auditing event.

power-iaas.snapshot.list

Request

Response

200 - OK

snapshots

error

string

Delete a PVM instance snapshot of a cloud instance

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-snapshot.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.snapshot.delete

Request

Response

202 - Accepted

Get the detail of a snapshot

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance-snapshot.read

Auditing

Calling this method generates the following auditing event.

power-iaas.snapshot.read

Request

Response

Detailed information for the last PVM instance snapshot action

volumeSnapshots

error

string

Update a PVM instance snapshot

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-snapshot.update

Auditing

Calling this method generates the following auditing event.

power-iaas.snapshot.update

Request

Request Body

SnapshotUpdate

Parameters for the update of a PVM instance snapshot

description

string

Description of the PVM instance snapshot with a maximum of 255 characters allowed.

name

string

Name of the PVM instance snapshot

Response

Detailed information for the last PVM instance snapshot action

volumeSnapshots

error

string

List all shared processor pool placement groups

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups

Lists all shared processor pool placement groups in the specified workspace.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.spp-placement-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.spp-placement-group.list

Request

Response

200 - OK

sppPlacementGroups

error

string

Create a shared processor pool placement group

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups

Creates a new shared processor pool placement group in the specified workspace.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.spp-placement-group.create

Auditing

Calling this method generates the following auditing event.

power-iaas.spp-placement-group.create

Request

Request Body

SPPPlacementGroupCreate

The shared processor pool placement group creation parameters.

name

Required *

string

The name of the shared processor pool placement group.

policy

Required *

string

The placement policy for the placement group.

userTags

object

List of user tags

Response

error

string

Delete a shared processor pool placement group

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups/{spp_placement_group_id}

Deletes a shared processor pool placement group from the specified workspace. The placement group must have no member shared processor pools before it can be deleted.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.spp-placement-group.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.spp-placement-group.delete

Request

Response

200 - OK

power-iaas.cloud-instance.read
power-iaas.spp-placement-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.spp-placement-group.read

Request

Response

error

string

Remove a member from a shared processor pool placement group

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups/{spp_placement_group_id}/members/{shared_processor_pool_id}

Removes a shared processor pool from the specified placement group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.spp-placement-group-member.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.spp-placement-groups.delete

Request

Response

error

string

Add a member to a shared processor pool placement group

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups/{spp_placement_group_id}/members/{shared_processor_pool_id}

Adds a shared processor pool as a member of the specified placement group.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.spp-placement-group-member.create

Auditing

Calling this method generates the following auditing event.

power-iaas.spp-placement-groups.update

Request

Response

error

string

List all available stock images

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.stock-image.list

Auditing

Calling this method generates the following auditing event.

power-iaas.stock-image.list

Request

Response

200 - OK

images

error

string

Detailed info of an available stock image

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.stock-image.read

Auditing

Calling this method generates the following auditing event.

power-iaas.stock-image.read

Request

Response

state

string

Image State

storagePool

string

Storage pool where the image resides

storageType

string

Storage type for image

taskref

object

userTags

object

List of user tags

volumes

error

string

Storage capacity for all available storage pools in a region

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-pools

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pod-capacity.view
power-iaas.storage-capacity-pool.list

Auditing

Calling this method generates the following auditing event.

power-iaas.storage-capacity.list

Request

Response

200 - OK

Storage capacity for a storage pool in a region

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-pools/{storage_pool_name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pod-capacity.view
power-iaas.storage-capacity-pool.read

Auditing

Calling this method generates the following auditing event.

power-iaas.storage-capacity.read

Request

Response

Storage type of the storage pool

totalCapacity

error

string

Storage capacity for all available storage types in a region

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-types

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.storage-capacity-type.list

Auditing

Calling this method generates the following auditing event.

power-iaas.storage-capacity.list

Request

Response

200 - OK

Storage capacity for a storage type in a region

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-types/{storage_type_name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pod-capacity.view
power-iaas.storage-capacity-type.read

Auditing

Calling this method generates the following auditing event.

power-iaas.storage-capacity.read

Request

Response

200 - OK

maximumStorageAllocation

object

Maximum storage allocation

storagePoolsCapacity

array

List of storage pool capacity for storage type

storageType

error

string

List all supported storage tiers for this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/storage-tiers

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.storage-tier.read

Auditing

Calling this method generates the following auditing event.

power-iaas.service-broker.read

Request

Response

200 - OK

Get all volume groups

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.list

Request

Response

200 - OK

volumeGroups

error

string

Create a new volume group

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-group.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.post

Request

Request Body

VolumeGroupCreate

Parameters for the creation of a new volume group

consistencyGroupName

string

The name of consistencyGroup at storage controller level. This is required to onboard existing volume group on the target site for DR set up; name and consistencyGroupName are mutually exclusive.

name

string

The name of the volume group. This field is required for creation of new volume group; name and consistencyGroupName are mutually exclusive.

volumeIDs

Required *

array

List of volume IDs,members of VolumeGroup

Response

202 - Accepted

id

string

The ID of the volume group

name

string

The name of the volume group

status

string

Status of the volume group

statusDetail

string

Status details of the volume group

206 - Partial Content

id

string

The ID of the volume group

name

string

The name of the volume group

status

string

Status of the volume group

statusDetail

error

string

Get all volume groups with details

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/details

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.list

Request

Response

200 - OK

volumeGroups

error

string

Delete a cloud instance volume group

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-group.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.delete

Request

Response

202 - Accepted

Get volume Group

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.read

Request

Response

Status details of the volume group

storagePool

error

string

updates the volume group

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.update

Request

Request Body

VolumeGroupUpdate

Parameters for updating a volume-group

addVolumes

array

List of volume IDs to add to the volume-group

removeVolumes

array

List of volume IDs to remove from the volume-group

Response

202 - Accepted

power-iaas.cloud-instance.modify
power-iaas.volume-group.action

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.start
power-iaas.volume-group.stop
power-iaas.volume-group.reset
power-iaas.volume-group.unknown

Request

Request Body

VolumeGroupAction

Parameters for the desire action.

reset

VolumeGroupActionReset

Performs reset action on the volume group to update its status value

status

Required *

string

New status to be set for a volume group

start

VolumeGroupActionStart

Performs start action on a volume group

source

Required *

string

Indicates the source of the action

stop

VolumeGroupActionStop

Performs stop action on a volume group

access

Required *

boolean

Indicates the access mode of aux volumes

Response

202 - Accepted

Get volume Group details

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/details

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.read

Request

Response

error

string

Get remote copy relationships of the volume belonging to volume group

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/remote-copy-relationships

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-group-remote-copy.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.read

Request

Response

200 - OK

id

string

The ID of the volume group

remoteCopyRelationships

error

string

Get storage details of volume group

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/storage-details

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-group-storage.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-group.read

Request

Response

Indicates the relationship state

sync

error

string

List all volumes for this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance-volume.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.list

Request

Path Parameters

Query Parameters

replicationEnabled

boolean

true or false, limits a volumes list to replication or non replication enabled volumes

affinity

string

A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance

auxiliary

boolean

true or false, limits a volume list to auxiliary or non auxiliary volumes

Response

200 - OK

volumes

error

string

Create a new data Volume

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-volume.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.create

string

Volume Name

replicationEnabled

boolean

Indicates if the volume should be replication enabled or not.

shareable

boolean

Indicates if the volume is shareable between VMs

size

Required *

number

Volume Size (GiB)

userTags

object

List of user tags

volumePool

string

Volume pool where the volume will be created; if provided then affinityPolicy value will be ignored

Response

Volume type, name of storage template used to create the volume

wwn

error

string

Create a volume clone for specified volumes

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/clone

This API is deprecated, use v2 clone API to perform the volume clone.

>Note: Support for this API will be available till 31st March 2023.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Request Body

VolumesCloneRequest

Parameters for the cloning of volumes

displayName

Required *

string

Display name for the new cloned volumes. Cloned Volume names will be prefixed with 'clone-'. If multiple volumes cloned they will be suffix with a '-' and an incremental number starting with 1. Example volume names using displayName="volume-abcdef" single volume clone will be named "clone-volume-abcdef" multi volume clone will be named "clone-volume-abcdef-1", "clone-volume-abcdef-2", ... For multiple volume clone, the provided name will be truncated to the first 20 characters.

volumeIDs

Required *

array

List of volumes to be cloned

Response

200 - OK

additionalProperties

string

ID of the new cloned volume

clonedVolumes

error

string

List all volume onboardings for this cloud instance

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-onboarding.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-onboarding.list

Request

Response

200 - OK

onboardings

error

string

Onboard auxiliary volumes to target site

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-onboarding.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-onboarding.create

Request

Request Body

VolumeOnboardingCreate

Parameters for the creation of volume onboarding

Volumes

Required *

array

description

string

Description of the volume onboarding operation

userTags

object

List of user tags

Response

202 - Accepted

description

string

Description of the volume onboarding operation

id

error

string

Get the information of volume onboarding operation

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding/{volume_onboarding_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-onboarding.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-onboarding.read

Request

Response

string

Delete a cloud instance volume

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-volume.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.delete

Request

Response

200 - OK

Detailed info of a volume

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.cloud-instance-volume.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.read

Request

Response

Volume type, name of storage template used to create the volume

wwn

error

string

Update a cloud instance volume

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-volume.update

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.update

Request

Request Body

UpdateVolume

Parameters to update a cloud instance volume

bootable

boolean

Indicates if the volume is boot capable

name

string

Name

shareable

boolean

Indicates if the volume is shareable between VMs

size

number

New Volume size

Response

Volume type, name of storage template used to create the volume

wwn

error

string

Perform an action on a Volume

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/action

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-volume.action

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.operation

Request

Request Body

VolumeAction

Parameters for the desired action

replicationEnabled

boolean

Indicates if the volume should be replication enabled or not

targetStorageTier

string

Target storage tier; used to change a volume's storage tier

Response

202 - Accepted

Get a list of flashcopy mappings of a given volume

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/flash-copy-mappings

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-flash-copy.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.read

Request

Response

200 - OK

Get remote copy relationship of a volume

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/remote-copy

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-remote-copy.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.read

Request

Response

error

string

Get all IKE Policies

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ike-policies

List all IKE Policies with all attributes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.vpn-connection-ike-policy.read

Auditing

Calling this method generates the following auditing event.

power-iaas.ike-policy.read

Request

Response

200 - OK

ikePolicies

error

string

Add IKE Policy

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ike-policies

Add a new IKE Policy

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-ike-policy.create

Auditing

Calling this method generates the following auditing event.

power-iaas.ike-policy.create

Request

Request Body

IKEPolicyCreate

Parameters for the creation of a new IKE Policy

Required *

integer

version of the IKE Policy

Response

name of the IKE Policy

version

error

string

Delete IKE Policy

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ike-policies/{ike_policy_id}

Delete an IKE Policy (by its unique identifier)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-ike-policy.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.ike-policy.delete

Request

Response

200 - OK

power-iaas.cloud-instance.read
power-iaas.vpn-connection-ike-policy.list

Auditing

Calling this method generates the following auditing event.

power-iaas.ike-policy.list

Request

Response

name of the IKE Policy

version

error

string

Update IKE Policy

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ike-policies/{ike_policy_id}

update an IKE Policy (by its unique identifier)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-ike-policy.update

Auditing

Calling this method generates the following auditing event.

power-iaas.ike-policy.update

version of the IKE Policy

Response

name of the IKE Policy

version

error

string

Get all IPSec Policies

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ipsec-policies

Get all IPSec Policies with all their attributes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.vpn-connection-ipsec-policy.list

Auditing

Calling this method generates the following auditing event.

power-iaas.ipsec-policy.list

Request

Response

200 - OK

ipSecPolicies

error

string

Add IPSec Policy

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ipsec-policies

Add a new IPSec Policy

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-ipsec-policy.create

Auditing

Calling this method generates the following auditing event.

power-iaas.ipsec-policy.create

Request

Request Body

IPSecPolicyCreate

Parameters for the creation of a new IPSec Policy

IPSec Policy name

pfs

error

string

Delete IPSec Policy

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ipsec-policies/{ipsec_policy_id}

Delete an IPSec Policy (by its unique identifier)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-ipsec-policy.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.ipsec-policy.delete

Request

Response

200 - OK

power-iaas.cloud-instance.read
power-iaas.vpn-connection-ipsec-policy.read

Auditing

Calling this method generates the following auditing event.

power-iaas.ipsec-policy.read

Request

Response

IPSec Policy name

pfs

error

string

Update IPSec Policy

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ipsec-policies/{ipsec_policy_id}

update an IPSec Policy

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-ipsec-policy.update

Auditing

Calling this method generates the following auditing event.

power-iaas.ipsec-policy.update

IPSec Policy name

pfs

boolean

Perfect Forward Secrecy

Response

IPSec Policy name

pfs

error

string

Get all VPN Connections

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections

Get all VPN Connections

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.vpn-connection.list

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.list

Request

Response

200 - OK

vpnConnections

error

string

Create VPN Connection

POST /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections

Create a new VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection.create

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.create

Response

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.delete

Request

Response

202 - Accepted

href

string

Link to job resource

id

error

string

Get VPN Connection

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}

Get a VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.vpn-connection.read

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.read

Request

Response

error

string

Update VPN Connection

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}

update a VPN Connection (by its identifier)

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection.update

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.update

Request

Request Body

VPNConnectionUpdate

VPN Connection object used for update

ikePolicy

string

unique identifier of IKEPolicy selected for this VPNConnection

ipSecPolicy

string

unique identifier of IPSecPolicy selected for this VPNConnection

name

string

VPN Connection name

peerGatewayAddress

string

IP address of the Peer Gateway attached to this VPNConnection

Response

error

string

Detach network

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks

Detach network from a specific VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-network.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.delete

Request

Request Body

NetworkID

network to detach

networkID

Required *

string

Response

202 - Accepted

href

string

Link to job resource

id

error

string

Get attached networks

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks

Get a list of network IDs attached to a VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.vpn-connection-network.read

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.read

Request

Response

200 - OK

networkIDs

error

string

Attach network

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks

Attach a network to a VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-network.update

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.update

Request

Request Body

NetworkID

network to attach

networkID

Required *

string

Response

202 - Accepted

href

string

Link to job resource

id

error

string

Detach Peer Subnet

DELETE /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets

Detach peer subnet from a VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-peer-subnet.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.delete

Request

Request Body

PeerSubnetUpdate

Peer subnet to detach

cidr

Required *

string

Response

200 - OK

peerSubnets

error

string

Get Peer Subnets

GET /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets

Get a list of peer subnets attached to a specific VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.vpn-connection-peer-subnet.read

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.read

Request

Response

200 - OK

peerSubnets

error

string

Attach Peer Subnet

PUT /pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets

Attach peer subnet to a VPN Connection

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.vpn-connection-peer-subnet.update

Auditing

Calling this method generates the following auditing event.

power-iaas.vpn-connection.update

Request

Request Body

PeerSubnetUpdate

peer subnet to attach

cidr

Required *

string

Response

200 - OK

peerSubnets

error

string

List all the images in the image-catalog

GET /pcloud/v1/images

This API is deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images.

>Note: Support for this API will be available till 31st March 2023.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.image.list

Auditing

Calling this method generates the following auditing event.

power-iaas.image.list

Request

Response

200 - OK

images

error

string

Detailed info of an image in the image-catalog

GET /pcloud/v1/images/{image_id}

This API is deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id}.

>Note: Support for this API will be available till 31st March 2023.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.image.read

Auditing

Calling this method generates the following auditing event.

power-iaas.image.read

Request

Response

state

string

Image State

storagePool

string

Storage pool where the image resides

storageType

string

Storage type for image

taskref

object

userTags

object

List of user tags

volumes

error

string

Get all disaster recovery locations supported by Power Virtual Server

GET /pcloud/v1/locations/disaster-recovery

Auditing

Calling this method generates the following auditing event.

power-iaas.disaster-recovery.read

Request

Response

200 - OK

disasterRecoveryLocations

error

string

Delete a Task

DELETE /pcloud/v1/tasks/{task_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.task.delete

Request

Response

200 - OK

Get a Task

GET /pcloud/v1/tasks/{task_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.task.read

Request

Response

status detail of the task

taskID

error

string

Get a Tenant's current state/information

GET /pcloud/v1/tenants/{tenant_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.tenant.read

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant.read

Request

Response

Tenant SSH Keys

tenantID

error

string

Update a tenant

PUT /pcloud/v1/tenants/{tenant_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.tenant.update

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant.update

Request

Request Body

TenantUpdate

Parameters for updating a Tenant

icn

string

IBM Customer Number

peeringNetworks

array

Peering Network Information (optional)

Response

Tenant SSH Keys

tenantID

error

string

List a Tenant's SSH Keys

GET /pcloud/v1/tenants/{tenant_id}/sshkeys

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.tenant-sshkey.list

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant-sshkey.list

Request

Response

200 - OK

sshKeys

error

string

Add a new SSH key to the Tenant

POST /pcloud/v1/tenants/{tenant_id}/sshkeys

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.tenant-sshkey.create

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant-sshkey.create

Request

Request Body

SSHKey

Parameters for the creation of a new SSH key

200 - OK

creationDate

string

Date of sshkey creation

name

string

User defined name for the SSH key

sshKey

string

SSH RSA key

201 - Created

creationDate

string

Date of sshkey creation

name

string

User defined name for the SSH key

sshKey

error

string

Delete a Tenant's SSH key

DELETE /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.tenant-sshkey.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant-sshkey.delete

Request

Response

200 - OK

Get a Tenant's SSH Key by name

GET /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.tenant-sshkey.read

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant-sshkey.read

Request

Response

200 - OK

creationDate

string

Date of sshkey creation

name

string

User defined name for the SSH key

sshKey

error

string

Update an SSH Key

PUT /pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.tenant-sshkey.update

Auditing

Calling this method generates the following auditing event.

power-iaas.tenant-sshkey.update

Request

Request Body

SSHKey

Parameters for updating a Tenant's SSH Key

200 - OK

creationDate

string

Date of sshkey creation

name

string

User defined name for the SSH key

sshKey

error

string

Get detail of last image export job

GET /pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.image-export.read

Auditing

Calling this method generates the following auditing event.

power-iaas.job.read

Request

Response

200 - OK

createTimestamp

string

string

error

string

Add image export job to the jobs queue

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.image-export.create

Auditing

Calling this method generates the following auditing event.

power-iaas.image.export

Request

Request Body

ExportImage

Parameters for the export

accessKey

Required *

string

Cloud Object Storage Access key

bucketName

Required *

string

Cloud Object Storage Bucket name

region

string

Cloud Object Storage Region; required for IBM COS

secretKey

string

Cloud Object Storage Secret key

Response

202 - Accepted, image export successfully added to the jobs queue

href

string

Link to job resource

id

error

string

Get all the pvm instances for this cloud instance

GET /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance.list

Auditing

Calling this method generates the following auditing event.

power-iaas.pvm-instance.list

Request

Response

200 - OK

pvmInstances

error

string

Get detail of last capture job

GET /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.pvm-instance-capture.read

Auditing

Calling this method generates the following auditing event.

power-iaas.job.read

Request

Response

200 - OK

createTimestamp

string

string

error

string

Add a capture pvm-instance to the jobs queue

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-capture.create

Auditing

Calling this method generates the following auditing event.

power-iaas.job.create

Request

Request Body

PVMInstanceCapture

Parameters for the capture

captureDestination

Required *

string

Destination for the deployable image

captureName

Required *

object

List of user tags

Response

202 - Accepted, pvm-instance capture successfully added to the jobs queue

href

string

Link to job resource

id

error

string

Detach multiple volumes from a PVMInstance

DELETE /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-volume.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.configure

Request

Request Body

volumesDetach

Parameter to detach multiple volumes from a PVMInstance

detachAllVolumes

boolean

Indicates if all volumes, except primary boot volume, attached to the PVMInstance should be detached (default=false); required if volumeIDs is not provided

detachPrimaryBootVolume

boolean

Indicates if primary boot volume attached to the PVMInstance should be detached (default=false)

volumeIDs

array

List of volumes to be detached from a PVM instance; required if detachAllVolumes is not provided

Response

202 - Accepted

summary

error

string

Attach all volumes to a PVMInstance

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes

Attach all volumes to a PVMInstance. >Note: In the case of VMRM, if a single volume ID is provided in the 'volumeIDs' field, that volume will be converted to a bootable volume and then attached.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.pvm-instance-volume.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.configure

Request

Request Body

volumesAttach

Parameter to attach volumes to a PVMInstance

DELETE /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-volume.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.delete

Request

Request Body

VolumesDelete

Parameters to delete volumes

volumeIDs

Required *

array

List of volumes to be deleted

Response

202 - Accepted

summary

string

status summary for volumes deletion request

206 - Partial Content

summary

error

string

Create multiple data volumes from a single definition

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance-volume.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.create

Request

Request Body

MultiVolumesCreate

Parameters for creating multiple volumes

affinityPVMInstance

string

PVM Instance (ID or Name)to base volume affinity policy against; required if requesting affinity and affinityVolume is not provided

Required *

string

Base name of the volume(s)

replicationEnabled

boolean

Indicates if the volume should be replication enabled or not.

shareable

boolean

Indicates if the volume is shareable between VMs

size

Required *

integer

Volume Size (GiB)

userTags

object

List of user tags

volumePool

string

Volume pool where the volume will be created; if provided then affinityPolicy value will be ignored

Response

201 - Created

volumes

error

string

Get the list of volumes-clone request for a cloud instance

GET /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-clone.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.list

Request

Path Parameters

Query Parameters

filter

string

volumes-clone filter to limit list items: prepare - includes status values (preparing, prepared) start - includes status values (starting, available) execute - includes status values (executing, available-rollback) cancel - includes status values (cancelling) completed - includes status values (completed) failed - includes status values (failed) cancelled - includes status values (cancelled) finalized - included status values (completed, failed, cancelled)

Response

200 - OK

volumesClone

error

string

Create a new volumes clone request and initiates the Prepare action

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone

Requires a minimum of two volumes. Requires a minimum of one volume to be in the `in-use` state. Requires a unique volumes clone name. Prepare action does the preparatory work for creating the snapshot volumes. >Note: If there is an existing prepare, user cannot trigger another prepare for the same set of volumes. Prepare should be followed by start and execute. If existing prepare does not have to be used then it should be first cancelled before the next prepare operation.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Request Body

VolumesCloneCreate

Parameters for preparing a set of volumes to be cloned

name

Required *

string

Unique name within a cloud instance used to identify a volumes-clone request name can be used in replace of a volumesCloneID when used as a URL path parameter

volumeIDs

Required *

array

List of volumes to be cloned

Response

error

string

Delete a volumes-clone request

DELETE /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Response

200 - OK

Get the details for a volumes-clone request

GET /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-clone.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Response

Current status of the volumes-clone request

volumesCloneID

error

string

Cancel a volumes-clone request

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/cancel

Initiates the cleanup action that performs the cleanup of the preparatory clones and snapshot volumes.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.cancel

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Request Body

VolumesCloneCancel

Parameters for cancelling a volumes-clone request

force

boolean

default False, Cancel will only be allowed if the status is 'prepared', or 'available' True, Cancel will be allowed when the status is NOT completed, cancelling, cancelled, or failed

Response

error

string

Initiate the Execute action for a volumes-clone request

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/execute

Execute action creates the cloned volumes using the volume snapshots.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.execute

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Request Body

VolumesCloneExecute

Parameters for the cloning of volumes

name

Required *

string

Base name of the new cloned volume(s). Cloned Volume names will be prefixed with 'clone-' and suffixed with '-#####' (where ##### is a 5 digit random number) If multiple volumes cloned they will be further suffixed with an incremental number starting with 1. Example volume names using name="volume-abcdef" single volume clone will be named "clone-volume-abcdef-83081" multi volume clone will be named "clone-volume-abcdef-73721-1", "clone-volume-abcdef-73721-2", ... For multiple volume clone, the provided name will be truncated to the first 20 characters.

rollbackPrepare

boolean

default False, Execute failure rolls back clone activity but leaves prepared snapshot True, Execute failure rolls back clone activity and removes the prepared snapshot

targetReplicationEnabled

boolean

Cloned volume will be non replication enabled if it is set to false. By default, the replication property of the source volume will be used to determine the replication property of the cloned target volume.

targetStorageTier

string

Target storage tier for the cloned volumes. Use to clone a set of volumes from one storage tier to a different storage tier. Cloned volumes must remain in the same storage pool as the source volumes.

userTags

object

List of user tags

Response

error

string

Initiate the Start action for a volumes-clone request

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/start

Start action starts the consistency group to initiate the flash copy.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.start

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.start

Request

Response

error

string

Create a volume clone for specified volumes

POST /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.volume-clone.create

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Request Body

VolumesCloneAsyncRequest

Parameters for the cloning of volumes

name

Required *

string

targetReplicationEnabled

boolean

targetStorageTier

string

Target storage tier for the cloned volumes. Use to clone a set of volumes from one storage tier to a different storage tier. Cloned volumes must remain in the same storage pool as the source volumes.

userTags

object

List of user tags

volumeIDs

Required *

array

List of volumes to be cloned

Response

202 - Accepted

cloneTaskID

string

ID of a long running clone task

href

error

string

Get the status of a volumes clone request for the specified clone task ID

GET /pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone-tasks/{clone_task_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-clone.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume.clone

Request

Response

200 - OK

clonedVolumes

array

List of cloned volumes created from the clone volumes task

failedReason

string

The reason the clone volumes task has failed

percentComplete

integer

Snapshot completion percentage

status

error

string

List all the hosts that can be reserved

GET /v1/available-hosts

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.available-hosts.list

Auditing

Calling this method generates the following auditing event.

power-iaas.available-hosts.list

Request

Response

200 - OK

Get all Datacenters information and capabilities

GET /v1/datacenters

Auditing

Calling this method generates the following auditing event.

power-iaas.datacenter.list

Request

Response

200 - OK

datacenters

error

string

Get private Datacenter information and capabilities

GET /v1/datacenters/private

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.datacenter-private.list

Auditing

Calling this method generates the following auditing event.

power-iaas.datacenter-private.list

Request

Response

200 - OK

datacenters

error

string

Get a private Datacenter's information and capabilities

GET /v1/datacenters/private/{datacenter_region}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.datacenter-private.read

Auditing

Calling this method generates the following auditing event.

power-iaas.datacenter-private.read

Request

Response

error

string

Get a Datacenter's information and capabilities

GET /v1/datacenters/{datacenter_region}

Auditing

Calling this method generates the following auditing event.

power-iaas.datacenter.read

Request

Response

error

string

Get the list of host groups for the workspace

GET /v1/host-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.host-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.host-group.list

Request

Response

200 - OK

Create a host group with one (or more) host

POST /v1/host-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.host-group.create

Auditing

Calling this method generates the following auditing event.

power-iaas.host-group.create

Request

Request Body

HostGroupCreate

Parameters for the creation of a new host group

hosts

Required *

array

List of hosts to add to the host group

name

Required *

string

Name of the host group to create

secondaries

array

List of workspaces to share the host group with (optional)

Response

error

string

Get the details of a host group

GET /v1/host-groups/{host_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.host-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.host-group.read

Request

Response

error

string

Share/unshare a host group with another workspace

PUT /v1/host-groups/{host_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.host-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.host-group.update

Request

Request Body

HostGroupShareOp

Parameters to set the sharing status of the host group

add

array

List of workspaces to share the host group with

remove

string

A workspace ID to stop sharing the host group with

Response

error

string

Get the list of all the hosts the workspace has access to

GET /v1/hosts

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.host.list

Auditing

Calling this method generates the following auditing event.

power-iaas.host.list

Request

Response

200 - OK

Add new host(s) to an existing host group

POST /v1/hosts

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.host.create

Auditing

Calling this method generates the following auditing event.

power-iaas.host-group.update

Request

Request Body

HostCreate

Parameters to add a host to an existing host group

hostGroupID

Required *

string

ID of the host group to which the host should be added

hosts

Required *

array

Hosts to be added

Response

201 - Created

Release a host from its host group

DELETE /v1/hosts/{host_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.host.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.host-group.delete
power-iaas.host.delete

Request

Response

202 - Accepted

Get the details about a host

GET /v1/hosts/{host_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.host.read

Auditing

Calling this method generates the following auditing event.

power-iaas.host.read

Request

Response

200 - OK

error

string

Modify the display name of a host

PUT /v1/hosts/{host_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.host.update

Auditing

Calling this method generates the following auditing event.

power-iaas.host.update

Request

Request Body

HostPut

Parameters to modify a host

displayName

Required *

string

Name of the host chosen by the user

Response

200 - OK

error

string

Get the list of Network Address Groups for a workspace

GET /v1/network-address-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-address-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.list

Request

Response

200 - OK

networkAddressGroups

error

string

Create a new Network Address Group

POST /v1/network-address-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-address-group.create

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.create

Request

Request Body

NetworkAddressGroupCreate

Parameters for the creation of a Network Address Group

name

Required *

string

The name of the Network Address Group

userTags

object

List of user tags

Response

200 - OK

The Network Address Group's crn

id

string

The id of the Network Address Group

members

array

The list of IP addresses in CIDR notation (for example 192.168.66.2/32) in the Network Address Group

name

string

The name of the Network Address Group

userTags

error

string

Delete a Network Address Group from a workspace

DELETE /v1/network-address-groups/{network_address_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-address-group.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.delete

Request

Response

200 - OK

Get the detail of a Network Address Group

GET /v1/network-address-groups/{network_address_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-address-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.read

Request

Response

200 - OK

error

string

Update a Network Address Group

PUT /v1/network-address-groups/{network_address_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-address-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.update

Request

Request Body

NetworkAddressGroupUpdate

Parameters for the update of a Network Address Group

name

string

Replaces the current Network Address Group Name

Response

200 - OK

error

string

Add a member to a Network Address Group

POST /v1/network-address-groups/{network_address_group_id}/members

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-address-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.update

Request

Request Body

NetworkAddressGroupAddMember

Parameters for adding a member to a Network Address Group

cidr

Required *

string

The member to add in CIDR format

Response

200 - OK

cidr

string

The IP addresses in CIDR notation for example 192.168.1.5/32

id

error

string

Delete the member from a Network Address Group

DELETE /v1/network-address-groups/{network_address_group_id}/members/{network_address_group_member_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-address-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-address-group.update

Request

Response

200 - OK

Get the list of Network Peers

GET /v1/network-peers

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-peer.list

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer.list

Request

Response

200 - OK

networkPeers

error

string

Create a new Network Peer

POST /v1/network-peers

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-peer.create

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer.create

Request

Request Body

integer

A vlan configured at the customer network.

Response

200 - OK

creationDate

string

time stamp for create network peer

customerASN

integer

ASN number at customer network side

customerCidr

string

IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.

defaultExportRouteFilter

string

default action for export route filter

allow: allow
deny: deny

defaultImportRouteFilter

string

default action for import route filter

allow: allow
deny: deny

dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network

updatedDate

string

time stamp for update network peer

vlan

error

string

Get the list of Interfaces for Network Peer

GET /v1/network-peers/interfaces

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.peer-interfaces.list

Auditing

Calling this method generates the following auditing event.

power-iaas.peer-interfaces.list

Request

Response

200 - OK

Delete a Network Peer

DELETE /v1/network-peers/{network_peer_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-peer.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer.delete

Request

Response

200 - OK

Get the details of a Network Peer

GET /v1/network-peers/{network_peer_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-peer.read

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer.read

Request

Response

200 - OK

creationDate

string

time stamp for create network peer

customerASN

integer

ASN number at customer network side

customerCidr

string

IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.

defaultExportRouteFilter

string

default action for export route filter

allow: allow
deny: deny

defaultImportRouteFilter

string

default action for import route filter

allow: allow
deny: deny

dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network

updatedDate

string

time stamp for update network peer

vlan

error

string

Update a Network Peer

PUT /v1/network-peers/{network_peer_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-peer.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer.update

Request

Request Body

NetworkPeerUpdate

network peer update parameters

customerASN

integer

ASN number at customer network side

customerCidr

string

IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.

defaultExportRouteFilter

string

default action for export route filter

allow: allow
deny: deny

defaultImportRouteFilter

string

default action for import route filter

allow: allow
deny: deny

ibmASN

integer

ASN number at IBM PowerVS side

ibmCidr

string

IP address used for configuring IBM network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.

name

string

user defined name

peerInterfaceID

string

peer interface id. use API '/v1/network-peers/interfaces' to get a list of valid peer interface id

type

string

type of the peer network

dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network

vlan

integer

A vlan configured at the customer network.

Response

200 - OK

creationDate

string

time stamp for create network peer

customerASN

integer

ASN number at customer network side

customerCidr

string

IP address used for configuring customer network interface with network subnet mask. customerCidr and ibmCidr must have matching network and subnet mask values.

defaultExportRouteFilter

string

default action for export route filter

allow: allow
deny: deny

defaultImportRouteFilter

string

default action for import route filter

allow: allow
deny: deny

dcnetwork_bgp: broader gateway protocol is used to share routes between two autonomous network

updatedDate

string

time stamp for update network peer

vlan

error

string

Create a new Route Filter

POST /v1/network-peers/{network_peer_id}/route-filters

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-peer-route-filter.create

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer-route-filter.create

Request

Request Body

RouteFilterCreate

route filter create parameters.

GE

integer

The minimum matching length of the prefix-set(1 ≤ value ≤ 32 & value ≤ LE)

LE

integer

The maximum matching length of the prefix-set( 1 ≤ value ≤ 32 & value >= GE)

action

string

action of the filter

allow: allow
deny: deny

direction

Required *

string

direction of the filter

import - import the routes
export - export the routes

index

Required *

integer

priority or order of the filter

prefix

Required *

string

IP prefix representing an address and mask length of the prefix-set

Response

200 - OK

GE

error

string

Delete a Route Filter

DELETE /v1/network-peers/{network_peer_id}/route-filters/{route_filter_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-peer-route-filter.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer-route-filter.delete

Request

Response

200 - OK

Get the details of a Route Filter

GET /v1/network-peers/{network_peer_id}/route-filters/{route_filter_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-peer-route-filter.read

Auditing

Calling this method generates the following auditing event.

power-iaas.network-peer-route-filter.read

Request

Response

200 - OK

GE

error

string

Get the list of Network Security Groups for a workspace

GET /v1/network-security-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-security-group.list

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.list

Request

Path Parameters

Query Parameters

default_nsg

boolean

Response

200 - OK

networkSecurityGroups

error

string

Create a new Network Security Group

POST /v1/network-security-groups

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.create

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.create

Request

Request Body

NetworkSecurityGroupCreate

Parameters for the creation of a Network Security Group

name

Required *

string

The name of the Network Security Group

userTags

object

List of user tags

Response

The list of rules in the Network Security Group

userTags

object

List of user tags

201 - Created

crn

string

The Network Security Group's crn

default

boolean

Indicates if the Network Security Group is the default Network Security Group in the workspace

id

string

The ID of the Network Security Group

members

array

The list of IPv4 addresses and\or Network Interfaces in the Network Security Group

name

string

The name of the Network Security Group

rules

array

The list of rules in the Network Security Group

userTags

error

string

Perform a Network Security Groups action (enable, disable) on a workspace. On enablement, a default Network Security Group is created to allow all traffic for all active network iterfaces

POST /v1/network-security-groups/action

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.enable

Auditing

Calling this method generates the following auditing event.

power-iaas.workspace.enable
power-iaas.workspace.disable
power-iaas.workspace.unknown

Request

Request Body

NetworkSecurityGroupsAction

Parameters for the desired action

action

Required *

string

Name of the action to take; can be enable to enable NSGs in a workspace or disable to disable NSGs in a workspace

Response

200 - OK

202 - Accepted

Delete a Network Security Group from a workspace

DELETE /v1/network-security-groups/{network_security_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.delete

Request

Response

200 - OK

Get the detail of a Network Security Group

GET /v1/network-security-groups/{network_security_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-security-group.read

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.read

Request

Response

The list of rules in the Network Security Group

userTags

error

string

Clone a Network Security Group

POST /v1/network-security-groups/{network_security_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.clone

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.clone

Request

Request Body

NetworkSecurityGroupClone

Parameters for the clone of a Network Security Group

name

Required *

string

The name of the cloned network security group

Response

The list of rules in the Network Security Group

userTags

error

string

Update a Network Security Group

PUT /v1/network-security-groups/{network_security_group_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.update

Request

Request Body

NetworkSecurityGroupUpdate

Parameters for the update of a Network Security Group

name

string

Replaces the current Network Security Group Name

Response

The list of rules in the Network Security Group

userTags

error

string

Add a member to a Network Security Group

POST /v1/network-security-groups/{network_security_group_id}/members

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.update

Request

Request Body

NetworkSecurityGroupAddMember

Parameters for adding a member to a Network Security Group

target

Required *

string

The target member to add. An IP4 address if ipv4-address type or a network interface ID if network-interface type

type

Required *

string

The type of member

Response

200 - OK

error

string

Delete the member from a Network Security Group

DELETE /v1/network-security-groups/{network_security_group_id}/members/{network_security_group_member_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.update

Auditing

Calling this method generates the following auditing event.

Request

Response

200 - OK

Move a Network Security Group member to another Network Security Group

POST /v1/network-security-groups/{network_security_group_id}/move_member

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.update

Request

Request Body

NetworkSecurityGroupMoveMember

Parameters for moving a Network Security Group member to another Network Security Group

MemberID

Required *

string

The member to move

NetworkSecurityGroupId

Required *

string

The ID of the Network Security Group the member will be moved to

Response

200 - OK

error

string

Add a rule to a Network Security Group

POST /v1/network-security-groups/{network_security_group_id}/rules

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-address-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.update

Request

Request Body

NetworkSecurityGroupAddRule

Parameters for adding a rule to a Network Security Group

action

Response

200 - OK

action

string

The action to take if the rule matches network traffic

destinationPort

NetworkSecurityGroupRulePort

id

string

The ID of the rule in a Network Security Group

protocol

Delete the rule from a Network Security Group

DELETE /v1/network-security-groups/{network_security_group_id}/rules/{network_security_group_rule_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-security-group.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-security-group.update

Request

Response

200 - OK

Get all Network Interfaces for this network

GET /v1/networks/{network_id}/network-interfaces

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-interfaces.list

Auditing

Calling this method generates the following auditing event.

power-iaas.network-interfaces.list

Request

Response

200 - OK

interfaces

error

string

Create a Network Interface

POST /v1/networks/{network_id}/network-interfaces

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-interfaces.create

Auditing

Calling this method generates the following auditing event.

power-iaas.network-interfaces.create

Request

Request Body

NetworkInterfaceCreate

Create a Network Interface

ipAddress

string

The requested IP address of this Network Interface

name

string

Name of the Network Interface

userTags

object

List of user tags

Response

The status of the network address group

userTags

error

string

Delete a Network Interface

DELETE /v1/networks/{network_id}/network-interfaces/{network_interface_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-interfaces.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.network-interfaces.delete

Request

Response

200 - OK

Get a Network Interface's information

GET /v1/networks/{network_id}/network-interfaces/{network_interface_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.network-interfaces.read

Auditing

Calling this method generates the following auditing event.

power-iaas.network-interfaces.read

Request

Response

The status of the network address group

userTags

error

string

Update a Network Interface's information

PUT /v1/networks/{network_id}/network-interfaces/{network_interface_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.network-interfaces.update

Auditing

Calling this method generates the following auditing event.

power-iaas.network-interfaces.update

Request

Request Body

NetworkInterfaceUpdate

Parameters for updating a Network Interface

instanceID

string

If supplied populated it attaches to the InstanceID, if empty detaches from InstanceID

name

string

Name of the Network Interface

Response

The status of the network address group

userTags

error

string

Get all routes in the workspace

GET /v1/routes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.route.list

Auditing

Calling this method generates the following auditing event.

power-iaas.route.list

Request

Response

200 - OK

routes

error

string

Perform a route creation

POST /v1/routes

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.route.create

Auditing

Calling this method generates the following auditing event.

power-iaas.route.create

Request

Request Body

RouteCreate

Create a route based on the inputs

action

string

Action

error

string

Get the route report for a workspace

GET /v1/routes/report

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.route.list

Auditing

Calling this method generates the following auditing event.

power-iaas.route.list

Request

Response

200 - OK

routes

error

string

Delete a route

DELETE /v1/routes/{route_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.route.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.route.delete

Request

Response

200 - OK

Get a route's information

GET /v1/routes/{route_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.route.read

Auditing

Calling this method generates the following auditing event.

power-iaas.route.read

Request

Response

error

string

Update a route's information

PUT /v1/routes/{route_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.route.update

Auditing

Calling this method generates the following auditing event.

power-iaas.route.update

The next hop

nextHopType

string

The next hop type

Response

error

string

Atomically enable one network route and disable another route in the same region and in the same account. This is useful for failover situations where users only need to call this API instead of two separate PUT API calls to enable and disable the routes.

POST /v1/routes/{route_id}/switch-enabled

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.route.update

Auditing

Calling this method generates the following auditing event.

power-iaas.route.update

Request

Request Body

RouteSwitchEnabledRequest

Parameters to atomically enable one route and disable another in the same region and in the same account

disabledRouteCRN

Required *

string

CRN of the route to disable

Response

200 - OK

disabledRoute

object

The route that was disabled (route-B); state will be "updating" immediately after the request, poll GET /v1/routes/{id} for final state

enabledRoute

error

string

Get a list of all the snapshots on a workspace

GET /v1/snapshots

This API is deprecated for /v1/snapshots. The API v1/volume-snapshots has replaced this endpoint.

View the usage of snapshots on the workspace. The snapshots may take time sync because the data is cached.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.snapshot.list

Auditing

Calling this method generates the following auditing event.

power-iaas.snapshot.list

Request

Response

200 - OK

snapshots

error

string

Get the detail of a snapshot

GET /v1/snapshots/{snapshot_id}

This API is deprecated for /v1/snapshots. The API v1/volume-snapshots has replaced this endpoint.

View the usage of a snapshot. The snapshot may take time sync because the data is cached.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.snapshot.read

Auditing

Calling this method generates the following auditing event.

power-iaas.snapshot.read

Request

Response

The date and time when the volume snapshot was last updated.

volumeID

error

string

List SSH Keys

GET /v1/ssh-keys

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.sshkey.list

Auditing

Calling this method generates the following auditing event.

power-iaas.sshkey.list

Request

Response

200 - OK

sshKeys

error

string

Add a new SSH key

POST /v1/ssh-keys

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.sshkey.create

Auditing

Calling this method generates the following auditing event.

power-iaas.sshkey.create

Request

Request Body

CreateWorkspaceSSHKey

Parameters for the creation of a new SSH key

string

Visibility of the sshkey; workspace suggests ssh-key is only accessible in a workspace, account suggests ssh-key is accessible throughout an account

Response

SSH RSA key

visibility

error

string

Delete ssh-key

DELETE /v1/ssh-keys/{sshkey_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.sshkey.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.sshkey.delete

Request

Response

200 - OK

Get ssh-key information

GET /v1/ssh-keys/{sshkey_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.sshkey.read

Auditing

Calling this method generates the following auditing event.

power-iaas.sshkey.read

Request

Response

SSH RSA key

visibility

error

string

Update the ssh key

PUT /v1/ssh-keys/{sshkey_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.sshkey.update

Auditing

Calling this method generates the following auditing event.

power-iaas.sshkey.update

Request

Request Body

UpdateWorkspaceSSHKey

Parameter for updating SSH key

description

string

Description of the sshkey

name

string

User defined name for the SSH key

sshKey

string

SSH RSA key

visibility

string

Visibility of the sshkey; workspace suggests ssh-key is only accessible in a workspace, account suggests ssh-key is accessible throughout an account

Response

SSH RSA key

visibility

error

string

List all utilized and retained VSNs

GET /v1/virtual-serial-number

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.virtual-serial-number.list

Auditing

Calling this method generates the following auditing event.

power-iaas.virtual-serial-number.list

Request

Response

200 - OK

List supported software tiers (IBMi licensing)

GET /v1/virtual-serial-number/software-tiers

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.software-tier.list

Auditing

Calling this method generates the following auditing event.

power-iaas.software-tier.list

Request

Response

200 - OK

Unreserve a retained Virtual Serial Number

DELETE /v1/virtual-serial-number/{virtual_serial_number}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.virtual-serial-number.delete

Auditing

Calling this method generates the following auditing event.

power-iaas.virtual-serial-number.delete

Request

Response

200 - OK

Get information for a Virtual Serial Number

GET /v1/virtual-serial-number/{virtual_serial_number}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.virtual-serial-number.read

Auditing

Calling this method generates the following auditing event.

power-iaas.virtual-serial-number.read

Request

Response

200 - OK

description

string

Description of the Virtual Serial Number

pvmInstanceID

string

ID of the PVM Instance Virtual Serial Number is attached to.

serial

string

Virtual Serial Number assigned to the PVM Instance

softwareTier

error

string

Update Description of a Reserved Virtual Serial Number

PUT /v1/virtual-serial-number/{virtual_serial_number}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.virtual-serial-number.update

Auditing

Calling this method generates the following auditing event.

power-iaas.virtual-serial-number.update

Request

Request Body

UpdateVirtualSerialNumber

Parameters to edit description of a reserved Virtual Serial Number

description

Required *

string

Description of the Virtual Serial Number

Response

200 - OK

description

string

Description of the Virtual Serial Number

serial

string

Virtual Serial Number

softwareTier

error

string

Get the list of volume snapshots on a workspace

GET /v1/volume-snapshots

View the usage of volume snapshots on the workspace. The volume snapshots may take time sync because the data is cached.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-snapshot.list

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-snapshot.list

Request

Response

200 - OK

volumeSnapshots

error

string

Get the detail of a volume snapshot

GET /v1/volume-snapshots/{volume_snapshot_uuid}

View the usage of a snapshot. The snapshot may take time sync because the data is cached.

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.read
power-iaas.volume-snapshot.read

Auditing

Calling this method generates the following auditing event.

power-iaas.volume-snapshot.read

Request

Path Parameters

volume_snapshot_uuid

Required *

string

The volume snapshot UUID

Query Parameters

Response

The date and time when the volume snapshot was last updated.

volumeID

error

string

Get all Workspaces information and capabilities for a tenant

GET /v1/workspaces

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance.read
power-iaas.workspace.list

Auditing

Calling this method generates the following auditing event.

power-iaas.workspace.list

Request

Response

200 - OK

workspaces

error

string

Get a Workspace's information and capabilities

GET /v1/workspaces/{workspace_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action.

power-iaas.cloud-instance.modify
power-iaas.cloud-instance.read
power-iaas.workspace.read

Auditing

Calling this method generates the following auditing event.

power-iaas.workspace.read

Request

Response

The Workspace status

type

error

string