Introduction

You can use the IBM® Power Systems™ Virtual Server to easily deploy and configure virtual servers that are running AIX, IBM i, or Linux (RHEL and SLES) workloads.

Endpoint URL

The Power Systems Virtual Server service uses regional endpoints over a public network. To target your region, replace {region} with the prefix that represents the geographic area where your service instance is located. Currently, the us-east, us-south, eu-de, lon, tor, syd, and tok regions are supported.

https://{region}.power-iaas.cloud.ibm.com

The Power Systems Virtual Server service uses regional endpoints over a private network. To target your region, replace {region} with the prefix that represents the geographic area where your service instance is located. Currently, the us-east, us-south, eu-de, eu-gb, ca-tor, au-syd, jp-tok, jp-osa, br-sao, and ca-mon regions are supported.

https://private.{region}.power-iaas.cloud.ibm.com

Authentication

To work with the Power Systems Virtual Server API, you must include your IBM Cloud IAM access token and the Power Systems Virtual Server instance ID, also known as your Cloud Resource Name (CRN), in every request. The first part of your CRN contains your Tenant ID and the second part contains your Cloud Instance ID. The following example shows a typical CRN:

crn:v1:staging:public:power-iaas:us-east:a/abcdefghijklmnopqrstuvwxyzabcdef:121d5ee5-b87d-4a0e-86b8-aaff422135478::

Tenant ID {tenant_id} = abcdefghijklmnopqrstuvwxyzabcdef
Cloud Instance ID {cloud_instance_id} = 121d5ee5-b87d-4a0e-86b8-aaff422135478

You can retrieve an access token by first creating an API key, and then exchanging your API key for a IBM Cloud IAM token. For more information, see Retrieving an access token programmatically and Retrieving your instance ID.

Example

API endpoint

https://{region}.power-iaas.cloud.ibm.com

Replace {region} with the prefix that represents the geographic area where your Power Systems Virtual Server service instance resides.

To retrieve your access token:

ibmcloud iam oauth-tokens

To retrieve your instance ID:

ibmcloud resource service-instance {instance_name} --id

Replace {instance_name} with the unique alias that you assigned to your Power Systems Virtual Server instance.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response indicates success. A 400 type response indicates a failure, and a 500 type response indicates an internal system error.

HTTP Error Code Description Recovery
200 Success The request was successful.
400 Bad Request The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all of the required parameters in your request.
401 Unauthorized You are not authorized to make this request. Log in to the IBM Cloud website and try again. If this error persists, contact the account owner to check your permissions.
403 Forbidden The supplied authentication is not authorized to access this resource.
404 Not Found The requested resource could not be found.
408 Request Timeout The connection to the server timed out. Wait a few minutes, then try again.
409 Conflict The entity is already in the requested state.
500 Internal Server Error Power Systems Virtual Server is currently unavailable. Your request could not be processed. Wait a few minutes and try again.

Release notes

Use the release notes to learn about the latest changes to the Power Systems Virtual Server API.

December 2022

  • You can now get new error messages for undefined response codes for new service endpoint response codes.

September 2021

Methods

Get a Cloud Instance's current state/information

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Not Found

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Get all cloud connections in this cloud instance

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Request Timeout

  • Internal Server Error

Example responses
  • {
      "cloudConnections": [
        {
          "cloudConnectionID": "fc010e03-4a07-4bd0-aec9-571fcac5f17f",
          "creationDate": "2021-02-26T20:39:53.696Z",
          "globalRouting": false,
          "ibmIPAddress": "1.2.3.4/5",
          "linkStatus": "connect",
          "metered": false,
          "name": "powervs-cloud-connection-1",
          "port": 0,
          "speed": 1000,
          "userIPAddress": "1.2.3.4/5"
        },
        {
          "cloudConnectionID": "ec610e13-4a07-4bd0-aec9-571fcac5f17d",
          "creationDate": "2021-02-26T20:40:52.100Z",
          "globalRouting": false,
          "ibmIPAddress": "1.2.3.4/5",
          "linkStatus": "connect",
          "metered": false,
          "name": "powervs-cloud-connection-2",
          "port": 0,
          "speed": 1000,
          "userIPAddress": "1.2.3.4/5"
        }
      ]
    }

Create a new cloud connection

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

Parameters for the creation of a new cloud connection

  • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"
      --data-raw '{
            "classic": {
            "enabled": true,
            "gre": {
                  "cidr": "string",
                  "destIPAddress": "string"
                   }
                  },
            "globalRouting": true,
            "metered": true,
            "name": "string",
            "speed": 50,
            "subnets": [
              "string"
              ],
            "transitEnabled": true,
            "vpc": {
              "enabled": true,
            "vpcs": [
            {
              "name": "string",
              "vpcID": "string"
            }
              ]
            }
          }'

Response

Status Code

  • OK

  • Created

  • Accepted

  • Bad Request

  • Unauthorized

  • Not Found

  • Request Timeout

  • Conflict

  • Unprocessable Entity

  • Internal Server Error

  • Gateway Timeout

Example responses
  • {
      "cloudConnectionID": "fc010e03-4a07-4bd0-aec9-571fcac5f17f",
      "creationDate": "2021-02-28T22:42:54.574Z",
      "globalRouting": true,
      "ibmIPAddress": "1.2.3.4/5",
      "linkStatus": "idle",
      "metered": true,
      "name": "powervs-cloud-connection",
      "port": 0,
      "speed": 5000,
      "userIPAddress": "1.2.3.4/5"
    }

Get all virtual private cloud connections in this cloud instance

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections-virtual-private-clouds   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Request Timeout

  • Internal Server Error

  • Gateway Timeout

Example responses
  • {
      "virtualPrivateClouds": [
        {
          "classicAccess": false,
          "name": "datacenter1-powervs-virtual-private-cloud",
          "status": "available",
          "vpcID": "crn:v1..."
        },
        {
          "classicAccess": false,
          "name": "datacenter2-powervs-virtual-private-cloud",
          "status": "available",
          "vpcID": "crn:v1..."
        }
      ]
    }

Get a cloud connection's state/information

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Cloud Connection ID

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections/${CLOUD_CONNECTION_ID}   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Not Found

  • Request Timeout

  • Internal Server Error

Example responses
  • {
      "classic": {
        "enabled": true,
        "gre": {
          "destIPAddress": "1.2.3.4",
          "sourceIPAddress": "10.0.0.1"
        }
      },
      "cloudConnectionID": "fc010e03-4a07-4bd0-aec9-571fcac5f17f",
      "creationDate": "2021-02-28T22:42:54.574Z",
      "globalRouting": true,
      "ibmIPAddress": "1.2.3.4/5",
      "linkStatus": "idle",
      "metered": false,
      "name": "powervs-cloud-connection-1",
      "networks": [
        {
          "href": "/pcloud/v1/cloud-instances/9f7b1c66a7bc6404908dd5e0c2e24ec8/networks/295784b0-a7d2-4752-8ad5-e894529895b2",
          "jumbo": false,
          "name": "powervs-cloud-connections-network",
          "networkID": "295784b0-a7d2-4752-8ad5-e894529895b2",
          "type": "vlan",
          "vlanID": 3254
        }
      ],
      "port": 0,
      "speed": 5000,
      "userIPAddress": "1.2.3.4/5",
      "vpc": {
        "enabled": true,
        "vpcs": [
          {
            "name": "vpc-fc010e03-4a07-4bd0-aec9-571fcac5f17f-0",
            "vpcID": "crn:v1..."
          }
        ]
      }
    }

Update a Cloud Connection

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Cloud Connection ID

Parameters to update a Cloud Connection

  • curl -X PUT   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections/${CLOUD_CONNECTION_ID}   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"
      --data-raw '{
          "classic": {
              "enabled": true,
              "gre": {
                  "cidr": "10.0.0.0/24",
                  "destIPAddress": "1.2.3.4"
              }
          },
          "globalRouting": true,
          "metered": false,
          "name": "powervs-cloud-connection-1",
          "speed": 5000,
          "vpc": {
              "enabled": true,
              "vpcs": [
                  {
                      "vpcID": "crn:v1..."
                  },
                  {
                      "vpcID": "crn:v1..."
                  }
              ]
          }
       }'

Response

Status Code

  • OK

  • Accepted

  • Bad Request

  • Unauthorized

  • Not Found

  • Method Not Allowed

  • Request Timeout

  • Conflict

  • Unprocessable Entity

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Delete a Cloud Connection

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Cloud Connection ID

  • curl -X PUT   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections/${CLOUD_CONNECTION_ID}   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"

Response

Status Code

  • OK

  • Accepted

  • Bad Request

  • Unauthorized

  • Not Found

  • Request Timeout

  • Gone

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Attach a network to the cloud connection

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Cloud Connection ID

  • Network ID

  • curl -X PUT   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections/${CLOUD_CONNECTION_ID}/networks/${NETWORK_ID}   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"

Response

Status Code

  • OK

  • Accepted

  • Bad Request

  • Unauthorized

  • Not Found

  • Request Timeout

  • Unprocessable Entity

  • Internal Server Error

Example responses
  • {
      "href": "pcloud/v1/cloud-instances/d234578e-9520-408g-9e94-259dda713d9e/jobs/c113467d-8419-449c-8d83-259dda713d9e",
      "id": "c113467d-8419-449c-8d83-259dda713d9e"
    }

Detach a network from a Cloud Connection

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Cloud Connection ID

  • Network ID

  • curl -X DELETE   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cloud-connections/${CLOUD_CONNECTION_ID}/networks/${NETWORK_ID}   --header "Authorization: Bearer ${TOKEN}"   --header "Content-Type: application/json"   --header "crn: ${CRN}"

Response

Status Code

  • OK

  • Accepted

  • Bad Request

  • Unauthorized

  • Not Found

  • Request Timeout

  • Gone

  • Internal Server Error

Example responses
  • {
      "href": "pcloud/v1/cloud-instances/d234578e-9520-408g-9e94-259dda713d9e/jobs/c113467d-8419-449c-8d83-259dda713d9e",
      "id": "c113467d-8419-449c-8d83-259dda713d9e"
    }

Get detail of last cos-image import job

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cos-images   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

Response

Status Code

  • OK

  • Unauthorized

  • Not Found

  • Internal Server Error

Example responses
  • {
      "createTimestamp": "2021-08-09T20:17:39.827Z",
      "id": "c113467d-8419-449c-8d81-259dda713d9f",
      "operation": {
        "action": "imageImport",
        "id": "b81ea020-bb47-452e-af96-8523c68e",
        "target": "image"
      },
      "status": {
        "message": "download of  <imageFileName>.ova.gz from <bucketname> is in progress",
        "progress": "imageDownloadMonitor",
        "state": "running"
      }
    }

Create an cos-image import job

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

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

  • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/cos-images   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'
      -d '{
            "imageName": "my-image-catalog-name",
            "region": "us-east",
            "imageFilename": "my-os-image-file.ova.gz",
            "bucketName": "my-cos-bucket-name",
            "accessKey": "my-cos-bucket-access-key",
            "secretKey": "my-cos-bucket-secret-key",
            "storageType": "tier3"    
            "storagePool": "StoragePool-3"
            "storageAffinity": {
              "affinityPolicy": "affinity",
              "affinityPVMInstance": "testVM3", 
            }
          }'

Response

Status Code

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

  • Bad Request

  • Unauthorized

  • Forbidden

  • Conflict

  • Unprocessable Entity

  • Internal Server Error

Example responses
  • {
      "href": "pcloud/v1/jobs/c113467d-8419-449c-8d83-259dda713d9e",
      "id": "c113467d-8419-449c-8d83-259dda713d9e"
    }

List all images for this cloud instance

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/images   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Not Found

  • Internal Server Error

Example responses
  • {
      "images": [
        {
          "creationDate": "2019-12-04T19:45:48.000Z",
          "description": "",
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/images/938b1104-18bc-4666-a384-b205793aab86",
          "imageID": "938b1104-18bc-4666-a384-b205793aab86",
          "lastUpdateDate": "2019-12-04T19:46:19.000Z",
          "name": "7100-05-04",
          "specifications": {
            "architecture": "ppc64",
            "containerFormat": "bare",
            "diskFormat": "raw",
            "endianness": "big-endian",
            "hypervisorType": "phyp",
            "imageType": "stock",
            "operatingSystem": "aix"
          },
          "state": "active",
          "storageType": "tier3-gen2"
        },
        {
          "creationDate": "2019-09-11T16:10:00.000Z",
          "description": "",
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/images/b39f1013-6d26-4585-856d-8aa4ea5e9ee9",
          "imageID": "b39f1013-6d26-4585-856d-8aa4ea5e9ee9",
          "lastUpdateDate": "2019-09-11T16:10:17.000Z",
          "name": "7200-03-03",
          "specifications": {
            "architecture": "ppc64",
            "containerFormat": "bare",
            "diskFormat": "raw",
            "endianness": "big-endian",
            "hypervisorType": "phyp",
            "imageType": "stock",
            "operatingSystem": "aix"
          },
          "state": "active",
          "storageType": "tier3-gen2"
        },
        {
          "creationDate": "2020-01-08T20:35:36.000Z",
          "description": "",
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/images/e3c453a9-40b0-4fd6-89f9-3b71273446b0",
          "imageID": "e3c453a9-40b0-4fd6-89f9-3b71273446b0",
          "lastUpdateDate": "2020-01-08T20:45:09.000Z",
          "name": "COS-import-7100-05-04-img",
          "specifications": {
            "architecture": "ppc64",
            "containerFormat": "bare",
            "diskFormat": "raw",
            "endianness": "big-endian",
            "hypervisorType": "phyp",
            "imageType": "import",
            "operatingSystem": "aix"
          },
          "state": "active",
          "storageType": "standard"
        },
        {
          "creationDate": "2019-12-05T18:13:27.000Z",
          "description": "",
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/images/affa57fc-493d-4599-bfb6-755f99c9cab6",
          "imageID": "affa57fc-493d-4599-bfb6-755f99c9cab6",
          "lastUpdateDate": "2019-12-05T18:14:14.000Z",
          "name": "IBMi-72-09-002",
          "specifications": {
            "architecture": "ppc64",
            "containerFormat": "bare",
            "diskFormat": "raw",
            "endianness": "big-endian",
            "hypervisorType": "phyp",
            "imageType": "stock",
            "operatingSystem": "ibmi"
          },
          "state": "active",
          "storageType": "standard"
        },
        {
          "creationDate": "2019-09-17T10:55:13.000Z",
          "description": "",
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/images/8105a084-0360-478f-bfe8-c5a2af98f690",
          "imageID": "8105a084-0360-478f-bfe8-c5a2af98f690",
          "lastUpdateDate": "2019-09-17T10:55:41.000Z",
          "name": "IBMi-73-06-001",
          "specifications": {
            "architecture": "ppc64",
            "containerFormat": "bare",
            "diskFormat": "raw",
            "endianness": "big-endian",
            "hypervisorType": "phyp",
            "imageType": "stock",
            "operatingSystem": "ibmi"
          },
          "state": "active",
          "storageType": "tier3-gen2"
        },
        {
          "creationDate": "2019-11-04T22:26:04.000Z",
          "description": "",
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/images/75be671c-9e45-49c0-b462-7672e28fc80c",
          "imageID": "75be671c-9e45-49c0-b462-7672e28fc80c",
          "lastUpdateDate": "2019-11-04T22:27:14.000Z",
          "name": "IBMi-74-00-001",
          "specifications": {
            "architecture": "ppc64",
            "containerFormat": "bare",
            "diskFormat": "raw",
            "endianness": "big-endian",
            "hypervisorType": "phyp",
            "imageType": "stock",
            "operatingSystem": "ibmi"
          },
          "state": "active",
          "storageType": "tier3-gen2"
        }
      ]
    }

Create a new Image (from available images)

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

Parameters for the creation of a new image from available images

  • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/images   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
            "source": "root-project",
            "imageID": "b39f1013-6d26-4585-856d-8aa4ea5e9ee9"
          }'

Response

Status Code

  • OK

  • Created

  • Bad Request

  • Unauthorized

  • Conflict

  • Unprocessable Entity

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Detailed info of an image

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Image ID of a image

  • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/images/{image_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Not Found

  • Internal Server Error

Example responses
  • {
      "creationDate": "2019-09-11T16:10:00.000Z",
      "imageID": "b39f1013-6d26-4585-856d-8aa4ea5e9ee9",
      "lastUpdateDate": "2019-09-11T16:10:17.000Z",
      "name": "7200-03-03",
      "servers": [
        "kylej-pointer-test",
        "dl02-test",
        "nni-vm01",
        "gre-vm02"
      ],
      "size": 20,
      "specifications": {
        "architecture": "ppc64",
        "containerFormat": "bare",
        "diskFormat": "raw",
        "endianness": "big-endian",
        "hypervisorType": "phyp",
        "imageType": "stock",
        "operatingSystem": "aix"
      },
      "state": "active",
      "storageType": "standard",
      "volumes": [
        {
          "bootable": true,
          "name": "volume-969afb22cb00-23977--cf758b7d-e30b",
          "size": 20
        }
      ]
    }

Delete an Image from a Cloud Instance

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Image ID of a image

  • curl -X DELETE   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/images/{image_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

Response

Status Code

  • OK

  • Bad Request

  • Unauthorized

  • Gone

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

Export an image

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.

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

  • Image ID of a image

Parameters for exporting an image

  • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/images/{image_id}/export   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
            "bucketName": "cloud-object-storage-bucket"
            "accessKey": "347aa3a4b34344f8bc7c7cccdf856e4c"
          }'

Response

Status Code

  • Accepted

  • Bad Request

  • Unauthorized

  • Not Found

  • Unprocessable Entity

  • Internal Server Error

No Sample Response

This method does not specify any sample responses.

List all available stock images

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

Request

Path Parameters

  • Cloud Instance ID of a PCloud Instance

Query Parameters

  • Include SAP images with get available stock images

  • Include VTL images with get available stock images

    Response

    Status Code

    • OK

    • Bad Request

    • Unauthorized

    • Not Found

    • Internal Server Error

    No Sample Response

    This method does not specify any sample responses.

    Detailed info of an available stock image

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

    Request

    Path Parameters

    • Cloud Instance ID of a PCloud Instance

    • Image ID of a image

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      List all the images in the image-catalog

      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.

      GET /pcloud/v1/images

      Request

      Query Parameters

      • Include SAP images with get available stock images

      • Include VTL images with get available stock images

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/images   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      Detailed info of an image in the image-catalog

      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.

      GET /pcloud/v1/images/{image_id}

      Request

      Path Parameters

      • Image ID of a image

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/images/{image_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      Get detail of last image export job

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Image ID of a image

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/${CLOUD_INSTANCE_ID}/images/{image_id}/export   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

      Response

      Status Code

      • OK

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "createTimestamp": "2021-08-09T20:17:39.827Z",
          "id": "c113467d-8419-449c-8d81-259dda713d9f",
          "operation": {
            "action": "imageExport",
            "id": "b81ea020-bb47-452e-af96-8523c68f",
            "target": "image"
          },
          "status": {
            "message": "compression of image ova file is in progress",
            "progress": "imageCompress",
            "state": "running"
          }
        }

      Add image export job to the jobs queue

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Image ID of a image

      Parameters for the export

      • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/${CLOUD_INSTANCE_ID}/images/{image_id}/export   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                "bucketName": "cloud-object-storage-bucket"
                "accessKey": "347aa3a4b34344f8bc7c7cccdf856e4c"
              }

      Response

      Status Code

      • Accepted, image export successfully added to the jobs queue

      • Bad Request

      • Unauthorized

      • image id not found

      • Conflict, a conflict has prevented adding image export job

      • Unprocessable Entity

      • Internal Server Error

      Example responses
      • {
          "href": "pcloud/v1/jobs/c113467d-8419-449c-8d81-259dda713d9f",
          "id": "c113467d-8419-449c-8d81-259dda713d9fcreate"
        }

      Get events from this cloud instance since a specific timestamp

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

      Request

      Custom Headers

      • The language requested for the return document

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      Query Parameters

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

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

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

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/events   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Internal Server Error

      Example responses
      • {
          "events": [
            {
              "action": "create",
              "eventID": "d20d80f7-c87c-4ab7-bea2-2bc4736e7c2e",
              "level": "info",
              "message": "Power virtual server instance 'stg-provision-test-eu-de' has been created successfully.",
              "metadata": {
                "pvmInstanceID": "27380612-2062-46ec-ae5b-9e723ede304d"
              },
              "resource": "pvm-instance",
              "time": "2020-04-20T00:17:40.772Z",
              "timestamp": 1587341860,
              "user": {
                "email": "unknown@us.ibm.com",
                "name": "Unknown User",
                "userID": "1234567890"
              }
            }
          ]
        }

      Get a single event

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

      Request

      Custom Headers

      • The language requested for the return document

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Event ID

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/events/${EVENT_ID}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "action": "create",
          "eventID": "d20d80f7-c87c-4ab7-bea2-2bc4736e7c2e",
          "level": "info",
          "message": "Power virtual server instance 'stg-provision-test-eu-de' has been created successfully.",
          "metadata": {
            "pvmInstanceID": "27380612-2062-46ec-ae5b-9e723ede304d"
          },
          "resource": "pvm-instance",
          "time": "2020-04-20T00:17:40.772Z",
          "timestamp": 1587341860,
          "user": {
            "email": "unknown@us.ibm.com",
            "name": "Unknown User",
            "userID": "1234567890"
          }
        }

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

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      Query Parameters

      • Operation ID to filter jobs (optional)

      • Operation target to filter jobs (optional)

        Allowable values: [cloudConnection,pvmInstance,image,vpnConnection]

      • 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)

        Allowable values: [vmCapture,imageExport,imageImport,storage]

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/jobs   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "createTimestamp": "2022-04-27T09:48:44.620Z",
          "id": "3f09ffff-7d95-480b-b5ff-e2ba6ac3699c",
          "operation": [
            {
              "action": "imageImport",
              "id": "testImg",
              "target": "image"
            }
          ],
          "status": [
            {
              "message": "imageImport operation::import of image file testImg.ova.gz to image testImg has completed successfully",
              "progress": "imageImportMonitor",
              "state": "completed"
            }
          ]
        }

      List the detail of a job

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • PCloud Job ID

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/jobs/{job_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "createTimestamp": "2021-08-09T20:17:39.827Z",
          "id": "c113467d-8419-449c-8d81-259dda713d9f",
          "operation": [
            {
              "action": "vmCapture",
              "id": "b81ea020-bb47-452e-af96-8523c68e",
              "target": "pvmInstance"
            }
          ],
          "status": [
            {
              "message": "capturing VM to an image file",
              "progress": "capture",
              "state": "running"
            }
          ]
        }

      Delete a cloud instance job

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • PCloud Job ID

      • curl -X DELETE   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/jobs/{job_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Conflict

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      Get the disaster recovery site details for the current location

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/locations/disaster-recovery   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "location": "dal12",
          "replicationSites": [
            {
              "isActive": true,
              "location": "us-east"
            }
          ]
        }

      Get all disaster recovery locations supported by Power Virtual Server

      GET /pcloud/v1/locations/disaster-recovery

      Request

      No Request Parameters

      This method does not accept any request parameters.

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/locations/disaster-recovery   -H 'Authorization: Bearer <>'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "disasterRecoveryLocations": [
            {
              "location": "dal12",
              "replicationSites": [
                {
                  "isActive": true,
                  "location": "us-east"
                }
              ]
            },
            {
              "location": "us-east",
              "replicationSites": [
                {
                  "isActive": true,
                  "location": "dal12"
                }
              ]
            }
          ]
        }

      Get all networks in this cloud instance

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      Query Parameters

      • A filter expression that filters resources listed in the response

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Internal Server Error

      Example responses
      • {
          "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/networks/392913e3-e8ac-406b-a061-b431ee4bd239",
          "jumbo": false,
          "name": "test-ibm-network",
          "networkID": "392913e3-e8ac-406b-a061-b431ee4bd239",
          "type": "vlan",
          "vlanID": 3314
        }

      Create a new Network

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      Parameters for the creation of a new network

      • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                "type": "vlan"
              }'

      Response

      Status Code

      • OK

      • Created

      • Bad Request

      • Unauthorized

      • Conflict

      • Unprocessable Entity

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      Get a network's current state/information

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses
      • {
          "cidr": "172.16.5.0/24",
          "dnsServers": [
            "9.9.9.9",
            "127.0.0.3"
          ],
          "gateway": "172.16.5.1",
          "ipAddressMetrics": {
            "available": 250,
            "total": 251,
            "used": 1,
            "utilization": 0
          },
          "ipAddressRanges": [
            {
              "endingIPAddress": "172.16.5.254",
              "startingIPAddress": "172.16.5.4"
            }
          ],
          "jumbo": false,
          "name": "testMangala1",
          "networkID": "392913e3-e8ac-406b-a061-b431ee4bd239",
          "type": "vlan",
          "vlanID": 3314
        }

      Update a Network

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      Parameters to update a Network

      • curl -X PUT   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                "ipAddressRanges": {
                  "startingIPAddress": "192.168.100.4"
                  "endingIPAddress": "192.168.103.254"
                }
              }'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Unprocessable Entity

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      Delete a Network

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      • curl -X DELETE   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Not Found

      • Gone

      • Internal Server Error

      No Sample Response

      This method does not specify any sample responses.

      Get all ports for this network

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}/ports   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Internal Server Error

      Example responses
      • {
          "ports": [
            {
              "description": "",
              "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/networks/4d8713c5-123d-4662-8f58-8578c79d6814/ports/10890e8a-158b-49b5-8d05-96efd9f44824",
              "ipAddress": "192.168.140.28",
              "macAddress": "fa:16:3e:6a:35:cd",
              "portID": "10890e8a-158b-49b5-8d05-96efd9f44824",
              "pvmInstance": {
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/08490a29-ce61-4064-9a3b-ca051e005cf7",
                "pvmInstanceID": "08490a29-ce61-4064-9a3b-ca051e005cf7"
              },
              "status": "DOWN"
            },
            {
              "description": "",
              "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/networks/4d8713c5-123d-4662-8f58-8578c79d6814/ports/6a863b69-aa0c-48fa-8ce7-b69051f844ee",
              "ipAddress": "192.168.140.26",
              "macAddress": "fa:68:11:17:77:20",
              "portID": "6a863b69-aa0c-48fa-8ce7-b69051f844ee",
              "pvmInstance": {
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/ad2f6b96-9063-456c-a1a7-725eebdc86c1",
                "pvmInstanceID": "ad2f6b96-9063-456c-a1a7-725eebdc86c1"
              },
              "status": "ACTIVE"
            }
          ]
        }

      Perform port addition, deletion, and listing

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      Create a Network Port

      • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}/ports   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • Created

      • Bad Request

      • Unauthorized

      • Conflict

      • Unprocessable Entity

      • Internal Server Error

      Example responses
      • {
          "ports": [
            {
              "description": "",
              "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/networks/4d8713c5-123d-4662-8f58-8578c79d6814/ports/10890e8a-158b-49b5-8d05-96efd9f44824",
              "ipAddress": "192.168.140.28",
              "macAddress": "fa:16:3e:6a:35:cd",
              "portID": "10890e8a-158b-49b5-8d05-96efd9f44824",
              "pvmInstance": {
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/08490a29-ce61-4064-9a3b-ca051e005cf7",
                "pvmInstanceID": "08490a29-ce61-4064-9a3b-ca051e005cf7"
              },
              "status": "DOWN"
            },
            {
              "description": "",
              "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/networks/4d8713c5-123d-4662-8f58-8578c79d6814/ports/6a863b69-aa0c-48fa-8ce7-b69051f844ee",
              "ipAddress": "192.168.140.26",
              "macAddress": "fa:68:11:17:77:20",
              "portID": "6a863b69-aa0c-48fa-8ce7-b69051f844ee",
              "pvmInstance": {
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/ad2f6b96-9063-456c-a1a7-725eebdc86c1",
                "pvmInstanceID": "ad2f6b96-9063-456c-a1a7-725eebdc86c1"
              },
              "status": "ACTIVE"
            }
          ]
        }

      Get a port's information

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      • Port ID

      • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}/ports/{port_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

      Response

      Status Code

      • OK

      • Unauthorized

      • Not Found

      • Internal Server Error

      Example responses

      Update a port's information

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      • Port ID

      Parameters for updating a Port

      • curl -X PUT   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/networks/{network_id}/ports/{port_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'
          -d '{
               description: "port-description"
               pvmInstanceID: "pvm-instance-id"
              }'

      Response

      Status Code

      • OK

      • Bad Request

      • Unauthorized

      • Unprocessable Entity

      • Internal Server Error

      Example responses
      • {
          "examples": {
            "description": "",
            "ipAddress": "192.168.140.28",
            "macAddress": "fa:16:3e:6a:35:cd",
            "portID": "10890e8a-158b-49b5-8d05-96efd9f44824",
            "pvmInstance": {
              "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/08490a29-ce61-4064-9a3b-ca051e005cf7",
              "pvmInstanceID": "08490a29-ce61-4064-9a3b-ca051e005cf7"
            },
            "status": "DOWN"
          }
        }

      Delete a Network Port

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

      Request

      Path Parameters

      • Cloud Instance ID of a PCloud Instance

      • Network ID

      • Port ID

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Gone

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Get all Server Placement Groups

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/{cloudInstanceID}/placement-groups   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Internal Server Error

        Example responses
        • {
            "placementGroups": [
              {
                "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f",
                "members": [],
                "name": "MyAffinity-servergroup-1620150831",
                "policy": "affinity"
              },
              {
                "id": "7af58354f-85ec-4589-b5b5-b5d77a3583cc",
                "members": [],
                "name": "MyAnti-Affinity-servergroup",
                "policy": "anti-affinity"
              }
            ]
          }

        Create a new Server Placement Group

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        Parameters for the creation of a new Server Placement Group

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/{cloudInstanceID}/placement-groups   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                 "name": "MyAffinity-servergroup-1620150831",
                 "policy": "affinity"
               }'

        Response

        Status Code

        • OK

        • Bad Request

        • Conflict

        • Unprocessable Entity

        • Internal Server Error

        Example responses
        • {
            "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f",
            "members": [],
            "name": "MyAffinity-servergroup-1620150831",
            "policy": "affinity"
          }

        Get Server Placement Group detail

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • Placement Group ID

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/{cloudInstanceID}/placement-groups{placement_group_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json' \

        Response

        Status Code

        • OK

        • Bad Request

        • Not Found

        • Internal Server Error

        Example responses
        • {
            "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f",
            "members": [
              "541c1cda-a8da-4081-8020-3a0ce9850ca0"
            ],
            "name": "MyAffinity-servergroup-1620150831",
            "policy": "affinity"
          }

        Delete Server Placement Group

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • Placement Group ID

        • curl -X DELETE   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/{cloudInstanceID}/placement-groups/{placement_group_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

        Response

        Status Code

        • OK

        • Bad Request

        • Not Found

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Add Server to Placement Group

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • Placement Group ID

        Parameters for adding a server to a Server Placement Group

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/{cloudInstanceID}/placement-groups/{placementGroupID}/members   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                 "id": "541c1cda-a8da-4081-8020-3a0ce9850ca0",
               }'

        Response

        Status Code

        • OK

        • Bad Request

        • Not Found

        • Conflict

        • Unprocessable Entity

        • Internal Server Error

        Example responses
        • {
            "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f",
            "members": [
              "541c1cda-a8da-4081-8020-3a0ce9850ca0"
            ],
            "name": "MyAffinity-servergroup-1620150831",
            "policy": "affinity"
          }

        Remove Server from Placement Group

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • Placement Group ID

        Parameters for removing a Server in a Placement Group

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/{cloudInstanceID}/placement-groups/{placementGroupID}/members   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                 "id": "541c1cda-a8da-4081-8020-3a0ce9850ca0",
               }'

        Response

        Status Code

        • OK

        • Bad Request

        • Not Found

        • Conflict

        • Unprocessable Entity

        • Internal Server Error

        Example responses
        • {
            "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f",
            "members": [],
            "name": "MyAffinity-servergroup-1620150831",
            "policy": "affinity"
          }

        Get all the pvm instances for this cloud instance

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Internal Server Error

        Example responses
        • {
            "addresses": {
              "externalIP": "172.70.134.153",
              "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/6da0fd14-f7d3-4142-96f5-078df36c2539/networks/testMangala",
              "ip": "172.16.5.168",
              "ipAddress": "172.16.5.168",
              "macAddress": "fa:a0:34:00:14:20",
              "networkID": "8838dcff-d423-4490-aa95-7bfed54adbae",
              "networkName": "ibm-test-network",
              "type": "fixed",
              "version": 4
            },
            "creationDate": "2019-11-21T10:41:33.000Z",
            "health": {
              "lastUpdate": "2019-11-21T16:31:09.443Z",
              "status": "WARNING"
            },
            "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/6da0fd14-f7d3-4142-96f5-078df36c2539",
            "imageID": "732a5136-10b0-4c65-8882-7dc46601f3d5",
            "storagePool": "StoragePool-2",
            "storagePoolAffinity": true,
            "storageType": "tier1"
          }

        Create a new Power VM Instance

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        Query Parameters

        • Option to skip host validation on PVMInstance Create API

        Parameters for the creation of a new Power VM Instance

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                  "serverName": "server-name"
                  "imageID": "image-id"
                  "placementGroup": "7a3583cc-85ec-4589-b5b5-b5d7af58354f"
                  "processors" "number-of-processors"
                  "procType": "dedicated"
                  "memory": "amount-of-memory"
                  "networkIDs": "list-network-ids"
                  "sysType": "s922"
                  "volumeIDs": ["data-volume-1", “data-volume-2”]
                  "storageType": "tier1"
                  "storagePool": "StoragePool-3"
                  "storageAffinity": {
                    "affinityPolicy": "affinity",
                    "affinityPVMInstance": "testVM3", 
                    }
                    {
                      "affinityPolicy": "anti-affinity",
                      "antiAffinityPVMInstances": ["testVM1", “testVM2”]
                    }
                }'

        Response

        A list of PVMInstances

        Status Code

        • OK

        • Created

        • Accepted

        • Bad Request

        • Unauthorized

        • Forbidden

        • Not Found

        • Conflict

        • Unprocessable Entity

        • Internal Server Error

        • Gateway Timeout. Request is still processing and taking longer than expected.

        Example responses
        • {
            "addresses": [
              {
                "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/35c0e26c-e51f-4230-b556-49ada44d8831/networks/64782dfc-820f-45e7-9975-7320a548f116",
                "ip": "192.168.2.153",
                "ipAddress": "192.168.2.153",
                "macAddress": "fa:f2:5f:3c:86:20",
                "networkID": "64782dfc-820f-45e7-9975-7320a548f116",
                "networkName": "MoyTest",
                "type": "fixed",
                "version": 4
              }
            ],
            "creationDate": "2020-01-17T05:55:28.000Z",
            "diskSize": 80,
            "health": {
              "lastUpdate": "2020-01-17T17:23:04.070Z",
              "status": "OK"
            },
            "imageID": "8105a084-0360-478f-bfe8-c5a2af98f690",
            "maxmem": 4,
            "maxproc": 0.5,
            "memory": 2,
            "migratable": false,
            "minmem": 2,
            "minproc": 0.25,
            "networkIDs": [
              "64782dfc-820f-45e7-9975-7320a548f116"
            ],
            "networks": [
              {
                "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/35c0e26c-e51f-4230-b556-49ada44d8831/networks/64782dfc-820f-45e7-9975-7320a548f116",
                "ip": "192.168.2.153",
                "ipAddress": "192.168.2.153",
                "macAddress": "fa:f2:5f:3c:86:20",
                "networkID": "64782dfc-820f-45e7-9975-7320a548f116",
                "networkName": "MoyTest",
                "type": "fixed",
                "version": 4
              }
            ],
            "procType": "shared",
            "processors": 0.25,
            "pvmInstanceID": "35c0e26c-e51f-4230-b556-49ada44d8831",
            "serverName": "MoyMetadataTest3",
            "status": "ACTIVE",
            "storageType": "standard",
            "sysType": "s922",
            "updatedDate": "2020-01-17T05:55:28.000Z",
            "volumeIDs": [
              "3a40ee8a-e80c-49bc-9db4-b09687c38bd1"
            ]
          }

        Get a PVM Instance's current state or information

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        • curl -X GET   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/{pvm_instance_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Not Found

        • Internal Server Error

        Example responses
        • {
            "addresses": [
              {
                "externalIP": "xxx.xxx.xxx.xxx",
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/8ab7ede5-540e-44bc-99cf-9c8bf1ac6297/networks/8838dcff-d423-4490-aa95-7bfed54adbae",
                "ip": "192.168.140.38",
                "ipAddress": "192.168.140.38",
                "macAddress": "fa:38:e6:a8:19:20",
                "networkID": "8838dcff-d423-4490-aa95-7bfed54adbae",
                "networkName": "public-192_168_140_32-29-VLAN_3305",
                "type": "fixed",
                "version": 4
              }
            ],
            "creationDate": "2020-04-22T17:12:41.000Z",
            "diskSize": 20,
            "health": {
              "lastUpdate": "2020-04-22T17:16:28.099Z",
              "status": "WARNING"
            },
            "imageID": "dd04bafb-fda2-49c5-825b-1c1d274a8a99",
            "maxmem": 4,
            "maxproc": 0.5,
            "memory": 2,
            "migratable": false,
            "minmem": 2,
            "minproc": 0.25,
            "networkIDs": [
              "8838dcff-d423-4490-aa95-7bfed54adbae"
            ],
            "networks": [
              {
                "externalIP": "161.156.179.134",
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/8ab7ede5-540e-44bc-99cf-9c8bf1ac6297/networks/8838dcff-d423-4490-aa95-7bfed54adbae",
                "ip": "192.168.140.38",
                "ipAddress": "192.168.140.38",
                "macAddress": "fa:38:e6:a8:19:20",
                "networkID": "8838dcff-d423-4490-aa95-7bfed54adbae",
                "networkName": "public-192_168_140_32-29-VLAN_3305",
                "type": "fixed",
                "version": 4
              }
            ],
            "pinPolicy": "none",
            "placementGroup": "none",
            "procType": "shared",
            "processors": 0.25,
            "pvmInstanceID": "8ab7ede5-540e-44bc-99cf-9c8bf1ac6297",
            "serverName": "stg-provision-test-eu-de-1",
            "status": "ACTIVE",
            "storagePool": "StoragePool-1",
            "storagePoolAffinity": true,
            "storageType": "tier3",
            "sysType": "s922",
            "updatedDate": "2020-04-22T17:12:41.000Z",
            "volumeIDs": [
              "d2c0e860-bceb-48a1-aa54-e8c5af9bdefc"
            ]
          }

        Update a PCloud PVM Instance

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Parameters to update a PCloud PVM Instance

        • curl -X PUT   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/{pvm_instance_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'
            -d '{
                "serverName": server-name
                "processors": number-of-processors
                "procType": "dedicated"
                "memory": "4"
                "migratable": "false"
                "softwareLicenses": "software-licenses"
                "pinPolicy": "soft"
                "storagePoolAffinity": true
                }'

        Response

        Status Code

        • Accepted (this is a long running operation)

        • Bad Request

        • Unauthorized

        • Unprocessable Entity

        • Internal Server Error

        Example responses
        • {
            "addresses": [
              {
                "externalIP": "xxx.xxx.xxx.xxx",
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/8ab7ede5-540e-44bc-99cf-9c8bf1ac6297/networks/8838dcff-d423-4490-aa95-7bfed54adbae",
                "ip": "192.168.140.38",
                "ipAddress": "192.168.140.38",
                "macAddress": "fa:38:e6:a8:19:20",
                "networkID": "8838dcff-d423-4490-aa95-7bfed54adbae",
                "networkName": "public-192_168_140_32-29-VLAN_3305",
                "type": "fixed",
                "version": 4
              }
            ],
            "creationDate": "2020-04-22T17:12:41.000Z",
            "diskSize": 20,
            "health": {
              "lastUpdate": "2020-04-22T17:16:28.099Z",
              "status": "WARNING"
            },
            "imageID": "dd04bafb-fda2-49c5-825b-1c1d274a8a99",
            "maxmem": 4,
            "maxproc": 0.5,
            "memory": 4,
            "migratable": false,
            "minmem": 2,
            "minproc": 0.25,
            "networkIDs": [
              "8838dcff-d423-4490-aa95-7bfed54adbae"
            ],
            "networks": [
              {
                "externalIP": "xxx.xxx.xxx.xxx",
                "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/8ab7ede5-540e-44bc-99cf-9c8bf1ac6297/networks/8838dcff-d423-4490-aa95-7bfed54adbae",
                "ip": "192.168.140.38",
                "ipAddress": "192.168.140.38",
                "macAddress": "fa:38:e6:a8:19:20",
                "networkID": "8838dcff-d423-4490-aa95-7bfed54adbae",
                "networkName": "public-192_168_140_32-29-VLAN_3305",
                "type": "fixed",
                "version": 4
              }
            ],
            "pinPolicy": "soft",
            "procType": "dedicated",
            "processors": 0.25,
            "pvmInstanceID": "8ab7ede5-540e-44bc-99cf-9c8bf1ac6297",
            "serverName": "stg-provision-test-eu-de-1",
            "status": "ACTIVE",
            "storageType": "tier1",
            "sysType": "s922",
            "updatedDate": "2020-04-22T17:12:41.000Z",
            "volumeIDs": [
              "d2c0e860-bceb-48a1-aa54-e8c5af9bdefc"
            ]
          }

        Delete a PCloud PVM Instance

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Query Parameters

        • 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.

        • curl -X DELETE   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/{pvm_instance_id}   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Not Found

        • Gone

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Perform an action (start stop reboot immediate-shutdown reset) on a PVMInstance

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Parameters for the desired action

        • curl -X POST   https://< Cloud IP>/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/${PVM_Instance_ID}/action   -H "authorization: <AuthToken>"   -H "content-type: application/json"   -H 'crn: <CRN>'   -d '{
                  "action":"immediate-shutdown"
                }'

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Not Found

        • Conflict

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Capture a PVMInstance and create a deployable image

        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.

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Parameters for the capture PVMInstance

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/{pvm_instance_id}/capture   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                  "captureName": "deployable-image-name"
                  "captureDestination": "deployable-image-destination"
                }'

        Response

        Status Code

        • OK

        • Accepted, upload to cloud storage in progress

        • Bad Request

        • Unauthorized

        • Unprocessable Entity

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Clone a PVMInstance

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Clone PVM Instance parameters

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/{pvm_instance_id}/clone   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'   -d '{
                "name": "server-name"
                "networks": "pvm-instance-networks"
                }'

        Response

        Status Code

        • Accepted

        • Bad Request

        • Unauthorized

        • Conflict

        • Unprocessable Entity

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        List all console languages

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Update PVMInstance console laguage code

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        Parameters to update a PVMInstance console required codepage

        Response

        Status Code

        • OK

        • Bad Request

        • Unauthorized

        • Internal Server Error

        No Sample Response

        This method does not specify any sample responses.

        Generate the noVNC Console URL

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

        Request

        Path Parameters

        • Cloud Instance ID of a PCloud Instance

        • PCloud PVM Instance ID

        • curl -X POST   https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/pvm-instances/{pvm_instance_id}/console   -H 'Authorization: Bearer <>'   -H 'CRN: crn:v1...'   -H 'Content-Type: application/json'

        Response

        Status Code