{ "openapi": "3.0.0", "info": { "contact": { "email": "ismirlia@us.ibm.com", "name": "Power Cloud API", "url": "https://github.ibm.com/power-iaas" }, "description": "IBM Power Cloud API for Power Hardware / Infrastructure", "title": "Power Cloud API", "version": "2.3.1", "x-last-updated": "2024-12-12" }, "paths": { "/pcloud/v1/cloud-instances/{cloud_instance_id}": { "get": { "operationId": "pcloud.cloudinstances.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudInstance" }, "examples": { "response": { "value": { "capabilities": [ "cloud-connections", "custom-virtualcores", "direct-link-transit-gateway", "ibmi-software-licenses", "linux", "pinning", "rhel-sap", "sap", "snapshots", "unmetered", "volume-clone", "vpn-connections", "shared-processor-pools" ], "cloudInstanceID": "a28d8395820185938ef8c9d89a093ef9", "enabled": true, "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 }, "name": "29394aed-c341-2331-3498-defcd9a8e929", "openstackID": "49eabce9-2938-1948-c829-c98bde93819f", "pvmInstances": [], "region": "dal12", "tenantID": "39dace938295718501728475618edfe9", "usage": { "instances": 0, "memory": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0, "storageStandard": 0 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance.list" ] } ], "summary": "Get a Cloud Instance's current state/information", "tags": [ "PCloudInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-instance.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections": { "get": { "operationId": "pcloud.cloudconnections.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnections" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-connection.list" ] } ], "summary": "Get all cloud connections in this cloud instance", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-connection.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.cloudconnections.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectionCreate" } } }, "description": "Parameters for the creation of a new cloud connection", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnection" }, "examples": { "response": { "value": { "cloudConnectionID": "fc010e03-4a07-4bd0-aec9-571fcac5f17f", "creationDate": "2021-02-28T22:42:54.574Z", "globalRouting": true, "ibmIPAddress": "1.2.3.4/5", "jobRef": { "href": "pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/jobs/2e456abe-3948-de91-3913-efca59681745", "id": "2e456abe-3948-de91-3913-efca59681745" }, "linkStatus": "idle", "metered": true, "name": "powervs-cloud-connection", "port": "2039f9ef-c934-d293-1932-ab56283475ef", "speed": 500, "userIPAddress": "1.2.3.4/5" } } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnection" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectionCreateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-connection.create" ] } ], "summary": "Create a new cloud connection", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-connection.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"classic\": {\n \"enabled\": true,\n \"gre\": {\n \"cidr\": \"string\",\n \"destIPAddress\": \"string\"\n }\n },\n \"globalRouting\": true,\n \"metered\": true,\n \"name\": \"string\",\n \"speed\": 50,\n \"subnets\": [\n \"string\"\n ],\n \"transitEnabled\": true,\n \"vpc\": {\n \"enabled\": true,\n \"vpcs\": [\n {\n \"name\": \"string\",\n \"vpcID\": \"string\"\n }\n ]\n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections-virtual-private-clouds": { "get": { "operationId": "pcloud.cloudconnections.virtualprivateclouds.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectionVirtualPrivateClouds" }, "examples": { "response": { "value": { "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..." } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-connection-vpc.list" ] } ], "summary": "Get all virtual private cloud connections in this cloud instance", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-connection-vpc.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections-virtual-private-clouds \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}": { "delete": { "operationId": "pcloud.cloudconnections.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-connection.delete" ] } ], "summary": "Delete a Cloud Connection", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-connection.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections/$CLOUD_CONNECTION_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.cloudconnections.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnection" }, "examples": { "response": { "value": { "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..." } ] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-connection.read" ] } ], "summary": "Get a cloud connection's state/information", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-connection.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections/$CLOUD_CONNECTION_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/cloud_connection_id" } ], "put": { "operationId": "pcloud.cloudconnections.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnectionUpdate" } } }, "description": "Parameters to update a Cloud Connection", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudConnection" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/jobs/2e456abe-3948-de91-3913-efca59681745", "id": "2e456abe-3948-de91-3913-efca59681745" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-connection.update" ] } ], "summary": "Update a Cloud Connection", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-connection.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections/$CLOUD_CONNECTION_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"classic\": {\n \"enabled\": true,\n \"gre\": {\n \"cidr\": \"10.0.0.0/24\",\n \"destIPAddress\": \"1.2.3.4\"\n }\n },\n \"globalRouting\": true,\n \"metered\": false,\n \"name\": \"powervs-cloud-connection-1\",\n \"speed\": 5000,\n \"vpc\": {\n \"enabled\": true,\n \"vpcs\": [\n {\n \"vpcID\": \"crn:v1...\"\n },\n {\n \"vpcID\": \"crn:v1...\"\n }\n ]\n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/cloud-connections/{cloud_connection_id}/networks/{network_id}": { "delete": { "operationId": "pcloud.cloudconnections.networks.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/cloud-instances/d234578e-9520-408g-9e94-259dda713d9e/jobs/c113467d-8419-449c-8d83-259dda713d9e", "id": "c113467d-8419-449c-8d83-259dda713d9e" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-connection-network.delete" ] } ], "summary": "Detach a network from a Cloud Connection", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-connection-network.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections/$CLOUD_CONNECTION_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/cloud_connection_id" }, { "$ref": "#/components/parameters/network_id" } ], "put": { "operationId": "pcloud.cloudconnections.networks.put", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/cloud-instances/d234578e-9520-408g-9e94-259dda713d9e/jobs/c113467d-8419-449c-8d83-259dda713d9e", "id": "c113467d-8419-449c-8d83-259dda713d9e" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-connection-network.update" ] } ], "summary": "Attach a network to the cloud connection", "tags": [ "PCloudCloudConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.cloud-connection.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-connection-network.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cloud-connections/$CLOUD_CONNECTION_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/cos-images": { "get": { "operationId": "pcloud.v1.cloudinstances.cosimages.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" }, "examples": { "response": { "value": { "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 .ova.gz from is in progress", "progress": "imageDownloadMonitor", "state": "running" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cos-image.read" ] } ], "summary": "Get detail of last cos-image import job", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cos-image.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cos-images \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.v1.cloudinstances.cosimages.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCosImageImportJob" } } }, "description": "Parameters for the creation of a new cos-image import job", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted, cos-image import successfully added to the jobs queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/jobs/c113467d-8419-449c-8d83-259dda713d9e", "jobID": "c113467d-8419-449c-8d83-259dda713d9e" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cos-image.create" ] } ], "summary": "Create an cos-image import job", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.import" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cos-image.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/cos-images \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"imageName\": \"my-image-catalog-name\",\n \"region\": \"us-east\",\n \"imageFilename\": \"my-os-image-file.ova.gz\",\n \"bucketName\": \"my-cos-bucket-name\",\n \"accessKey\": \"my-cos-bucket-access-key\",\n \"secretKey\": \"my-cos-bucket-secret-key\",\n \"storageType\": \"tier3\" \n \"storagePool\": \"StoragePool-3\"\n \"storageAffinity\": {\n \"affinityPolicy\": \"affinity\",\n \"affinityPVMInstance\": \"testVM3\", \n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/events": { "get": { "operationId": "pcloud.events.getsince", "parameters": [ { "$ref": "#/components/parameters/time" }, { "$ref": "#/components/parameters/from_time" }, { "$ref": "#/components/parameters/to_time" }, { "$ref": "#/components/parameters/accept_language" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Events" }, "examples": { "response": { "value": { "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" } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.event.list" ] } ], "summary": "Get events from this cloud instance since a specific timestamp", "tags": [ "PCloudEvents" ], "x-ibm-events": { "events": [ { "name": "power-iaas.event.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.event.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/events \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/events/{event_id}": { "get": { "operationId": "pcloud.events.get", "parameters": [ { "$ref": "#/components/parameters/accept_language" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Event" }, "examples": { "response": { "value": { "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" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.event.read" ] } ], "summary": "Get a single event", "tags": [ "PCloudEvents" ], "x-ibm-events": { "events": [ { "name": "power-iaas.event.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.event.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/events/$EVENT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/event_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/images": { "get": { "operationId": "pcloud.cloudinstances.images.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Images" }, "examples": { "response": { "value": { "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-04T00:00:00.000Z", "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-03T00:00:00.000Z", "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance-image.list" ] } ], "summary": "List all images for this cloud instance", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance-image.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/images \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.cloudinstances.images.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateImage" } } }, "description": "Parameters for the creation of a new image from available images", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" }, "examples": { "response": { "value": { "creationDate": "2024-10-02T20:16:12.000Z", "imageID": "2e456abe-3948-de91-3913-efca59681745", "lastUpdateDate": "2024-10-02T20:16:13.000Z", "maxImageVolumeSize": 20, "name": "7100-05-07T00:00:00.000Z", "servers": [], "size": 20, "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "", "volumes": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-image.create" ] } ], "summary": "Create a new Image (from available images)", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.import" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-image.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/images \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"source\": \"root-project\",\n \"imageID\": \"b39f1013-6d26-4585-856d-8aa4ea5e9ee9\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}": { "delete": { "operationId": "pcloud.cloudinstances.images.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-image.delete" ] } ], "summary": "Delete an Image from a Cloud Instance", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-image.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/images/$IMAGE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.cloudinstances.images.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" }, "examples": { "response": { "value": { "creationDate": "2019-09-11T16:10:00.000Z", "imageID": "b39f1013-6d26-4585-856d-8aa4ea5e9ee9", "lastUpdateDate": "2019-09-11T16:10:17.000Z", "name": "7200-03-03T00:00:00.000Z", "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 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance-image.read" ] } ], "summary": "Detailed info of an image", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance-image.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/images/$IMAGE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/image_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/images/{image_id}/export": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/image_id" } ], "post": { "deprecated": true, "description": "This API is deprecated for /pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export.\n\n>*Note*: Support for this API is available till Oct 2022.\n", "operationId": "pcloud.cloudinstances.images.export.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportImage" } } }, "description": "Parameters for exporting an image", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.image-export.create" ] } ], "summary": "Export an image", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.export" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.image-export.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/images/$IMAGE_ID/export \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"bucketName\": \"cloud-object-storage-bucket\"\n \"accessKey\": \"347aa3a4b34344f8bc7c7cccdf856e4c\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/jobs": { "get": { "operationId": "pcloud.cloudinstances.jobs.getall", "parameters": [ { "$ref": "#/components/parameters/operation_id" }, { "$ref": "#/components/parameters/operation_target" }, { "$ref": "#/components/parameters/operation_action" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Jobs" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.job.list" ] } ], "summary": "List up to the last 5 jobs initiated by the cloud instance", "tags": [ "PCloudJobs" ], "x-ibm-events": { "events": [ { "name": "power-iaas.job.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.job.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/jobs \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/jobs/{job_id}": { "delete": { "operationId": "pcloud.cloudinstances.jobs.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.job.delete" ] } ], "summary": "Delete a cloud instance job", "tags": [ "PCloudJobs" ], "x-ibm-events": { "events": [ { "name": "power-iaas.job.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.job.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/jobs/$JOB_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.cloudinstances.jobs.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.job.read" ] } ], "summary": "List the detail of a job", "tags": [ "PCloudJobs" ], "x-ibm-events": { "events": [ { "name": "power-iaas.job.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.job.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/jobs/$JOB_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/job_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/locations/disaster-recovery": { "get": { "operationId": "pcloud.locations.disasterrecovery.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisasterRecoveryLocation" }, "examples": { "response": { "value": { "location": "dal12", "replicationSites": [ { "isActive": true, "location": "us-east" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.disaster-recovery.read" ] } ], "summary": "Get the disaster recovery site details for the current location", "tags": [ "PCloudDisasterRecovery" ], "x-ibm-events": { "events": [ { "name": "power-iaas.disaster-recovery.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.disaster-recovery.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/locations/disaster-recovery \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/networks": { "get": { "operationId": "pcloud.networks.getall", "parameters": [ { "$ref": "#/components/parameters/filter" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Networks" }, "examples": { "response": { "value": { "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/networks/392913e3-e8ac-406b-a061-b431ee4bd239", "jumbo": false, "mtu": 1450, "name": "test-ibm-network", "networkID": "392913e3-e8ac-406b-a061-b431ee4bd239", "type": "vlan", "vlanID": 3314 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network.list" ] } ], "summary": "Get all networks in this cloud instance", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.networks.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkCreate" } } }, "description": "Parameters for the creation of a new network", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" }, "examples": { "response": { "value": { "cidr": "195.168.0.0/24", "dnsServers": [ "127.0.0.1" ], "gateway": "195.168.0.1", "ipAddressMetrics": { "available": 253, "total": 253, "used": 0, "utilization": 0 }, "ipAddressRanges": [ { "endingIPAddress": "195.168.0.254", "startingIPAddress": "195.168.0.2" } ], "mtu": 1450, "name": "test-net", "networkID": "2e456abe-3948-de91-3913-efca59681745", "type": "vlan", "vlanID": 964 } } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "550": { "description": "Workspace Status Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network.create" ] } ], "summary": "Create a new Network", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"type\": \"vlan\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}": { "delete": { "operationId": "pcloud.networks.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network.delete" ] } ], "summary": "Delete a Network", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.networks.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" }, "examples": { "response": { "value": { "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, "mtu": 1450, "name": "testMangala1", "networkID": "392913e3-e8ac-406b-a061-b431ee4bd239", "type": "vlan", "vlanID": 3314 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network.read" ] } ], "summary": "Get a network's current state/information", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/network_id" } ], "put": { "operationId": "pcloud.networks.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkUpdate" } } }, "description": "Parameters to update a Network", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Network" }, "examples": { "response": { "value": { "cidr": "195.168.0.0/24", "dnsServers": [ "127.0.0.1" ], "gateway": "195.168.0.1", "ipAddressMetrics": { "available": 125, "total": 125, "used": 0, "utilization": 0 }, "ipAddressRanges": [ { "endingIPAddress": "195.168.0.128", "startingIPAddress": "195.168.0.4" } ], "mtu": 1450, "name": "test-net", "networkID": "2e456abe-3948-de91-3913-efca59681745", "type": "vlan", "vlanID": 964 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network.update" ] } ], "summary": "Update a Network", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"ipAddressRanges\": {\n \"startingIPAddress\": \"192.168.100.4\"\n \"endingIPAddress\": \"192.168.103.254\"\n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports": { "get": { "deprecated": true, "description": "This API is deprecated for /v1/networks/{network_id}/network-interfaces.\n", "operationId": "pcloud.networks.ports.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPorts" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-port.list" ] } ], "summary": "Get all ports for this network", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.port.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-port.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID/ports \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/network_id" } ], "post": { "deprecated": true, "description": "This API is deprecated for /v1/networks/{network_id}/network-interfaces.\n", "operationId": "pcloud.networks.ports.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPortCreate" } } }, "description": "Create a Network Port" }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPort" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-port.create" ] } ], "summary": "Perform port addition, deletion, and listing", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.port.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-port.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID/ports \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/networks/{network_id}/ports/{port_id}": { "delete": { "deprecated": true, "description": "This API is deprecated for /v1/networks/{network_id}/network-interfaces/{network_interface_id}.\n", "operationId": "pcloud.networks.ports.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-port.delete" ] } ], "summary": "Delete a Network Port", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.port.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-port.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": null } } }, "get": { "deprecated": true, "description": "This API is deprecated for /v1/networks/{network_id}/network-interfaces/{network_interface_id}.\n", "operationId": "pcloud.networks.ports.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPort" }, "examples": { "response": { "value": { "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" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-port.read" ] } ], "summary": "Get a port's information", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.port.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-port.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID/ports/$PORT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/network_id" }, { "$ref": "#/components/parameters/port_id" } ], "put": { "deprecated": true, "description": "This API is deprecated for /v1/networks/{network_id}/network-interfaces/{network_interface_id}.\n", "operationId": "pcloud.networks.ports.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPortUpdate" } } }, "description": "Parameters for updating a Port", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkPort" }, "examples": { "response": { "value": { "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" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-port.update" ] } ], "summary": "Update a port's information", "tags": [ "PCloudNetworks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.port.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-port.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/networks/$NETWORK_ID/ports/$PORT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"description\": \"port-description\"\n \"pvmInstanceID\": \"pvm-instance-id\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups": { "get": { "operationId": "pcloud.placementgroups.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroups" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.placement-group.list" ] } ], "summary": "Get all Server Placement Groups", "tags": [ "PCloudPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.placement-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.placement-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/placement-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.placementgroups.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroupCreate" } } }, "description": "Parameters for the creation of a new Server Placement Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroup" }, "examples": { "response": { "value": { "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f", "members": [], "name": "MyAffinity-servergroup-1620150831", "policy": "affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.placement-group.create" ] } ], "summary": "Create a new Server Placement Group", "tags": [ "PCloudPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.placement-group.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.placement-group.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/placement-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"MyAffinity-servergroup-1620150831\",\n \"policy\": \"affinity\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}": { "delete": { "operationId": "pcloud.placementgroups.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.placement-group.delete" ] } ], "summary": "Delete Server Placement Group", "tags": [ "PCloudPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.placement-group.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.placement-group.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/placement-groups/$PLACEMENT_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.placementgroups.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroup" }, "examples": { "response": { "value": { "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f", "members": [ "541c1cda-a8da-4081-8020-3a0ce9850ca0" ], "name": "MyAffinity-servergroup-1620150831", "policy": "affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.placement-group.read" ] } ], "summary": "Get Server Placement Group detail", "tags": [ "PCloudPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.placement-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.placement-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/placement-groups/$PLACEMENT_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/placement_group_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/placement-groups/{placement_group_id}/members": { "delete": { "operationId": "pcloud.placementgroups.members.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroupServer" } } }, "description": "Parameters for removing a Server in a Placement Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroup" }, "examples": { "response": { "value": { "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f", "members": [], "name": "MyAffinity-servergroup-1620150831", "policy": "affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.placement-group-member.delete" ] } ], "summary": "Remove Server from Placement Group", "tags": [ "PCloudPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.placement-groups.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.placement-group-member.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/placement-groups/$PLACEMENT_GROUP_ID/members \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"id\": \"541c1cda-a8da-4081-8020-3a0ce9850ca0\",\n }'" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/placement_group_id" } ], "post": { "operationId": "pcloud.placementgroups.members.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroupServer" } } }, "description": "Parameters for adding a server to a Server Placement Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlacementGroup" }, "examples": { "response": { "value": { "id": "7a3583cc-85ec-4589-b5b5-b5d7af58354f", "members": [ "541c1cda-a8da-4081-8020-3a0ce9850ca0" ], "name": "MyAffinity-servergroup-1620150831", "policy": "affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.placement-group-member.create" ] } ], "summary": "Add Server to Placement Group", "tags": [ "PCloudPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.placement-groups.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.placement-group-member.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/placement-groups/$PLACEMENT_GROUP_ID/members \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"id\": \"541c1cda-a8da-4081-8020-3a0ce9850ca0\",\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pod-capacity": { "get": { "description": "Applicable to satellite locations only.", "operationId": "pcloud.podcapacity.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PodCapacity" }, "examples": { "response": { "value": { "PodData": { "cores": 19.9, "memory": 4737, "satLocationID": "satloc_dal_clp394838u3uhfu2hf48", "storage": 374486, "totalCores": 160.6, "totalMemory": 6420, "totalPhysCores": 360, "totalPhysMemory": 7936, "totalPhysStorage": 1608770, "totalStorage": 409600 }, "StorageControllers": { "192166272": { "displayName": "ibm001-flash-1", "health": "OK", "poolStorage": 181882, "poolTotalStorage": 204800, "pools": { "general-flash-1": { "poolName": "general-flash-1", "storage": 181882, "totalStorage": 204800 } } }, "192166274": { "displayName": "ibm001-flash-2", "health": "OK", "poolStorage": 192604, "poolTotalStorage": 204800, "pools": { "general-flash-2": { "poolName": "general-flash-2", "storage": 192604, "totalStorage": 204800 } } }, "generic0": { "displayName": "PVC-Lite-File_1abc", "health": "OK", "poolStorage": 0, "poolTotalStorage": 0, "pools": {} }, "generic1": { "displayName": "PVC-Lite-File_2abc", "health": "OK", "poolStorage": 0, "poolTotalStorage": 0, "pools": {} }, "generic2": { "displayName": "PVC-Lite-File_3abc", "health": "OK", "poolStorage": 0, "poolTotalStorage": 0, "pools": {} }, "generic3": { "displayName": "PVC-Lite-File_4abc", "health": "OK", "poolStorage": 0, "poolTotalStorage": 0, "pools": {} }, "generic4": { "displayName": "PVC-Lite-File_5abc", "health": "OK", "poolStorage": 0, "poolTotalStorage": 0, "pools": {} } }, "SystemPools": { "e1050": { "cores": 13.06, "memory": 1887, "systems": [ { "cores": 13.06, "id": 23, "memory": 1887, "totalCores": 61.66, "totalMemory": 2262, "totalPhysCores": 120, "totalPhysMemory": 2560 } ], "totalCores": 61.66, "totalMemory": 2262, "totalPhysCores": 120, "totalPhysMemory": 2560 }, "e1080": { "cores": 1.69, "memory": 2782, "systems": [ { "cores": 1.69, "id": 14, "memory": 2782, "totalCores": 58.44, "totalMemory": 3303, "totalPhysCores": 120, "totalPhysMemory": 3840 } ], "totalCores": 58.44, "totalMemory": 3303, "totalPhysCores": 120, "totalPhysMemory": 3840 }, "s1022": { "cores": 5.15, "memory": 68, "systems": [ { "cores": 2.69, "id": 20, "memory": 58, "totalCores": 16.24, "totalMemory": 311, "totalPhysCores": 40, "totalPhysMemory": 512 }, { "cores": 2.42, "id": 5, "memory": 1, "totalCores": 13.37, "totalMemory": 382, "totalPhysCores": 40, "totalPhysMemory": 512 }, { "cores": 0.04, "id": 11, "memory": 9, "totalCores": 10.89, "totalMemory": 162, "totalPhysCores": 40, "totalPhysMemory": 512 } ], "totalCores": 40.5, "totalMemory": 855, "totalPhysCores": 120, "totalPhysMemory": 1536 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.pod-capacity.view" ] } ], "summary": "List of available resources within a particular Pod", "tags": [ "PCloudPodCapacity" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pod-capacity.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Required for satellite locations, ignored for public data centers.", "name": "power-iaas.pod-capacity.view" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pod-capacity \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances": { "get": { "operationId": "pcloud.pvminstances.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstances" }, "examples": { "response": { "value": { "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" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance.list" ] } ], "summary": "Get all the pvm instances for this cloud instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.pvminstances.post", "parameters": [ { "description": "Option to skip host validation on PVMInstance Create API", "in": "query", "name": "skipHostValidation", "schema": { "type": "boolean" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceCreate" } } }, "description": "Parameters for the creation of a new Power VM Instance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceList" }, "examples": { "response": { "value": { "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" ] } } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceList" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceList" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance.create" ] } ], "summary": "Create a new Power VM Instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"serverName\": \"server-name\"\n \"imageID\": \"image-id\"\n \"placementGroup\": \"7a3583cc-85ec-4589-b5b5-b5d7af58354f\"\n \"processors\" \"number-of-processors\"\n \"procType\": \"dedicated\"\n \"memory\": \"amount-of-memory\"\n \"networkIDs\": \"list-network-ids\"\n \"sysType\": \"s922\"\n \"volumeIDs\": [\"data-volume-1\", \"data-volume-2\"]\n \"storageType\": \"tier1\"\n \"storagePool\": \"StoragePool-3\"\n \"storageAffinity\": {\n \"affinityPVMInstance\": \"testVM3\",\n \"affinityPolicy\": \"affinity\",\n \"antiAffinityPVMInstances\": null,\n \"antiAffinityVolumes\": null\n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}": { "delete": { "operationId": "pcloud.pvminstances.delete", "parameters": [ { "$ref": "#/components/parameters/delete_data_volumes" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceDelete" } } }, "description": "Parameters to delete a PVM Instance" }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance.delete" ] } ], "summary": "Delete a PCloud PVM Instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.pvminstances.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstance" }, "examples": { "response": { "value": { "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" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance.read" ] } ], "summary": "Get a PVM Instance's current state or information", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "put": { "operationId": "pcloud.pvminstances.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceUpdate" } } }, "description": "Parameters to update a PCloud PVM Instance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted (this is a long running operation)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceUpdateResponse" }, "examples": { "response": { "value": { "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" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance.update" ] } ], "summary": "Update a PCloud PVM Instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"serverName\": server-name\n \"processors\": number-of-processors\n \"procType\": \"dedicated\"\n \"memory\": \"4\"\n \"migratable\": \"false\"\n \"softwareLicenses\": \"software-licenses\"\n \"pinPolicy\": \"soft\"\n \"storagePoolAffinity\": true\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/action": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "description": "Corresponding actions are 'start', 'stop', 'reboot', 'immediate-shutdown', 'reset'", "operationId": "pcloud.pvminstances.action.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceAction" } } }, "description": "Parameters for the desired action", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance.action" ] } ], "summary": "Perform an action on a PVMInstance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.start" }, { "name": "power-iaas.pvm-instance.stop" }, { "name": "power-iaas.pvm-instance.immediate-shutdown" }, { "name": "power-iaas.pvm-instance.renew" }, { "name": "power-iaas.pvm-instance.unknown" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance.action" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/action \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\" \\\n -H 'crn: ' \\\n -d '{\n \"action\":\"immediate-shutdown\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "deprecated": true, "description": "This API is deprecated for /pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture.\n\n>*Note*: Support for this API is available till Oct 2022.\n", "operationId": "pcloud.pvminstances.capture.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceCapture" } } }, "description": "Parameters for the capture PVMInstance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "202": { "description": "Accepted, upload to cloud storage in progress", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-capture.create" ] } ], "summary": "Capture a PVMInstance and create a deployable image", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.capture" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-capture.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/capture \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"captureName\": \"deployable-image-name\"\n \"captureDestination\": \"deployable-image-destination\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/console": { "get": { "operationId": "pcloud.pvminstances.console.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleLanguages" }, "examples": { "response": { "value": { "consoleLanguages": [ { "code": "1399", "language": "1399 Japanese (Latin Unicode Extended)" }, { "code": "e1399", "language": "e1399 Japanese (Latin Unicode Extended: JIS2014)" }, { "code": "037", "language": "037 English" }, { "code": "930", "language": "930 Japanese (Katakana)" }, { "code": "e930", "language": "e930 Japan (Katakana Extended)" }, { "code": "939", "language": "939 Japan (Latin Extended)" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-console.read" ] } ], "summary": "List all console languages", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.monitor" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-console.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/console \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "operationId": "pcloud.pvminstances.console.post", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceConsole" }, "examples": { "response": { "value": { "consoleURL": "https://dal12-console.power-iaas.test.cloud.ibm.com/console/index.html?path=%3Ftoken%393239203d-ed93-2831-3848-388187472cba" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-console.create" ] } ], "summary": "Generate the noVNC Console URL", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.monitor" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-console.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/console \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "put": { "operationId": "pcloud.pvminstances.console.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleLanguage" } } }, "description": "Parameters to update a PVMInstance console required codepage", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConsoleLanguage" }, "examples": { "response": { "value": { "code": "e1399" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-console.update" ] } ], "summary": "Update PVMInstance console language code", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.monitor" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-console.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/console \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"code\": \"e1399\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks": { "get": { "operationId": "pcloud.pvminstances.networks.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceNetworks" }, "examples": { "response": { "value": { "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 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-network.list" ] } ], "summary": "Get all networks for this PVM Instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance-network.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-network.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "operationId": "pcloud.pvminstances.networks.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceAddNetwork" } } }, "description": "Add network to PVM Instance parameters", "required": true }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceNetwork" }, "examples": { "response": { "value": { "href": "/pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/pvm-instances/9cb9384d-9b0e-4cb9-a8b5-b0ec7977dc3f/networks/f89dce15-e05f-46cf-8350-3eeb8cbe40ba", "ip": "195.166.0.111", "ipAddress": "195.166.0.111", "macAddress": "fa:38:e6:a8:19:20", "networkID": "8838dcff-d423-4490-aa95-7bfed54adbae", "type": "fixed", "version": 4 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-network.create" ] } ], "summary": "Perform network addition", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance-network.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-network.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"networkID\": \"network-ID\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/networks/{network_id}": { "delete": { "operationId": "pcloud.pvminstances.networks.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceRemoveNetwork" } } }, "description": "Remove a network from PVM Instance parameters" }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-network.delete" ] } ], "summary": "Remove all Address of Network from a PVM Instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance-network.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-network.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.pvminstances.networks.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceNetworks" }, "examples": { "response": { "value": { "networks": [ { "externalIP": "xxx.xxx.xxx.xxx", "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 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-network.read" ] } ], "summary": "Get a PVM Instance's network information", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance-network.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-network.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/networks/$NETWORK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" }, { "$ref": "#/components/parameters/network_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/operations": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "operationId": "pcloud.pvminstances.operations.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceOperation" } } }, "description": "Parameters for the desired operations", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance.operation" ] } ], "summary": "Perform an operation on a PVMInstance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.operation" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance.operation" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/operations \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"operationType\":\"boot\"\n \"operation\": {\n \"bootMode\": \"a\", (Possible values: a, b, c, d)\n \"operatingMode\": \"manual\", (Possible values: normal or manual)\n \"task\":\"iopresent (Possible values: dston, retrydump, consoleservice, iopreset, remotedstoff, remotedston, iopdump, dumprestart)\n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots": { "get": { "operationId": "pcloud.pvminstances.snapshots.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshots" }, "examples": { "response": { "value": { "snapshots": [ { "action": "snapshot", "creationDate": "2022-08-16T08:02:05.000Z", "description": "test", "lastUpdateDate": "2022-08-16T08:02:14.000Z", "name": "test-abcd-snap", "percentComplete": 100, "pvmInstanceID": "2eee5ae2-66d2-435d-8e8b-32f80a65df23", "snapshotID": "4f37a134-4822-4e86-b56b-d95e82cb056c", "status": "available", "volumeSnapshots": { "f57e242f-203d-4678-bde5-a8f1792e9117": "fa62198c-f614-4750-983a-671b67a38ef3" } }, { "action": "snapshot", "creationDate": "2022-08-16T08:13:25.000Z", "description": "test", "lastUpdateDate": "2022-08-16T08:13:34.000Z", "name": "test-abcd-snap1", "percentComplete": 100, "pvmInstanceID": "2eee5ae2-66d2-435d-8e8b-32f80a65df23", "snapshotID": "59cadf8d-e553-4509-81f4-2889f2a21104", "status": "available", "volumeSnapshots": { "f57e242f-203d-4678-bde5-a8f1792e9117": "c37a50dc-cda3-4cba-8254-2cc8b8ee806" } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-snapshot.list" ] } ], "summary": "Get all snapshots for this PVM Instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-snapshot.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/snapshots \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "operationId": "pcloud.pvminstances.snapshots.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotCreate" } } }, "description": "PVM Instance snapshot create parameters", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotCreateResponse" }, "examples": { "response": { "value": { "snapshotID": "je47ff70-55c9-4cf5-965a-ecdf90e7d78a" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-snapshot.create" ] } ], "summary": "Create a PVM Instance snapshot", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.snapshot" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-snapshot.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/snapshots \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"VM1-SS\",\n \"description\": \"Snapshot for VM1\",\n \"volumeIDs\":[\"VM1-7397dc00-0000035b-boot-0\"]\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/snapshots/{snapshot_id}/restore": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" }, { "$ref": "#/components/parameters/snapshot_id" }, { "$ref": "#/components/parameters/restore_fail_action" } ], "post": { "operationId": "pcloud.pvminstances.snapshots.restore.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotRestore" } } }, "description": "PVM Instance snapshot restore parameters", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "response": { "value": { "action": "action", "creationDate": "2000-01-23T04:56:07.000Z", "description": "snapshot restore", "lastUpdateDate": "2000-01-23T04:56:07.000Z", "name": "name", "percentComplete": 0, "pvmInstanceID": "pvmInstanceID", "snapshotID": "snapshotID", "status": "status", "volumeSnapshots": { "key": "volumeSnapshots" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-snapshot.restore" ] } ], "summary": "Restore a PVM Instance snapshot", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-snapshot.restore" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/snapshots/$SNAPSHOT_ID/restore \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"force\": \"true\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/virtual-serial-number": { "delete": { "operationId": "pcloud.pvminstances.virtualserialnumber.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteServerVirtualSerialNumber" } } }, "description": "Parameters to unassign a Virtual Serial Number attached to a PVM Instance" }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance.virtual-serial-number.delete" ] } ], "summary": "Unassign Virtual Serial Number from a PVM Instance", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.virtual-serial-number.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance.virtual-serial-number.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$INSTANCE_ID/virtual-serial-number \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.pvminstances.virtualserialnumber.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSerialNumber" }, "examples": { "response": { "value": { "description": "VSN for VM-1", "pvmInstanceID": "8ab7ede5-540e-44bc-99cf-9c8bf1ac6297", "serial": "VS0162B" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance.virtual-serial-number.read" ] } ], "summary": "Get a PVM Instance's Virtual Serial Number Information", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.virtual-serial-number.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance.virtual-serial-number.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$INSTANCE_ID/virtual-serial-number \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "operationId": "pcloud.pvminstances.virtualserialnumber.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddServerVirtualSerialNumber" } } }, "description": "Parameters to assign Virtual Serial Number to a PVM Instance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSerialNumber" }, "examples": { "response": { "value": { "description": "VSN for VM-1", "pvmInstanceID": "8ab7ede5-540e-44bc-99cf-9c8bf1ac6297", "serial": "VS0162B" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-virtual-serial-number.create" ] } ], "summary": "Assign Virtual Serial Number to a PVM Instance", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.virtual-serial-number" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-virtual-serial-number.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$INSTANCE_ID/virtual-serial-number \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"serial\": \"auto-assign\"\n }`" ] } ] } ] } } }, "put": { "operationId": "pcloud.pvminstances.virtualserialnumber.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateServerVirtualSerialNumber" } } }, "description": "Parameters to update a Virtual Serial Number description", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSerialNumber" }, "examples": { "response": { "value": { "description": "VSN for VM-1", "pvmInstanceID": "8ab7ede5-540e-44bc-99cf-9c8bf1ac6297", "serial": "VS0162B" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-virtual-serial-number.update" ] } ], "summary": "Update a Virtual Serial Number", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.virtual-serial-number.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-virtual-serial-number.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$INSTANCE_ID/virtual-serial-number \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"description\": \"test-description\"\n }`" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes": { "get": { "operationId": "pcloud.pvminstances.volumes.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volumes" }, "examples": { "response": { "value": { "volumes": [ { "bootVolume": true, "bootable": true, "creationDate": "2020-04-22T16:16:08.000Z", "diskType": "tier1", "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/volumes/22f701a6-81a5-4df9-8c0b-eaec1c5e8bc7", "lastUpdateDate": "2020-04-22T16:16:21.000Z", "name": "testVolume", "pvmInstanceIDs": [ "6c98be83-bc60-441d-bd37-9894b58ec98c" ], "shareable": false, "size": 20, "state": "in-use", "volumeID": "22f701a6-81a5-4df9-8c0b-eaec1c5e8bc7", "volumePool": "Tier1-Flash-1", "volumeType": "Tier1-Flash-1", "wwn": 9.00507640081029e+31 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-volume.list" ] } ], "summary": "List all volumes attached to a PVM Instance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-volume.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}": { "delete": { "operationId": "pcloud.pvminstances.volumes.delete", "responses": { "202": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-volume.delete" ] } ], "summary": "Detach a volume from a PVMInstance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.configure" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-volume.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.pvminstances.volumes.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volume" }, "examples": { "response": { "value": { "bootable": true, "creationDate": "2020-04-22T16:16:08.000Z", "diskType": "tier1", "lastUpdateDate": "2020-04-22T16:16:21.000Z", "name": "testVolume", "pvmInstanceIDs": [ "6c98be83-bc60-441d-bd37-9894b58ec98c" ], "shareable": false, "size": 20, "state": "in-use", "volumeID": "22f701a6-81a5-4df9-8c0b-eaec1c5e8bc7", "volumePool": "Tier1-Flash-1", "volumeType": "Tier1-Flash-1", "wwn": 9.00507640081029e+31 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-volume.read" ] } ], "summary": "Detailed info of a volume attached to a PVMInstance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-volume.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" }, { "$ref": "#/components/parameters/volume_id" } ], "post": { "description": "Attach a volume to a PVMInstance.\n>**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.", "operationId": "pcloud.pvminstances.volumes.post", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-volume.create" ] } ], "summary": "Attach a volume to a PVMInstance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.configure" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-volume.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "put": { "operationId": "pcloud.pvminstances.volumes.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceVolumeUpdate" } } }, "description": "Parameters to update a volume attached to a PVMInstance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-volume.update" ] } ], "summary": "Update a volume attached to a PVMInstance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.configure" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-volume.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"deleteOnTermination\": \"true\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes/{volume_id}/setboot": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" }, { "$ref": "#/components/parameters/volume_id" } ], "put": { "description": "Set the PVMInstance volume as the boot volume.\n>**Note**: If a non-bootable volume is provided, it will be converted to a bootable volume and then attached.", "operationId": "pcloud.pvminstances.volumes.setboot.put", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-boot-volume.update" ] } ], "summary": "Set the PVMInstance volume as the boot volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.configure" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-boot-volume.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes/$VOLUME_ID/setboot \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/sap": { "get": { "operationId": "pcloud.sap.getall", "parameters": [ { "$ref": "#/components/parameters/profile_prefix_filter" }, { "$ref": "#/components/parameters/profile_family_filter" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SAPProfiles" }, "examples": { "response": { "value": { "profiles": [ { "certified": true, "cores": 1, "defaultSystem": "e980", "fullSystemProfile": false, "memory": 4, "profileID": "test-1x4", "saps": 12000, "smtMode": 8, "supportedSystems": [ "e980" ], "type": "compute", "workloadTypes": [ "OLAP" ] }, { "certified": false, "cores": 16, "defaultSystem": "e980", "fullSYstemProfile": false, "memory": 1600, "profileID": "test-16x1600", "saps": 24000, "smtMode": 8, "supportedSystems": [ "e980" ], "type": "balanced", "workloadTypes": [ "OLAP" ] }, { "certified": false, "cores": 20, "defaultSystem": "e980", "fullSystemProfile": true, "memory": 2000, "profileID": "test-20x2000", "saps": 24000, "smtMode": 4, "supportedSystems": [ "e980" ], "type": "balanced", "workloadTypes": [ "OLAP", "OLTP" ] } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.sap.list" ] } ], "summary": "Get list of SAP profiles", "tags": [ "PCloudSAP" ], "x-ibm-events": { "events": [ { "name": "power-iaas.sap.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.sap.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/sap \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.sap.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SAPCreate" } } }, "description": "Parameters for the creation of a new SAP PVM Instance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceList" }, "examples": { "response": { "value": [ { "addresses": [ { "networkID": "26038c24-fdde-4982-8d86-eaf01ab0cf7d" } ], "creationDate": "1901-01-01T00:00:00.000Z", "diskSize": 100, "imageID": "ed37bc0b-1968-4d88-96a2-30fe4e977e1b", "memory": 4, "networkIDs": [ "26038c24-fdde-4982-8d86-eaf01ab0cf7d" ], "networks": [ { "networkID": "26038c24-fdde-4982-8d86-eaf01ab0cf7d" } ], "osType": "rhel", "pinPolicy": "none", "procType": "dedicated", "processors": 1, "pvmInstanceID": "72820ebc-97fb-4898-a763-4a6ccfc60dff", "sapProfile": { "href": "/pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/sap/tinytest-1x4", "profileID": "tinytest-1x4" }, "serverName": "test-rj-sap", "srcs": [], "status": "BUILDING", "storagePool": "Tier1-Flash-2", "storageType": "tier1", "sysType": "e980", "updatedDate": "1901-01-01T00:00:00.000Z", "volumeIDs": [] } ] } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceList" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceList" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.sap.create" ] } ], "summary": "Create a new SAP PVM Instance", "tags": [ "PCloudSAP" ], "x-ibm-events": { "events": [ { "name": "power-iaas.sap.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.sap.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/sap \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"imageID\": \"01234567-abcd-abcd-abcd-012345678901\",\n \"name\": \"test-instance\",\n \"networks\": [\n {\n \"networkID\": \"01234567-abcd-abcd-abcd-012345678902\"\n }\n ],\n \"pinPolicy\": \"none\",\n \"placementGroup\": \"01234567-abcd-abcd-abcd-012345678906\",\n \"profileID\": \"profile-name\",\n \"sshKeyName\": \"ssh-key-name\",\n \"storageAffinity\": {\n \"affinityPolicy\": \"anti-affinity\",\n \"antiAffinityPVMInstances\": null,\n \"antiAffinityVolumes\": [\n \"01234567-abcd-abcd-abcd-012345678903\"\n ]\n },\n \"storageType\": \"tier1\",\n \"sysType\": \"e980\",\n \"userData\": \"encoded-base64-user-data\",\n \"volumeIDs\": [\n \"01234567-abcd-abcd-abcd-012345678904\",\n \"01234567-abcd-abcd-abcd-012345678905\"\n ]\n }" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/sap/{sap_profile_id}": { "get": { "operationId": "pcloud.sap.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SAPProfile" }, "examples": { "response": { "value": { "certified": true, "cores": 4, "defaultSystem": "e980", "fullSystemProfile": false, "memory": 128, "profileID": "ush1-4x128", "saps": 24000, "smtMode": 8, "supportedSystems": [ "e880", "e980" ], "type": "small", "workloadTypes": [ "OLAP/OLTP" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.sap.read" ] } ], "summary": "Get the information on an SAP profile", "tags": [ "PCloudSAP" ], "x-ibm-events": { "events": [ { "name": "power-iaas.sap.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.sap.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/sap/$SAP_PROFILE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/sap_profile_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/shared-processor-pools": { "get": { "operationId": "pcloud.sharedprocessorpools.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProcessorPools" }, "examples": { "response": { "value": { "sharedProcessorPools": [ { "allocatedCores": 5, "availableCores": 0, "hostGroup": "s922", "hostID": 308, "id": "5f0e3a10-0a33-4197-bb51-c9db4f530951", "name": "SPP1", "reservedCores": 5, "sharedProcessorPoolPlacementGroups": [ { "id": "ad20e260-b4cd-4d51-aad7-95f75487dc67", "name": "SPPPG4", "policy": "anti-affinity" }, { "id": "402f58c5-bbe5-4d07-9853-8a7bc6522717", "name": "SPPPG3", "policy": "affinity" } ], "status": "active", "statusDetail": "shared processor pool SPP1 is active" }, { "allocatedCores\"": 0, "availableCores": 4, "hostGroup": "e980", "hostID": 408, "id": "4f22601f-28e2-4eb3-b6ef-6d5a6328ea3b", "name": "spp_2", "reservedCores": 4, "sharedProcessorPoolPlacementGroups": [], "status": "active", "statusDetail": "shared processor pool spp_2 is active" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.shared-processor-pool.list" ] } ], "summary": "Get the list of Shared Processor Pools for a cloud instance", "tags": [ "PCloudSharedProcessorPools" ], "x-ibm-events": { "events": [ { "name": "power-iaas.shared-processor-pool.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.shared-processor-pool.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/shared-processor-pools \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.sharedprocessorpools.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProcessorPoolCreate" } } }, "description": "Parameters for the creation of a new Shared Processor Pool", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProcessorPool" }, "examples": { "response": { "value": { "id": "95e79570-1339-46da-9999-2a49ee141dda", "name": "SPP2", "reservedCores": 3, "status": "configuring", "statusDetail": "“configuration of shared processor pool SPP2 in progress”" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.shared-processor-pool.create" ] } ], "summary": "Create a new Shared Processor Pool", "tags": [ "PCloudSharedProcessorPools" ], "x-ibm-events": { "events": [ { "name": "power-iaas.shared-processor-pool.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.shared-processor-pool.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/shared-processor-pools \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"hostGroup\": \"string\"\n \"name\": \"string\"\n \"placementGroupID\": \"string\"\n \"reservedCores\": 0 \n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/shared-processor-pools/{shared_processor_pool_id}": { "delete": { "operationId": "pcloud.sharedprocessorpools.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.shared-processor-pool.delete" ] } ], "summary": "Delete a Shared Processor Pool from a cloud instance", "tags": [ "PCloudSharedProcessorPools" ], "x-ibm-events": { "events": [ { "name": "power-iaas.shared-processor-pool.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.shared-processor-pool.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/shared-processor-pools/$SHARED_PROCESSOR_POOL_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.sharedprocessorpools.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProcessorPoolDetail" }, "examples": { "response": { "value": { "allocatedCores": 5, "availableCores": 0, "hostGroup": "s922", "hostID": 308, "id": "5f0e3a10-0a33-4197-bb51-c9db4f530951", "name": "SPP1", "reservedCores": 5, "sharedProcessorPoolPlacementGroups": [ { "id": "ad20e260-b4cd-4d51-aad7-95f75487dc67", "name": "SPPPG4", "policy": "anti-affinity" }, { "id": "402f58c5-bbe5-4d07-9853-8a7bc6522717", "name": "SPPPG3", "policy": "affinity" } ], "status": "active", "statusDetail": "shared processor pool SPP1 is active" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.shared-processor-pool.read" ] } ], "summary": "Get the detail of a Shared Processor Pool for a cloud instance", "tags": [ "PCloudSharedProcessorPools" ], "x-ibm-events": { "events": [ { "name": "power-iaas.shared-processor-pool.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.shared-processor-pool.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/shared-processor-pools/$SHARED_PROCESSOR_POOL_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/shared_processor_pool_id" } ], "put": { "operationId": "pcloud.sharedprocessorpools.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProcessorPoolUpdate" } } }, "description": "Parameters for the update of a Shared Processor Pool", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SharedProcessorPool" }, "examples": { "response": { "value": { "allocatedCores": 6, "availableCores": 0, "hostGroup": "s922", "hostID": 308, "id": "5f0e3a10-0a33-4197-bb51-c9db4f530951", "name": "SPP_DB", "reservedCores": 6, "sharedProcessorPoolPlacementGroups": [], "status": "active", "statusDetail": "shared processor pool SPP1 is active" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.shared-processor-pool.update" ] } ], "summary": "Update a Shared Processor Pool for a cloud instance", "tags": [ "PCloudSharedProcessorPools" ], "x-ibm-events": { "events": [ { "name": "power-iaas.shared-processor-pool.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.shared-processor-pool.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/shared-processor-pools/$SHARED_PROCESSOR_POOL_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"string\" \n \"reservedCores\": 0 \n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots": { "get": { "operationId": "pcloud.cloudinstances.snapshots.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshots" }, "examples": { "response": { "value": { "snapshots": [ { "action": "snapshot1", "creationDate": "2022-08-16T08:02:05.000Z", "description": "test1", "lastUpdateDate": "2022-08-16T08:02:14.000Z", "name": "test-abc-snap1", "percentComplete": 100, "pvmInstanceID": "2eee5ae2-66d2-435d-8e8b-32f80a65df23", "snapshotID": "4f37a134-4822-4e86-b56b-d95e82cb056c", "status": "available", "volumeSnapshots": { "f57e242f-203d-4678-bde5-a8f1792e9117": "fa62198c-f614-4750-983a-671b67a38ef3" } }, { "action": "snapshot2", "creationDate": "2022-09-16T08:02:05.000Z", "description": "test2", "lastUpdateDate": "2022-09-16T08:02:14.000Z", "name": "test-abc-snap2", "percentComplete": 100, "pvmInstanceID": "3abc5bf3-66d2-435d-8e8b-33f80a65df24", "snapshotID": "5g48b245-4822-4e86-b56b-d95e82cc167d", "status": "available", "volumeSnapshots": { "g68f353g-203d-4678-bde5-a8f1792f0228": "gb73209d-f614-4750-983a-782c78b49ff4" } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance-snapshot.list" ] } ], "summary": "List all PVM instance snapshots for this cloud instance", "tags": [ "PCloudSnapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance-snapshot.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/snapshots \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/snapshots/{snapshot_id}": { "delete": { "operationId": "pcloud.cloudinstances.snapshots.delete", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-snapshot.delete" ] } ], "summary": "Delete a PVM instance snapshot of a cloud instance", "tags": [ "PCloudSnapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-snapshot.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/snapshots/$SNAPSHOT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.cloudinstances.snapshots.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Snapshot" }, "examples": { "response": { "value": { "snapshots": [ { "action": "snapshot", "creationDate": "2022-08-16T08:02:05.000Z", "description": "test", "lastUpdateDate": "2022-08-16T08:02:14.000Z", "name": "test-abcd-snap", "percentComplete": 100, "pvmInstanceID": "2eee5ae2-66d2-435d-8e8b-32f80a65df23", "snapshotID": "4f37a134-4822-4e86-b56b-d95e82cb056c", "status": "available", "volumeSnapshots": { "f57e242f-203d-4678-bde5-a8f1792e9117": "fa62198c-f614-4750-983a-671b67a38ef3" } }, { "action": "snapshot", "creationDate": "2022-08-16T08:13:25.000Z", "description": "test1", "lastUpdateDate": "2022-08-16T08:13:34.000Z", "name": "test-abcd-snap1", "percentComplete": 100, "pvmInstanceID": "2eee5ae2-66d2-435d-8e8b-32f80a65df23", "snapshotID": "59cadf8d-e553-4509-81f4-2889f2a21104", "status": "available", "volumeSnapshots": { "f57e242f-203d-4678-bde5-a8f1792e9117": "c37a50dc-cda3-4cba-8254-2cc8b8ee806" } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance-snapshot.read" ] } ], "summary": "Get the detail of a snapshot", "tags": [ "PCloudSnapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance-snapshot.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/snapshots/$SNAPSHOT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/snapshot_id" } ], "put": { "operationId": "pcloud.cloudinstances.snapshots.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotUpdate" } } }, "description": "Parameters for the update of a PVM instance snapshot", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-snapshot.update" ] } ], "summary": "Update a PVM instance snapshot", "tags": [ "PCloudSnapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-snapshot.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/snapshots/$SNAPSHOT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"name-change\",\n \"description\": \"description-change\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups": { "get": { "operationId": "pcloud.sppplacementgroups.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPPPlacementGroups" }, "examples": { "response": { "value": { "sppPlacementGroups": [ { "id": "95445036-ee96-454d-869e-535ddc45c4a1", "memberSharedProcessorPools": [], "name": "SPG_Anti", "policy": "anti-affinity" }, { "id": "402f58c5-bbe5-4d07-9853-8a7bc6522717", "memberSharedProcessorPools\"": [ "SPP1" ], "name": "SPPPG3", "policy\"": "affinity" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.spp-placement-group.list" ] } ], "summary": "Get the list of Shared Processor Pool Placement Groups for a cloud instance", "tags": [ "PCloudSPPPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.spp-placement-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.spp-placement-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/spp-placement-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.sppplacementgroups.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPPPlacementGroupCreate" } } }, "description": "Parameters for the creation of a Shared Processor Pool Placement Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPPPlacementGroup" }, "examples": { "response": { "value": { "id": "95445036-ee96-454d-869e-535ddc45c4a1", "memberSharedProcessorPools": [], "name": "Tim_Anti", "policy": "anti-affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.spp-placement-group.create" ] } ], "summary": "Create a new Shared Processor Pool Placement Group", "tags": [ "PCloudSPPPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.spp-placement-group.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.spp-placement-group.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/spp-placement-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"Tim_Anti\"\n \"policy\": \"anti-affinity\"\n }'\n " ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups/{spp_placement_group_id}": { "delete": { "operationId": "pcloud.sppplacementgroups.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.spp-placement-group.delete" ] } ], "summary": "Delete a Shared Processor Pool Placement Group from a cloud instance", "tags": [ "PCloudSPPPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.spp-placement-group.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.spp-placement-group.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/spp-placement-groups/$SPP_PLACEMENT_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.sppplacementgroups.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPPPlacementGroup" }, "examples": { "response": { "value": { "id": "95445036-ee96-454d-869e-535ddc45c4a1", "memberSharedProcessorPools": [], "name": "Tim_Anti", "policy": "anti-affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.spp-placement-group.read" ] } ], "summary": "Get the detail of a Shared Processor Pool Placement Group for a cloud instance", "tags": [ "PCloudSPPPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.spp-placement-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.spp-placement-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/spp-placement-groups/$SPP_PLACEMENT_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/spp_placement_group_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/spp-placement-groups/{spp_placement_group_id}/members/{shared_processor_pool_id}": { "delete": { "operationId": "pcloud.sppplacementgroups.members.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPPPlacementGroup" }, "examples": { "response": { "value": { "id": "95445036-ee96-454d-869e-535ddc45c4a1", "memberSharedProcessorPools": [], "name": "Tim_Anti", "policy": "anti-affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.spp-placement-group-member.delete" ] } ], "summary": "Delete Shared Processor Pool member from a Shared Processor Pool Placement Group", "tags": [ "PCloudSPPPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.spp-placement-groups.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.spp-placement-group-member.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/spp-placement-groups/$SPP_PLACEMENT_GROUP_ID/members/$SHARED_PROCESSOR_POOL_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/spp_placement_group_id" }, { "$ref": "#/components/parameters/shared_processor_pool_id" } ], "post": { "operationId": "pcloud.sppplacementgroups.members.post", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SPPPlacementGroup" }, "examples": { "response": { "value": { "id": "95445036-ee96-454d-869e-535ddc45c4a1", "memberSharedProcessorPools": [ "SPP1" ], "name": "Tim_Anti", "policy": "anti-affinity" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.spp-placement-group-member.create" ] } ], "summary": "Add Shared Processor Pool as a member of a Shared Processor Pool Placement Group", "tags": [ "PCloudSPPPlacementGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.spp-placement-groups.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.spp-placement-group-member.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/spp-placement-groups/$SPP_PLACEMENT_GROUP_ID/members/$SHARED_PROCESSOR_POOL_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images": { "get": { "operationId": "pcloud.cloudinstances.stockimages.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Images" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.stock-image.list" ] } ], "summary": "List all available stock images", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.stock-image.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.stock-image.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/stock-images \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/include_sap_images" }, { "$ref": "#/components/parameters/include_vtl_images" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id}": { "get": { "operationId": "pcloud.cloudinstances.stockimages.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" }, "examples": { "response": { "value": { "images": [ { "creationDate": "2024-07-31T18:44:28.000Z", "description": "this are the details of an available stock image", "href": "/pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/stock-images/2e456abe-3948-de91-3913-efca59681745", "imageID": "2e456abe-3948-de91-3913-efca59681745", "lastUpdateDate": "2024-07-31T19:31:52.000Z", "name": "stock-image-1", "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "" }, { "creationDate": "2024-07-31T18:44:28.000Z", "description": "", "href": "/pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/stock-images/2e456abe-3948-de91-3913-efca59681746", "imageID": "2e456abe-3948-de91-3913-efca59681746", "lastUpdateDate": "2024-07-31T19:31:52.000Z", "name": "stock-image-2", "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "" }, { "creationDate": "2023-02-07T14:11:41.000Z", "description": "", "href": "/pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/stock-images/2e456abe-3948-de91-3913-efca59681747", "imageID": "2e456abe-3948-de91-3913-efca59681747", "lastUpdateDate": "2023-02-07T14:31:56.000Z", "name": "7200-05-05T00:00:00.000Z", "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.stock-image.read" ] } ], "summary": "Detailed info of an available stock image", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.stock-image.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.stock-image.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/stock-images/$IMAGE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/image_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-pools": { "get": { "operationId": "pcloud.storagecapacity.pools.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePoolsCapacity" }, "examples": { "response": { "value": { "maximumStorageAllocation": { "maxAllocationSize": 147401, "storagePool": "Tier1-Pool-1", "storageType": "tier1" }, "storagePoolsCapacity": [ { "maxAllocationSize": 7680, "poolName": "Tier1-Pool-cp1", "storageType": "tier1", "totalCapacity": 10240 }, { "maxAllocationSize": 147401, "poolName": "Tier1-Pool-1", "storageType": "tier1", "totalCapacity": 182906 }, { "maxAllocationSize": 9214, "poolName": "Tier3-Pool-cp2", "storageType": "tier3", "totalCapacity": 10240 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pod-capacity.view", "power-iaas.storage-capacity-pool.list" ] } ], "summary": "Storage capacity for all available storage pools in a region", "tags": [ "PCloudStorageCapacity" ], "x-ibm-events": { "events": [ { "name": "power-iaas.storage-capacity.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "description": "Required for satellite locations, ignored for public data centers.", "name": "power-iaas.pod-capacity.view" }, { "name": "power-iaas.storage-capacity-pool.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/storage-capacity/storage-pools \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-pools/{storage_pool_name}": { "get": { "operationId": "pcloud.storagecapacity.pools.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StoragePoolCapacity" }, "examples": { "response": { "value": { "maxAllocationSize": 7680, "poolName": "Tier1-Pool-cp1", "storageType": "tier1", "totalCapacity": 10240 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pod-capacity.view", "power-iaas.storage-capacity-pool.read" ] } ], "summary": "Storage capacity for a storage pool in a region", "tags": [ "PCloudStorageCapacity" ], "x-ibm-events": { "events": [ { "name": "power-iaas.storage-capacity.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "description": "Required for satellite locations, ignored for public data centers.", "name": "power-iaas.pod-capacity.view" }, { "name": "power-iaas.storage-capacity-pool.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/storage-capacity/storage-pools/Tier1-Pool-cp1' \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/storage_pool_name" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-types": { "get": { "operationId": "pcloud.storagecapacity.types.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageTypesCapacity" }, "examples": { "response": { "value": { "maximumStorageAllocation": { "maxAllocationSize": 55146, "storagePool": "General-Flash-1", "storageType": "any" }, "storageTypesCapacity": [ { "maximumStorageAllocation": { "maxAllocationSize": 55146, "storagePool": "General-Flash-1", "storageType": "tier1" }, "storagePoolsCapacity": [ { "maxAllocationSize": 55146, "poolName": "General-Flash-1", "replicationEnabled": true, "storageHost": 1951643481, "storageType": "tier1", "totalCapacity": 164812 }, { "maxAllocationSize": 19078, "poolName": "General-Flash-2b", "replicationEnabled": false, "storageHost": 1951643433, "storageType": "tier1", "totalCapacity": 40960 }, { "maxAllocationSize": 19692, "poolName": "General-Flash-2b", "replicationEnabled": false, "storageHost": 1951643433, "storageType": "tier1", "totalCapacity": 40960 } ], "storageType": "tier1" }, { "maximumStorageAllocation": { "maxAllocationSize": 55146, "storagePool": "General-Flash-1", "storageType": "tier5k" }, "storagePoolsCapacity": [ { "maxAllocationSize": 55146, "poolName": "General-Flash-1", "replicationEnabled": true, "storageHost": 1951643481, "storageType": "tier5k", "totalCapacity": 164812 }, { "maxAllocationSize": 19590, "poolName": "General-Flash-1b", "replicationEnabled": false, "storageHost": 1951643481, "storageType": "tier5k", "totalCapacity": 40960 }, { "maxAllocationSize": 19078, "poolName": "General-Flash-2b", "replicationEnabled": false, "storageHost": 1951643433, "storageType": "tier5k", "totalCapacity": 40960 } ], "storageType": "tier5k" }, { "maximumStorageAllocation": { "maxAllocationSize": 55146, "storagePool": "General-Flash-1", "storageType": "tier3" }, "storagePoolsCapacity": [ { "maxAllocationSize": 55146, "poolName": "General-Flash-1", "replicationEnabled": true, "storageHost": 1951643481, "storageType": "tier3", "totalCapacity": 164812 }, { "maxAllocationSize": 19262, "poolName": "General-Flash-1b", "replicationEnabled": false, "storageHost": 1951643481, "storageType": "tier3", "totalCapacity": 40960 }, { "maxAllocationSize": 19579, "poolName": "General-Flash-2b", "replicationEnabled": false, "storageHost": 1951643481, "storageType": "tier3", "totalCapacity": 40960 } ], "storageType": "tier3" }, { "maximumStorageAllocation": { "maxAllocationSize": 55146, "storagePool": "General-Flash-1", "storageType": "tier0" }, "storagePoolsCapacity": [ { "maxAllocationSize": 55146, "poolName": "General-Flash-1", "replicationEnabled": true, "storageHost": 1951643481, "storageType": "tier0", "totalCapacity": 164812 }, { "maxAllocationSize": 19590, "poolName": "General-Flash-1b", "replicationEnabled": false, "storageHost": "195_164_34_81'", "storageType": "tier0", "totalCapacity": 40960 }, { "maxAllocationSize": 19078, "poolName": "General-Flash-2b", "replicationEnabled": "false,", "storageHost": 1951643433, "storageType": "tier0", "totalCapacity": 40960 } ], "storageType": "tier0" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.storage-capacity-type.list" ] } ], "summary": "Storage capacity for all available storage types in a region", "tags": [ "PCloudStorageCapacity" ], "x-ibm-events": { "events": [ { "name": "power-iaas.storage-capacity.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.storage-capacity-type.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/storage-capacity/storage-types \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-capacity/storage-types/{storage_type_name}": { "get": { "operationId": "pcloud.storagecapacity.types.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StorageTypeCapacity" }, "examples": { "response": { "value": { "maximumStorageAllocation": { "maxAllocationSize": 55146, "storagePool": "General-Flash-1", "storageType": "tier3" }, "storagePoolsCapacity": [ { "maxAllocationSize": 55146, "poolName": "General-Flash-1a", "replicationEnabled": true, "storageHost": 1951643481, "storageType": "tier3", "totalCapacity": 164812 }, { "maxAllocationSize": 19262, "poolName": "General-Flash-1b", "replicationEnabled": false, "storageHost": 1951643481, "storageType": "tier3", "totalCapacity": 40960 }, { "maxAllocationSize": 19590, "poolName": "General-Flash-1c", "replicationEnabled": false, "storageHost": 1951643481, "storageType": "tier3", "totalCapacity": 40960 } ], "storageType": "tier3" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pod-capacity.view", "power-iaas.storage-capacity-type.read" ] } ], "summary": "Storage capacity for a storage type in a region", "tags": [ "PCloudStorageCapacity" ], "x-ibm-events": { "events": [ { "name": "power-iaas.storage-capacity.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "description": "Required for satellite locations, ignored for public data centers.", "name": "power-iaas.pod-capacity.view" }, { "name": "power-iaas.storage-capacity-type.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/storage-capacity/storage-types/tier3 \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/storage_type_name" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/storage-tiers": { "get": { "operationId": "pcloud.cloudinstances.storagetiers.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegionStorageTiers" }, "examples": { "response": { "value": [ { "description": "Tier0 - 25 iops/gb", "name": "tier0", "state": "active" }, { "description": "Tier1 - 10 iops/gb", "name": "tier1", "state": "active" }, { "description": "Tier3 - 3 iops/gb", "name": "tier3", "state": "active" }, { "description": "Tier5k - 5000 iops", "name": "tier5k", "state": "active" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.storage-tier.read" ] } ], "summary": "List all supported storage tiers for this cloud instance", "tags": [ "PCloudStorageTiers" ], "x-ibm-events": { "events": [ { "name": "power-iaas.service-broker.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.storage-tier.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/storage-tiers \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" " ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups": { "get": { "operationId": "pcloud.volumegroups.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroups" }, "examples": { "response": { "value": { "volumeGroups": [ { "consistencyGroupName": "rccg-36e8-543wa", "id": "7e34b8a2-5101-43e6-b0cd-906667f2f0as", "name": "VG-Test-1", "replicationStatus": "enabled", "status": "available", "statusDescription": { "errors": [] } }, { "consistencyGroupName": "rccg-987e-1161as", "id": "987e4439-eb01-43c1-b922-7c9d644116112", "name": "VG-Test-2", "replicationStatus": "enabled", "status": "error", "statusDescription": { "errors": [ { "key": "VOL-NOT-IN-GROUP", "message": "Failed to add volume to CG rccg-987e-1161as because volume aaaca558-3dc9-4956-8980-6f4a5496eb03 is already part of CG rccg-36e8-543ui.", "volIDs": [ "aaaca558-3dc9-4956-8980-6f4a5496eb56" ] } ] } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-group.list" ] } ], "summary": "Get all volume groups", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.volumegroups.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupCreate" } } }, "description": "Parameters for the creation of a new volume group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupCreateResponse" }, "examples": { "response": { "value": { "id": "83f31c4c-ffdb-4af3-8e19-5a836b6d6634", "name": "test-volume-group-1", "status": "available" } } } } } }, "206": { "description": "Partial Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupCreateResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-group.create" ] } ], "summary": "Create a new volume group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.post" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-group.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"consistencyGroupName\": \"string\",\n \"name\": \"string\", \n \"volumeIDs\": [\"string-1\",\"string-2\"]\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/details": { "get": { "operationId": "pcloud.volumegroups.getallDetails", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupsDetails" }, "examples": { "response": { "value": { "volumeGroups": [ { "consistencyGroupName": "rccg-36e8-543wa", "id": "36e83257-f7f5-4848-96f6-47a7b4e54323", "name": "VG-Test-1", "replicationStatus": "enabled", "status": "available", "statusDescription": { "errors": [] }, "volumeIDs": [ "1711cbc9-3456-42ef-a9c0-b2373561147b", "4356217e-af84-4579-b419-497b4cddc751" ] }, { "consistencyGroupName": "rccg-987e-1161as", "id": "987e4439-eb01-43c1-b922-7c9d644116112", "name": "VG-Test-2", "replicationStatus": "enabled", "status": "error", "statusDescription": { "errors": [ { "key": "VOL-NOT-IN-GROUP", "message": "Failed to add volume to CG rccg-987e-1161as because volume aaaca558-3dc9-4956-8980-6f4a5496eb03 is already part of CG rccg-36e8-543ui.", "volIDs": [ "aaaca558-3dc9-4956-8980-6f4a5496eb56" ] } ] }, "volumeIDs": [] } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-group.list" ] } ], "summary": "Get all volume groups with details", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/details \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}": { "delete": { "operationId": "pcloud.volumegroups.delete", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-group.delete" ] } ], "summary": "Delete a cloud instance volume group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-group.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.volumegroups.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroup" }, "examples": { "response": { "value": { "consistencyGroupName": "rccg-36e8-543wa", "id": "7e34b8a2-5101-43e6-b0cd-906667f2f0as", "name": "VG-Test-1", "replicationStatus": "enabled", "status": "available", "statusDescription": { "errors": [] } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-group.read" ] } ], "summary": "Get volume Group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_group_id" } ], "put": { "operationId": "pcloud.volumegroups.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupUpdate" } } }, "description": "Parameters for updating a volume-group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-group.update" ] } ], "summary": "updates the volume group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"addVolumes\": [\"string-1\",\"string-2\"], \n \"removeVolumes\": [\"string-1\",\"string-2\"]\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/action": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_group_id" } ], "post": { "description": "Corresponding actions are 'start', 'stop', 'reset'", "operationId": "pcloud.volumegroups.action.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupAction" } } }, "description": "Parameters for the desire action.", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-group.action" ] } ], "summary": "Perform an action on a volume group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.start" }, { "name": "power-iaas.volume-group.stop" }, { "name": "power-iaas.volume-group.reset" }, { "name": "power-iaas.volume-group.unknown" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-group.action" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID/action \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"reset\": {\n \"status\": \"available\"\n }\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/details": { "get": { "operationId": "pcloud.volumegroups.getDetails", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupDetails" }, "examples": { "response": { "value": { "consistencyGroupName": "rccg-36e8-543wa", "id": "36e83257-f7f5-4848-96f6-47a7b4e54323", "name": "VG-Test-1", "replicationStatus": "enabled", "status": "available", "statusDescription": { "errors": [] }, "volumeIDs": [ "1711cbc9-3456-42ef-a9c0-b2373561147b", "4356217e-af84-4579-b419-497b4cddc751" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-group.read" ] } ], "summary": "Get volume Group details", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID/details \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_group_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/remote-copy-relationships": { "get": { "operationId": "pcloud.volumegroups.remoteCopyRelationships.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupRemoteCopyRelationships" }, "examples": { "response": { "value": { "id": "af9e9d1c-c8c9-4f44-8dd9-1831d3524333", "remoteCopyRelationships": [ { "auxChangedVolumeName": "chg_aux_volume-test_vg-vol-3-7066e348-cc1c1210664", "auxVolumeName": "aux_volume-test_vg-vol-3-7066e348-cc1c1210664", "consistencyGroupName": "rccg-af9e-243dd", "copyType": "global", "cyclingMode": "multi", "freezeTime": "2022-06-09T14:46:59.000Z", "masterChangedVolumeName": "chg_volume-test_vg-vol-3-7066e348-cc1c", "masterVolumeName": "volume-test_vg-vol-3-7066e348-cc1c", "name": "rcrel490", "primaryRole": "master", "progress": 100, "remoteCopyID": "1050", "state": "consistent_copying" }, { "auxChangedVolumeName": "chg_aux_volume-test_vg-vol-4-0a40be7a-21b31210664", "auxVolumeName": "aux_volume-test_vg-vol-4-0a40be7a-21b31210664", "consistencyGroupName": "rccg-af9e-243dd", "copyType": "global", "cyclingMode": "multi", "freezeTime": "2022-06-09T14:46:59.000Z", "masterChangedVolumeName": "chg_volume-test_vg-vol-4-0a40be7a-21b3", "masterVolumeName": "volume-test_vg-vol-4-0a40be7a-21b3", "name": "rcrel499", "primaryRole": "master", "progress": 100, "remoteCopyID": "1099", "state": "consistent_copying" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-group-remote-copy.read" ] } ], "summary": "Get remote copy relationships of the volume belonging to volume group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-group-remote-copy.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID/remote-copy-relationships \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_group_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volume-groups/{volume_group_id}/storage-details": { "get": { "operationId": "pcloud.volumegroups.storageDetails.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeGroupStorageDetails" }, "examples": { "response": { "value": { "consistencyGroupName": "rccg-15da-98ecc", "cyclePeriodSeconds": 500, "cyclingMode": "multi", "numOfvols": 2, "remoteCopyRelationshipNames": [ "rcrel999", "rcrel1100" ], "replicationType": "global", "state": "idling", "sync": "out_of_sync" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-group-storage.read" ] } ], "summary": "Get storage details of volume group", "tags": [ "PCloudVolumeGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-group-storage.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volume-groups/$VOLUME_GROUP_ID/storage-details \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_group_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes": { "get": { "operationId": "pcloud.cloudinstances.volumes.getall", "parameters": [ { "$ref": "#/components/parameters/replication_enabled" }, { "$ref": "#/components/parameters/affinity" }, { "$ref": "#/components/parameters/auxiliary" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volumes" }, "examples": { "response": { "value": [ { "bootable": true, "creationDate": "2019-11-21T10:41:38.000Z", "diskType": "tier1", "href": "/pcloud/v1/cloud-instances/969afb22cb004e807ab84b827abfa1b0/volumes/8a78e4b2-fc59-473e-9260-51a753634fd9", "lastUpdateDate": "2019-11-21T10:42:16.000Z", "name": "testr-6da0fd14-00000953-boot-0", "shareable": false, "size": 20, "state": "in-use", "volumeID": "8a78e4b2-fc59-473e-9260-51a753634fd9", "volumePool": "StoragePool-1", "volumeType": "StoragePool-1", "wwn": "wwn-id" }, { "auxVolumeName": "aux_test-vol-1-ff2dd3a6-17ed44275611", "auxiliary": false, "bootable": false, "creationDate": "2022-07-08T12:28:41.000Z", "diskType": "tier1", "href": "/pcloud/v1/cloud-instances/6dc23f8f500f44a180661501eee2d9f8/volumes/ff2dd3a6-17ed-453d-88fc-7f77882c4d81", "lastUpdateDate": "2022-07-08T12:28:47.000Z", "masterVolumeName": "volume-test-vol-1-ff2dd3a6-17ed", "mirroringState": "inconsistent_copying", "name": "test-vol-1", "primaryRole": "master", "pvmInstanceIDs": [], "replicationEnabled": true, "replicationStatus": "enabled", "replicationType": "global", "shareable": false, "size": 2, "state": "available", "volumeID": "ff2dd3a6-17ed-453d-88fc-7f77882c4d66", "volumePool": "Tier1-Flash-1", "volumeType": "Tier1-Flash-1-DR", "wwn": "6005076400810289700000000000B788" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance-volume.list" ] } ], "summary": "List all volumes for this cloud instance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance-volume.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.cloudinstances.volumes.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDataVolume" } } }, "description": "Parameters for the creation of a new data volume", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volume" }, "examples": { "response": { "value": { "bootable": false, "creationDate": "2021-08-31T19:26:55.000Z", "diskType": "tier3", "href": "/pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/volumes/322d6d22-5006-4813-9f9c-92d6acea84ee", "lastUpdateDate": "1970-01-01T00:00:00.000Z", "name": "data-volume-1", "pvmInstanceIDs": [], "replicationStatus": "not-capable", "shareable": false, "size": 2000, "state": "creating", "volumeID": "322d6d22-5006-4813-9f9c-92d6acea84ee", "volumePool": "Tier3-Flash-1", "volumeType": "Tier3-Flash-1", "wwn": "322d6d22-5006-4813-9f9c-92d6acea84ee" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-volume.create" ] } ], "summary": "Create a new data Volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-volume.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"diskType\": \"tier3\",\n \"name\": \"volume-name\",\n \"shareable\": false,\n \"size\": \"volume-size\"\n \"volumePool\": \"StoragePool1\"\n \"affinityPolicy\": \"anti-affinity\"\n \"antiAffinityVolumes\": [\"data-volume-1\",\"data-volume-2\"]\n }' " ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/clone": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "deprecated": true, "description": "This API is deprecated, use v2 clone API to perform the volume clone.\n\n>*Note*: Support for this API will be available till 31st March 2023.\n", "operationId": "pcloud.volumes.clone.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneRequest" } } }, "description": "Parameters for the cloning of volumes", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneResponse" }, "examples": { "response": { "value": { "clonedVolumes": { "volume-id-1": "cloned-volume-id-1", "volume-id-2": "cloned-volume-id-2" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.create" ] } ], "summary": "Create a volume clone for specified volumes", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/clone \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"volumeIDs\": [\"volume-id-1\",\"volume-id-2\"],\n \"displayName\": \"name-of-clone\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding": { "get": { "operationId": "pcloud.volume.onboarding.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeOnboardings" }, "examples": { "response": { "value": { "onboardings": [ { "description": "onboardingDemo1", "id": "845e40d3-035d-499a-a147-02e2adf8123", "inputVolumes": [ "aux_volume-vol-demo15-a608b408-051c", "aux_volume-vol-demo16-a608b408-051c" ], "status": "SUCCESS" }, { "description": "onboardingDemo2", "id": "0bd0c4a7-df48-4b82-8aa2-31e267cdc213", "inputVolumes": [ "aux_volume-vol-demo17-a608b408-051c", "aux_volume-vol-demo10-a608b408-051c" ], "status": "REVERTED" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-onboarding.list" ] } ], "summary": "List all volume onboardings for this cloud instance", "tags": [ "PCloudVolumeOnboarding" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-onboarding.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-onboarding.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/onboarding \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.volume.onboarding.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeOnboardingCreate" } } }, "description": "Parameters for the creation of volume onboarding", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeOnboardingCreateResponse" }, "examples": { "response": { "value": { "description": "onboarding-test-1", "id": "6392eaf7-6edf-4edd-ae3e-a18583946241" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-onboarding.create" ] } ], "summary": "Onboard auxiliary volumes to target site", "tags": [ "PCloudVolumeOnboarding" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-onboarding.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-onboarding.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/onboarding \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"Volumes\": [\n {\n \"auxiliaryVolumes\": [\n {\n \"auxVolumeName\": \"string\"\n \"name\": \"string\"\n }\n ],\n \"sourceCRN\": \"string\"\n }\n \"description\": \"string\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/onboarding/{volume_onboarding_id}": { "get": { "operationId": "pcloud.volume.onboarding.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeOnboarding" }, "examples": { "response": { "value": { "creationTimestamp": "2022-09-03T11:37:42.000Z", "description": "onboardingDemo1", "id": "76ab88a3-8078-4a69-abff-31cafd1f96qq", "inputVolumes": [ "aux_vol-1-80ed3950-ae0044275619", "aux_vol-2-80ed3950-ae0044275619" ], "progress": 100, "results": { "onboardedVolumes": [], "volumeOnboardingFailures": [ { "failureMessage": "Unauthorized onboard of auxiliary volumes.", "volumes": [ "aux_DRVMTest-29e8ee86-000037b0-boot-0-0e71999a-857a44275619", "aux_volume-vol-demo-test-99593-3-5414edfc-e1f144275619" ] } ] }, "status": "REVERTED" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-onboarding.read" ] } ], "summary": "Get the information of volume onboarding operation", "tags": [ "PCloudVolumeOnboarding" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-onboarding.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-onboarding.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/onboarding/$VOLUME_ONBOARDING_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_onboarding_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}": { "delete": { "operationId": "pcloud.cloudinstances.volumes.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-volume.delete" ] } ], "summary": "Delete a cloud instance volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-volume.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.cloudinstances.volumes.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volume" }, "examples": { "response": { "value": { "bootable": false, "creationDate": "2020-01-10T16:43:39.000Z", "diskType": "tier3", "lastUpdateDate": "2020-01-13T17:58:45.000Z", "name": "tim-data-vol-4", "shareable": false, "size": 32, "state": "in-use", "volumeID": "e8cc1226-a4d5-46c8-875c-312b8b5bdda6", "volumePool": "StoragePool-1", "volumeType": "StoragePool-1", "wwn": "wwn-id" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.cloud-instance-volume.read" ] } ], "summary": "Detailed info of a volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.cloud-instance-volume.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_id" } ], "put": { "operationId": "pcloud.cloudinstances.volumes.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVolume" } } }, "description": "Parameters to update a cloud instance volume", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volume" }, "examples": { "response": { "value": { "bootable": false, "creationDate": "2020-01-10T16:43:39.000Z", "diskType": "tier1", "lastUpdateDate": "2020-01-13T17:58:45.000Z", "name": "test-data-vol-4", "shareable": true, "size": 32, "state": "in-use", "volumeID": "e8cc1226-a4d5-46c8-875c-312b8b5bdda6" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-volume.update" ] } ], "summary": "Update a cloud instance volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-volume.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/$VOLUME_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"volume-name\"\n \"size\": \"volume-size\"\n \"shareable\": \"true\"\n \"bootable\": \"false\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/action": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_id" } ], "post": { "operationId": "pcloud.cloudinstances.volumes.action.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeAction" } } }, "description": "Parameters for the desired action", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-volume.action" ] } ], "summary": "Perform an action on a Volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.operation" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-volume.action" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/$VOLUME_ID/action \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"volume-name\"\n \"size\": \"volume-size\"\n \"shareable\": true\n \"replicationEnabled\": true\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/flash-copy-mappings": { "get": { "operationId": "pcloud.cloudinstances.volumes.FlashCopyMappings.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FlashCopyMappings" }, "examples": { "response": { "value": [ { "flashCopyName": "fcmap44", "sourceVolumeName": "volume-vol-demo-b52b93df-746c", "startTime": "1901-01-01T00:00:00.000Z", "status": "stopped", "targetVolumeName": "chg_volume-vol-demo-b52b93df-746c" }, { "copyRate": "50,", "flashCopyName": "fcmap45", "sourceVolumeName": "chg_volume-vol-demo-b52b93df-746c", "startTime": "1901-01-01T00:00:00.000Z", "status": "idle_or_copied", "targetVolumeName": "volume-vol-demo-b52b93df-746c" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-flash-copy.read" ] } ], "summary": "Get a list of flashcopy mappings of a given volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-flash-copy.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/$VOLUME_ID/flash-copy-mappings \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/volumes/{volume_id}/remote-copy": { "get": { "operationId": "pcloud.cloudinstances.volumes.remoteCopyRelationship.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeRemoteCopyRelationship" }, "examples": { "response": { "value": { "auxChangedVolumeName": "chg_aux_volume-vol-demo-b52b93df-746c1210664", "auxVolumeName": "aux_volume-vol-demo-b52b93df-746c1210664", "copyType": "global", "cyclePeriodSeconds": "500,", "cyclingMode": "multi", "freezeTime": "2022-09-14T06:10:42.000Z", "id": "b52b93df-746c-4ff0-9885-292b4be86sdsd", "masterChangedVolumeName": "chg_volume-vol-demo-b52b93df-746c", "masterVolumeName": "volume-vol-demo-b52b93df-746c", "name": "rcrel23", "primaryRole": "master", "progress": "100,", "remoteCopyID": "101", "state": "consistent_copying" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-remote-copy.read" ] } ], "summary": "Get remote copy relationship of a volume", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-remote-copy.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/volumes/$VOLUME_ID/remote-copy \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volume_id" } ] }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ike-policies": { "get": { "description": "List all IKE Policies with all attributes", "operationId": "pcloud.ikepolicies.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEPolicies" }, "examples": { "response": { "value": { "ikePolicies": { "authentication": "sha1", "dhGroup": "19,", "encryption": "3des-cbc", "id": "7edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ikePolicy1", "version": 2 } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection-ike-policy.read" ] } ], "summary": "Get all IKE Policies", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ike-policy.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection-ike-policy.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ike-policies \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "description": "Add a new IKE Policy", "operationId": "pcloud.ikepolicies.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEPolicyCreate" } } }, "description": "Parameters for the creation of a new IKE Policy", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEPolicy" }, "examples": { "response": { "value": { "authentication": "sha1", "dhGroup": 19, "encryption": "3des-cbc", "id": "7edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ikePolicy1", "version": 2 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-ike-policy.create" ] } ], "summary": "Add IKE Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ike-policy.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-ike-policy.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ike-policies \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"authentication\": \"sha1\",\n \"dhGroup\": 19,\n \"encryption\": \"3des-cbc\",\n \"keyLifetime\": 28800,\n \"name\": \"ikePolicy1\",\n \"presharedKey\": \"string\",\n \"version\": 2\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ike-policies/{ike_policy_id}": { "delete": { "description": "Delete an IKE Policy (by its unique identifier)", "operationId": "pcloud.ikepolicies.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-ike-policy.delete" ] } ], "summary": "Delete IKE Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ike-policy.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-ike-policy.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ike-policies/$IKE_POLICY_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "description": "Get an IKE Policy (by its unique identifier)", "operationId": "pcloud.ikepolicies.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEPolicy" }, "examples": { "response": { "value": { "ikePolicies": [ { "authentication": "sha1", "dhGroup": 19, "encryption": "3des-cbc", "id": "7edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ikePolicy1", "version": 2 } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection-ike-policy.list" ] } ], "summary": "Get the specified IKE Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ike-policy.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection-ike-policy.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ike-policies/$IKE_POLICY_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/ike_policy_id" } ], "put": { "description": "update an IKE Policy (by its unique identifier)", "operationId": "pcloud.ikepolicies.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEPolicyUpdate" } } }, "description": "Parameters for updating IKE Policy", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IKEPolicy" }, "examples": { "response": { "value": { "authentication": "sha1", "dhGroup": 19, "encryption": "3des-cbc", "id": "7edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ikePolicy1", "version": 2 } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-ike-policy.update" ] } ], "summary": "Update IKE Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ike-policy.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-ike-policy.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ike-policies/$IKE_POLICY_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"authentication\": \"sha1\",\n \"dhGroup\": 19,\n \"encryption\": \"3des-cbc\",\n \"keyLifetime\": 28800,\n \"name\": \"ikePolicy1\",\n \"presharedKey\": \"string\",\n \"version\": 2\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ipsec-policies": { "get": { "description": "Get all IPSec Policies with all their attributes", "operationId": "pcloud.ipsecpolicies.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPSecPolicies" }, "examples": { "response": { "value": { "ipSecPolicies": { "authentication": "hmac-md5-96", "dhGroup": 2, "encryption": "3des-cbc", "id": "6edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ipSecPolicy2", "pfs": true } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection-ipsec-policy.list" ] } ], "summary": "Get all IPSec Policies", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ipsec-policy.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection-ipsec-policy.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ipsec-policies \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "description": "Add a new IPSec Policy", "operationId": "pcloud.ipsecpolicies.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPSecPolicyCreate" } } }, "description": "Parameters for the creation of a new IPSec Policy", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPSecPolicy" }, "examples": { "response": { "value": { "authentication": "hmac-md5-96", "dhGroup": 2, "encryption": "3des-cbc", "id": "6edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ipSecPolicy2", "pfs": true } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-ipsec-policy.create" ] } ], "summary": "Add IPSec Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ipsec-policy.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-ipsec-policy.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ipsec-policies \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"authentication\": \"hmac-md5-96\",\n \"dhGroup\": 2,\n \"encryption\": \"3des-cbc\",\n \"keyLifetime\": 28800,\n \"name\": \"ipSecPolicy2\",\n \"pfs\": true\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/ipsec-policies/{ipsec_policy_id}": { "delete": { "description": "Delete an IPSec Policy (by its unique identifier)", "operationId": "pcloud.ipsecpolicies.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-ipsec-policy.delete" ] } ], "summary": "Delete IPSec Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ipsec-policy.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-ipsec-policy.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ipsec-policies/$IPSEC_POLICY_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "description": "Get an IPSec Policy (by its unique identifier)", "operationId": "pcloud.ipsecpolicies.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPSecPolicy" }, "examples": { "response": { "value": { "ipSecPolicies": [ { "authentication": "hmac-md5-96", "dhGroup": 2, "encryption": "3des-cbc", "id": "6edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ipSecPolicy2", "pfs": true } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection-ipsec-policy.read" ] } ], "summary": "Get the specified IPSec Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ipsec-policy.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection-ipsec-policy.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ipsec-policies/$IPSEC_POLICY_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/ipsec_policy_id" } ], "put": { "description": "update an IPSec Policy", "operationId": "pcloud.ipsecpolicies.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPSecPolicyUpdate" } } }, "description": "Parameters for the update of an IPSec Policy", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IPSecPolicy" }, "examples": { "response": { "value": { "authentication": "hmac-md5-96", "dhGroup": 2, "encryption": "3des-cbc", "id": "6edc8988-eb18-4b5c-a594-0d73d8254463", "keyLifetime": 28800, "name": "ipSecPolicy2", "pfs": true } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-ipsec-policy.update" ] } ], "summary": "Update IPSec Policy", "tags": [ "PCloudVPNPolicies" ], "x-ibm-events": { "events": [ { "name": "power-iaas.ipsec-policy.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-ipsec-policy.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/ipsec-policies/$IPSEC_POLICY_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"authentication\": \"hmac-md5-96\",\n \"dhGroup\": 2,\n \"encryption\": \"3des-cbc\",\n \"keyLifetime\": 28800,\n \"name\": \"ipSecPolicy2\",\n \"pfs\": true\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections": { "get": { "description": "Get all VPN Connections", "operationId": "pcloud.vpnconnections.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPNConnections" }, "examples": { "response": { "value": { "vpnConnections": [ { "deadPeerDetection": { "action": "restart", "interval": 10, "threshold": 5 }, "id": "e4111a8eb2374b3eb317a6b8f3fe263d", "ikePolicy": { "id": "d1c0a9508e724cf4b93a06cda0c3a415", "name": "ui-test-updated" }, "ipSecPolicy": { "id": "7ed08c4227284d4cba853c8968f18202", "name": "ipsec-policy-ui-test-1" }, "localGatewayAddress": "169.48.225.198", "mode": "route", "name": "vpn-connection-1", "networkIDs": [ "d603cf33-3d4e-4e2b-b6ed-f846ee6b5831" ], "peerGatewayAddress": "1.1.1.1", "peerSubnets": [ "128.197.11.0/24" ], "status": "active", "vpnGatewayAddress": "169.48.225.198" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection.list" ] } ], "summary": "Get all VPN Connections", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "description": "Create a new VPN Connection", "operationId": "pcloud.vpnconnections.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPNConnectionCreate" } } }, "description": "VPN Connection object used for creation", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPNConnectionCreateResponse" }, "examples": { "response": { "value": { "deadPeerDetection": { "action": "restart", "interval": 10, "threshold": 5 }, "id": "123e4567-e89b-12d3-a456-42661475", "ikePolicy": { "id": "6edc8988-ab18-4b5c-b123-0d73e8254463", "name": "IKE Policy 1" }, "ipSecPolicy": { "id": "7abc1234-ab18-4b5c-b123-0d73e8254463", "name": "IPSec Policy 1" }, "jobRef": { "href": "pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/jobs/cb6db5dd-17b9-4236-8754-8b82d1357e74", "id": "cb6db5dd-17b9-4236-8754-8b82d1357e74" }, "localGatewayAddress": "192.168.1.1", "mode": "policy", "name": "VPN-Connection-1", "networkIDs": [ "99b7cf8835eb4c77abdadd9e6ed5009c" ], "peerGatewayAddress": "192.168.1.1", "peerSubnets": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27", "128.170.1.0/32" ], "status": "active", "vpnGatewayAddress": "192.168.204.1" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "Method Not Allowed", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection.create" ] } ], "summary": "Create VPN Connection", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"ikePolicy\": \"6edc8988-ab18-4b5c-b123-0d73e8254463\",\n \"ipSecPolicy\": \"7abc1234-ab18-4b5c-b123-0d73e8254463\",\n \"mode\": \"policy\",\n \"name\": \"VPN-Connection-1\",\n \"networks\": [\n \"99b7cf8835eb4c77abdadd9e6ed5009c\" \n ],\n \"peerGatewayAddress\": \"192.168.1.1\",\n \"peerSubnets\": \"128.170.1.0/20\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}": { "delete": { "description": "Delete VPN Connection (by its identifier)", "operationId": "pcloud.vpnconnections.delete", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/jobs/565783da-268a-41df-8742-f4e2929af9e6", "id": "565783da-268a-41df-8742-f4e2929af9e6" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection.delete" ] } ], "summary": "Delete VPN Connection", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "description": "Get a VPN Connection", "operationId": "pcloud.vpnconnections.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPNConnection" }, "examples": { "response": { "value": { "deadPeerDetection": { "action": "restart", "interval": 10, "threshold": 5 }, "id": "1dfb9c031c4145cfa7c696711ba0ef0d", "ikePolicy": { "id": "d1c0a9508e724cf4b93a06cda0c3a415", "name": "ui-test-updated" }, "ipSecPolicy": { "id": "ad1517c55e68450b9a160e0c1e52c0b6", "name": "tbsec" }, "localGatewayAddress": "169.48.225.198", "mode": "route", "name": "cli-test-vpn-connection-new-1", "networkIDs": [ "3a3dffcb-3621-40b4-82c3-ae393d2805ba" ], "peerGatewayAddress": "10.0.0.1", "peerSubnets": [ "1.2.5.0/24" ], "status": "active", "vpnGatewayAddress": "169.48.225.198" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection.read" ] } ], "summary": "Get VPN Connection", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/vpn_connection_id" } ], "put": { "description": "update a VPN Connection (by its identifier)", "operationId": "pcloud.vpnconnections.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPNConnectionUpdate" } } }, "description": "VPN Connection object used for update", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VPNConnection" }, "examples": { "response": { "value": { "deadPeerDetection": { "action": "restart", "interval": 10, "threshold": 5 }, "id": "1dfb9c031c4145cfa7c696711ba0ef0d", "ikePolicy": { "id": "d1c0a9508e724cf4b93a06cda0c3a415", "name": "ui-test-updated" }, "ipSecPolicy": { "id": "ad1517c55e68450b9a160e0c1e52c0b6", "name": "tbsec" }, "localGatewayAddress": "169.48.225.198", "mode": "route", "name": "cli-test-vpn-connection-new", "networkIDs": [ "3a3dffcb-3621-40b4-82c3-ae393d2805ba" ], "peerGatewayAddress": "10.0.0.1", "peerSubnets": [ "1.2.5.0/24" ], "status": "active", "vpnGatewayAddress": "169.48.225.198" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection.update" ] } ], "summary": "Update VPN Connection", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"ikePolicy\": \"c36723ec-8593-11eb-8dcd-0242ac133853\",\n \"ipSecPolicy\": \"c12345d-8593-11eb-8dcd-0242ac134573\",\n \"name\": \"VPN-Connection-1\",\n \"peerGatewayAddress\": \"192.188.1.1\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/networks": { "delete": { "description": "Detach network from a specific VPN Connection", "operationId": "pcloud.vpnconnections.networks.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkID" } } }, "description": "network to detach", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/jobs/565783da-268a-41df-8742-f4e2929af9e6", "id": "565783da-268a-41df-8742-f4e2929af9e6" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-network.delete" ] } ], "summary": "Detach network", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-network.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "description": "Get a list of network IDs attached to a VPN Connection", "operationId": "pcloud.vpnconnections.networks.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkIDs" }, "examples": { "response": { "value": { "networkIDs": [ "7f950c76-8582-11qeb-8dcd-0242ac143", "7f950c76-8582-11veb-8dcd-0242ac153", "7f950c76-8582-11deb-8dcd-0242ac163" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection-network.read" ] } ], "summary": "Get attached networks", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection-network.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/vpn_connection_id" } ], "put": { "description": "Attach a network to a VPN Connection", "operationId": "pcloud.vpnconnections.networks.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkID" } } }, "description": "network to attach", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/cloud-instances/a28e43001b7748b0acbdfb2d36288643/jobs/565783da-268a-41df-8742-f4e2929af9e6", "id": "565783da-268a-41df-8742-f4e2929af9e6" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-network.update" ] } ], "summary": "Attach network", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-network.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID/networks \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"networkID\": \"7f950c76-8582-11qeb-8dcd-0242ac172\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/cloud-instances/{cloud_instance_id}/vpn/vpn-connections/{vpn_connection_id}/peer-subnets": { "delete": { "description": "Detach peer subnet from a VPN Connection", "operationId": "pcloud.vpnconnections.peersubnets.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerSubnetUpdate" } } }, "description": "Peer subnet to detach", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerSubnets" }, "examples": { "response": { "value": { "peerSubnets": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-peer-subnet.delete" ] } ], "summary": "Detach Peer Subnet", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-peer-subnet.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID/peer-subnets \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"cidr\": \"128.170.1.0/32\"\n }'" ] } ] } ] } } }, "get": { "description": "Get a list of peer subnets attached to a specific VPN Connection", "operationId": "pcloud.vpnconnections.peersubnets.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerSubnets" }, "examples": { "response": { "value": { "peerSubnets": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27", "128.170.1.0/32" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.vpn-connection-peer-subnet.read" ] } ], "summary": "Get Peer Subnets", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.vpn-connection-peer-subnet.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID/peer-subnets \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/vpn_connection_id" } ], "put": { "description": "Attach peer subnet to a VPN Connection", "operationId": "pcloud.vpnconnections.peersubnets.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerSubnetUpdate" } } }, "description": "peer subnet to attach", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeerSubnets" }, "examples": { "response": { "value": { "peerSubnets": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27", "128.170.1.0/32" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.vpn-connection-peer-subnet.update" ] } ], "summary": "Attach Peer Subnet", "tags": [ "PCloudVPNConnections" ], "x-ibm-events": { "events": [ { "name": "power-iaas.vpn-connection.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.vpn-connection-peer-subnet.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/cloud-instances/$CLOUD_INSTANCE_ID/vpn/vpn-connections/$VPN_CONNECTION_ID/peer-subnets \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"cidr\": \"128.170.1.0/32\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/images": { "get": { "deprecated": true, "description": "This API is deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images.\n\n>*Note*: Support for this API will be available till 31st March 2023.\n", "operationId": "pcloud.images.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Images" }, "examples": { "response": { "value": { "images": [ { "creationDate": "2024-10-02T20:16:12.000Z", "description": "", "href": "/pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/images/2e456abe-3948-de91-3913-efca59681745", "imageID": "2e456abe-3948-de91-3913-efca59681745", "lastUpdateDate": "2024-10-02T20:16:13.000Z", "name": "7100-05-07T00:00:00.000Z", "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "" }, { "creationDate": "2023-12-15T20:19:53.000Z", "description": "", "href": "/pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/images/2e456abe-3948-de91-3913-efca59681745", "imageID": "2e456abe-3948-de91-3913-efca59681745", "lastUpdateDate": "2023-12-15T20:19:53.000Z", "name": "7200-04-01T00:00:00.000Z", "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "" }, { "creationDate": "2023-12-18T18:15:35.000Z'", "description": "", "href": "/pcloud/v1/cloud-instances/a28d8395820185938ef8c9d89a093ef9/images/2e456abe-3948-de91-3913-efca59681745", "imageID": "2e456abe-3948-de91-3913-efca59681745", "lastUpdateDate": "2023-12-18T18:15:35.000Z'", "name": "7200-05-05T00:00:00.000Z", "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "big-endian", "hypervisorType": "phyp", "imageType": "stock", "operatingSystem": "aix" }, "state": "active", "storagePool": "", "storageType": "" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.image.list" ] } ], "summary": "List all the images in the image-catalog", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.image.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/images \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/include_sap_images" }, { "$ref": "#/components/parameters/include_vtl_images" } ] }, "/pcloud/v1/images/{image_id}": { "get": { "deprecated": true, "description": "This API is deprecated for /pcloud/v1/cloud-instances/{cloud_instance_id}/stock-images/{image_id}.\n\n>*Note*: Support for this API will be available till 31st March 2023.\n", "operationId": "pcloud.images.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Image" }, "examples": { "response": { "value": { "creationDate": "2024-03-29T06:39:39.000Z", "imageID": "2e456abe-3948-de91-3913-efca59681745", "lastUpdateDate": "2024-03-29T06:41:01.000Z", "maxImageVolumeSize": 0, "name": "vm-image-capture-cos-bucket", "servers": [], "size": 0, "specifications": { "architecture": "ppc64", "containerFormat": "bare", "diskFormat": "raw", "endianness": "little-endian", "hypervisorType": "phyp", "imageType": "import", "operatingSystem": "rhel" }, "state": "error", "storagePool": "General-Flash-83", "storageType": "", "volumes": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.image.read" ] } ], "summary": "Detailed info of an image in the image-catalog", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.image.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/images/$IMAGE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/image_id" } ] }, "/pcloud/v1/locations/disaster-recovery": { "get": { "operationId": "pcloud.locations.disasterrecovery.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DisasterRecoveryLocations" }, "examples": { "response": { "value": { "disasterRecoveryLocations": [ { "location": "dal12", "replicationSites": [ { "isActive": true, "location": "us-east" } ] }, { "location": "us-east", "replicationSites": [ { "isActive": true, "location": "dal12" } ] } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "Get all disaster recovery locations supported by Power Virtual Server", "tags": [ "PCloudDisasterRecovery" ], "x-ibm-events": { "events": [ { "name": "power-iaas.disaster-recovery.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/locations/disaster-recovery \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/pcloud/v1/tasks/{task_id}": { "delete": { "operationId": "pcloud.tasks.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.task.delete" ] } ], "summary": "Delete a Task", "tags": [ "PCloudTasks" ], "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.task.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tasks/$TASK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.tasks.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Task" }, "examples": { "response": { "value": { "cloudInstanceID": "de395723a09e7df8e873815634857dab", "componentID": "de395723a09e7df8e873815634857dab", "componentType": "cloud-instance", "creationDate": "2023-03-10T18:06:54.814Z", "lastUpdateDate": "2023-03-10T18:07:40.008Z", "operation": "deprovision", "status": "failed", "statusDetail": "unable to deprovision cloud instance de395723a09e7df8e873815634857dab: unable to delete network (ca387f83-e357-63bs-bc96-43958439588d) for de395723a09e7df8e873815634857dab: unable to delete subnet for network ca387f83-e357-63bs-bc96-43958439588d for cloud instance de395723a09e7df8e873815634857dab: Resource not found: [DELETE https://192.168.2.140:9696/v2.0/subnets/dc2370f1-5ed3-4b87-bcdc-62dbe52f9461], error message: {\\\"NeutronError\\\": {\\\"type\\\": \\\"SubnetNotFound\\\", \\\"message\\\": \\\"Subnet dc2370f1-5ed3-4b87-bcdc-62dbe52f9461 could not be found.\\\", \\\"detail\\\": \\\"\\\"}}", "taskID": "1c3498de-3432-6565-aed3-345345345387" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.task.read" ] } ], "summary": "Get a Task", "tags": [ "PCloudTasks" ], "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.task.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tasks/$TASK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/task_id" } ] }, "/pcloud/v1/tenants/{tenant_id}": { "get": { "operationId": "pcloud.tenants.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" }, "examples": { "response": { "value": { "cloudInstances": [ { "cloudInstanceID": "78ea9383b1354924bdf97a3057f50110", "enabled": true, "href": "/pcloud/v1/cloud-instances/78ea9383b1354924bdf97a3057f50110", "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 }, "name": "0d8f8fc5-5975-4e78-b541-aec77672ae51", "region": "us-east" }, { "cloudInstanceID": "7c3d5c3f746c457a95ce3cebba76cf63", "enabled": true, "href": "/pcloud/v1/cloud-instances/7c3d5c3b746c457a95ce3bebba76cf63", "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 }, "name": "37c24ed2-fd6a-4f4b-9119-f6a2817f1d58", "region": "us-east" }, { "cloudInstanceID": "969afb22cb004e808cb84b827abfa1b0", "enabled": true, "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0", "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 } } ], "creationDate": "2019-06-21T16:29:17.670Z", "enabled": true, "name": "781d5ef5-b87c-4a0a-86b8-aaa41213477", "region": "us-east", "sshKeys": [ { "creationDate": "2019-09-20T18:11:04.508Z", "name": "ibm-test", "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAA..." }, { "creationDate": "2019-11-12T13:16:21.811Z", "name": "default-key-DO_NOT_DELETE", "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAA... a459814@FR-MP144WBV" }, { "creationDate": "2019-11-21T09:40:47.042Z", "name": "e2e1574329171394", "sshKey": "abc" }, { "creationDate": "2019-11-21T10:04:23.684Z", "name": "e2e1574330594605", "sshKey": "abc" } ], "tenantID": "efe5e8b9d3f04b948790fe5499bd18bc" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.tenant.read" ] } ], "summary": "Get a Tenant's current state/information", "tags": [ "PCloudTenants" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.tenant.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/tenant_id" } ], "put": { "operationId": "pcloud.tenants.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantUpdate" } } }, "description": "Parameters for updating a Tenant", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Tenant" }, "examples": { "response": { "value": { "cloudInstances": [ { "cloudInstanceID": "78ea9383b1354924bdf97a3057f50110", "enabled": true, "href": "/pcloud/v1/cloud-instances/78ea9383b1354924bdf97a3057f50110", "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 }, "name": "0d8f8fc5-5975-4e78-b541-aec77672ae51", "region": "us-east" }, { "cloudInstanceID": "7c3d5c3f746c457a95ce3cebba76cf63", "enabled": true, "href": "/pcloud/v1/cloud-instances/7c3d5c3b746c457a95ce3bebba76cf63", "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 }, "name": "37c24ed2-fd6a-4f4b-9119-f6a2817f1d58", "region": "us-east" }, { "cloudInstanceID": "969afb22cb004e808cb84b827abfa1b0", "enabled": true, "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0", "initialized": false, "limits": { "instanceMemory": 0, "instanceProcUnits": 0, "instances": 0, "memory": 0, "peeringBandwidth": 0, "peeringNetworks": 0, "procUnits": 0, "processors": 0, "storage": 0, "storageSSD": 0 } } ], "creationDate": "2019-06-21T16:29:17.670Z", "enabled": true, "name": "781d5ef5-b87c-4a0a-86b8-aaa41213477", "region": "us-east", "sshKeys": [ { "creationDate": "2019-09-20T18:11:04.508Z", "name": "ibm-test", "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAAA..." }, { "creationDate": "2019-11-12T13:16:21.811Z", "name": "default-key-DO_NOT_DELETE", "sshKey": "ssh-rsa AAAAB3NzaC1yc2EAA... a459814@FR-MP144WBV" }, { "creationDate": "2019-11-21T09:40:47.042Z", "name": "e2e1574329171394", "sshKey": "abc" }, { "creationDate": "2019-11-21T10:04:23.684Z", "name": "e2e1574330594605", "sshKey": "abc" } ], "tenantID": "efe5e8b9d3f04b948790fe5499bd18bc" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.tenant.update" ] } ], "summary": "Update a tenant", "tags": [ "PCloudTenants" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.tenant.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"icn\": \"347aa3a4b34344f8bc7c7cccdf856e4d\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/tenants/{tenant_id}/sshkeys": { "get": { "operationId": "pcloud.tenants.sshkeys.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKeys" }, "examples": { "response": { "value": { "sshKeys": [ { "creationDate": "2019-09-20T18:11:04.508Z", "name": "ibm-test", "sshKey": "ssh-rsa AAAAB3..." }, { "creationDate": "2019-11-12T13:16:21.811Z", "name": "default-key-DO_NOT_DELETE", "sshKey": "ssh-rsa AAAAB..." } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.tenant-sshkey.list" ] } ], "summary": "List a Tenant's SSH Keys", "tags": [ "PCloudTenantsSSHKeys" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant-sshkey.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.tenant-sshkey.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID/sshkeys \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/tenant_id" } ], "post": { "operationId": "pcloud.tenants.sshkeys.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKey" } } }, "description": "Parameters for the creation of a new SSH key", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKey" } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKey" }, "examples": { "response": { "value": { "creationDate": "2024-10-04T15:23:53.543Z", "name": "sshkey-name", "sshKey": "ssh-rsa-key" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.tenant-sshkey.create" ] } ], "summary": "Add a new SSH key to the Tenant", "tags": [ "PCloudTenantsSSHKeys" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant-sshkey.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.tenant-sshkey.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID/sshkeys \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"sshkey-name\"\n \"sshKey\": \"ssh-rsa-key\"\n }'" ] } ] } ] } } } }, "/pcloud/v1/tenants/{tenant_id}/sshkeys/{sshkey_name}": { "delete": { "operationId": "pcloud.tenants.sshkeys.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.tenant-sshkey.delete" ] } ], "summary": "Delete a Tenant's SSH key", "tags": [ "PCloudTenantsSSHKeys" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant-sshkey.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.tenant-sshkey.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID/sshkeys/$SSHKEY_NAME \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.tenants.sshkeys.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKey" }, "examples": { "response": { "value": { "creationDate": "2024-10-04T15:23:53.543Z", "name": "sshkey-name", "sshKey": "ssh-rsa-key" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.tenant-sshkey.read" ] } ], "summary": "Get a Tenant's SSH Key by name", "tags": [ "PCloudTenantsSSHKeys" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant-sshkey.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.tenant-sshkey.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID/sshkeys/$SSHKEY_NAME \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/tenant_id" }, { "$ref": "#/components/parameters/sshkey_name" } ], "put": { "operationId": "pcloud.tenants.sshkeys.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKey" } } }, "description": "Parameters for updating a Tenant's SSH Key", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SSHKey" }, "examples": { "response": { "value": { "creationDate": "2024-10-04T15:23:53.543Z", "name": "new-sshkey-name", "sshKey": "new-ssh-rsa-key" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.tenant-sshkey.update" ] } ], "summary": "Update an SSH Key", "tags": [ "PCloudTenantsSSHKeys" ], "x-ibm-events": { "events": [ { "name": "power-iaas.tenant-sshkey.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.tenant-sshkey.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v1/tenants/$TENANT_ID/sshkeys/$SSHKEY_NAME \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"sshkey-name\"\n \"sshKey\": \"ssh-rsa-key\"\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/images/{image_id}/export": { "get": { "operationId": "pcloud.v2.images.export.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" }, "examples": { "response": { "value": { "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" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.image-export.read" ] } ], "summary": "Get detail of last image export job", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.job.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.image-export.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/images/$IMAGE_ID/export \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/image_id" } ], "post": { "operationId": "pcloud.v2.images.export.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportImage" } } }, "description": "Parameters for the export", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted, image export successfully added to the jobs queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/jobs/c113467d-8419-449c-8d81-259dda713d9f", "jobID": "c113467d-8419-449c-8d81-259dda713d9fcreate" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, a conflict has prevented adding image export job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.image-export.create" ] } ], "summary": "Add image export job to the jobs queue", "tags": [ "PCloudImages" ], "x-ibm-events": { "events": [ { "name": "power-iaas.image.export" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.image-export.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/images/$IMAGE_ID/export \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"bucketName\": \"cloud-object-storage-bucket\"\n \"accessKey\": \"347aa3a4b34344f8bc7c7cccdf856e4c\"\n }" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances": { "get": { "operationId": "pcloud.v2.pvminstances.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstancesV2" }, "examples": { "response": { "value": { "pvminstances": [ { "configuration": { "licenseRepositoryCapacity": 1, "systemReferenceCodes": [] }, "cores": { "assigned": 0.5, "maximum": 0.75, "minimum": 0.25 }, "creationDate": "2019-11-21T10:41:33.000Z", "deployment": { "machineType": "s922", "pinPolicy": "soft", "processorMode": "shared" }, "health": { "status": "ATTENTION" }, "host": { "id": 82 }, "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/6da0fd14-f7d3-4142-96f5-078df36c2539", "id": "6da0fd14-f7d3-4142-96f5-078df36c2539", "memory": { "assigned": 16, "maximum": 24, "minimum": 12 }, "name": "Test_VTL", "networkPorts": { "id": "c4af3a74-0852-4b1c-95d6-4b4b9bc040a7", "ipProtocol": "IPv4", "macAddress": "fa:f2:a4:c3:9e:a3", "privateIP": "192.168.0.0", "type": "static" }, "operatingSystem": { "type": "vtl", "version": "Linux/CentOS Linux 3.10.0-957.27.2.el7.ppc647 (AltArch), 7 (AltArch)" }, "placementGroup": { "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "status": "ACTIVE", "virtualCores": { "assigned": 15, "maximum": 20, "minimum": 10 } }, { "configuration": { "softwareLicenses": { "ibmiCSS": false, "ibmiDBQ": true, "ibmiPHA": false, "ibmiRDS": false }, "systemReferenceCodes": [] }, "cores": { "assigned": 0.5, "maximum": 0.75, "minimum": 0.25 }, "creationDate": "2020-01-17T05:55:28.000Z", "deployment": { "machineType": "s922", "pinPolicy": "none", "processorMode": "shared" }, "health": { "status": "WARNING" }, "host": { "id": 29 }, "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/35c0e26c-e51f-4230-b556-49ada44d8831", "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "memory": { "assigned": 16, "maximum": 24, "minimum": 12 }, "name": "Test_IBMI", "networkPorts": { "id": "1d57c166-d982-43a5-8487-f59e48632u2a", "ipProtocol": "IPv4", "macAddress": "fa:f2:5f:ea:15:20", "privateIP": "", "type": "dhcp" }, "operatingSystem": { "type": "ibmi", "version": "V7R3M0 410 9" }, "placementGroup": { "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "status": "ACTIVE", "virtualCores": { "assigned": 15, "maximum": 20, "minimum": 10 } }, { "configuration": { "sapProfile": { "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/sap/saptest-1x4", "profileID": "saptest-1x4" }, "systemReferenceCodes": [] }, "cores": { "assigned": 4, "maximum": 4, "minimum": 4 }, "creationDate": "2021-09-26T02:55:28.000Z", "deployment": { "machineType": "s922", "pinPolicy": "none", "processorMode": "dedicated", "type": "SAP-RISE" }, "health": { "status": "OK" }, "host": { "id": 37 }, "href": "/pcloud/v1/cloud-instances/969afb22cb004e808ab84b827abfa1b0/pvm-instances/35c0e26c-e51f-4230-b556-49adac4d8838", "id": "35c0e26c-e51f-4230-b556-49adac4d8838", "memory": { "assigned": 16, "maximum": 24, "minimum": 12 }, "name": "Test_RHEL", "networkPorts": { "id": "64782dfc-820f-45e7-9975-7320a548f116", "ipProtocol": "IPv4", "macAddress": "fa:f2:5f:3c:86:20", "privateIP": "192.168.2.153", "type": "static" }, "operatingSystem": { "type": "rhel", "version": "Linux/Red Hat Enterprise Linux 4.16.0-305.45.1.el8_4.ppc8.4 (Ootpa), 8.4 (Ootpa)" }, "placementGroup": { "id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee" }, "status": "ACTIVE", "virtualCores": { "assigned": 15, "maximum": 20, "minimum": 10 } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance.list" ] } ], "summary": "Get all the pvm instances for this cloud instance", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.pvm-instance.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com//pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ] }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/capture": { "get": { "operationId": "pcloud.v2.pvminstances.capture.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" }, "examples": { "response": { "value": { "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.pvm-instance-capture.read" ] } ], "summary": "Get detail of last capture job", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.job.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.pvm-instance-capture.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/capture \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "operationId": "pcloud.v2.pvminstances.capture.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PVMInstanceCapture" } } }, "description": "Parameters for the capture", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted, pvm-instance capture successfully added to the jobs queue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobReference" }, "examples": { "response": { "value": { "href": "pcloud/v1/jobs/c113467d-8419-449c-8d81-259dda713d9f", "jobID": "c113467d-8419-449c-8d81-259dda713d9f" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict, a conflict has prevented adding the pvm-instance capture job", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-capture.create" ] } ], "summary": "Add a capture pvm-instance to the jobs queue", "tags": [ "PCloudPVMInstances" ], "x-ibm-events": { "events": [ { "name": "power-iaas.job.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-capture.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/capture \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"captureName\": \"deployable-image-name\"\n \"captureDestination\": \"deployable-image-destination\"\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/pvm-instances/{pvm_instance_id}/volumes": { "delete": { "operationId": "pcloud.v2.pvminstances.volumes.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumesDetach" } } }, "description": "Parameter to detach multiple volumes from a PVMInstance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesDetachmentResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-volume.delete" ] } ], "summary": "Detach multiple volumes from a PVMInstance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.configure" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-volume.delete" } ] } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/pvm_instance_id" } ], "post": { "description": "Attach all volumes to a PVMInstance.\n>**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.", "operationId": "pcloud.v2.pvminstances.volumes.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/volumesAttach" } } }, "description": "Parameter to attach volumes to a PVMInstance", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesAttachmentResponse" }, "examples": { "response": { "value": { "summary": "The request to attach volumes to the server 2e456abe-3948-de91-3913-efca59681745 has been submitted successfully. Please check the server details for the status of the volume attachment request" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.pvm-instance-volume.create" ] } ], "summary": "Attach all volumes to a PVMInstance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.configure" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.pvm-instance-volume.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/pvm-instances/$PVM_INSTANCE_ID/volumes \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"volumeIDs\": [\"volID1\",\"volID2\"]\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes": { "delete": { "operationId": "pcloud.v2.volumes.delete", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesDelete" } } }, "description": "Parameters to delete volumes", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesDeleteResponse" } } } }, "206": { "description": "Partial Content", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesDeleteResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "408": { "description": "Request Timeout", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-volume.delete" ] } ], "summary": "Delete all volumes", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-volume.delete" } ] } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.v2.volumes.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultiVolumesCreate" } } }, "description": "Parameters for creating multiple volumes", "required": true }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Volumes" }, "examples": { "response": { "value": { "volumes": [ { "bootVolume": false, "bootable": false, "creationDate": "2020-08-04T15:34:28.000Z", "diskType": "tier3", "href": "/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/volumes/{volume_id}", "lastUpdateDate": "2020-08-04T15:34:28.000Z", "name": "base-name-1", "pvmInstanceIDs": [], "shareable": false, "size": 5, "state": "creating", "volumeID": "", "volumePool": "Tier3-Flash-1", "volumeType": "Tier3-Flash-1", "wwn": "322d6d22-5006-4813-9f9c-92d6acea84ee" }, { "bootVolume": false, "bootable": false, "creationDate": "2020-08-04T15:34:28.000Z", "diskType": "tier1", "href": "/pcloud/v1/cloud-instances/${CLOUD_INSTANCE_ID}/volumes/{volume_id}", "lastUpdateDate": "2020-08-04T15:34:28.000Z", "name": "base-name-2", "pvmInstanceIDs": [], "shareable": false, "size": 5, "state": "creating", "volumeID": "", "volumePool": "Tier1-Flash-1", "volumeType": "Tier1-Flash-1", "wwn": "322d6d22-5006-4813-9f9c-92d6acea84ee" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.cloud-instance-volume.create" ] } ], "summary": "Create multiple data volumes from a single definition", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.cloud-instance-volume.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"diskType\": \"tier3\",\n \"name\": \"volume-name\",\n \"shareable\": false,\n \"size\": \"volume-size\"\n \"volumePool\": \"StoragePool1\"\n \"affinityPolicy\": \"anti-affinity\"\n \"antiAffinityVolumes\": [\"data-volume-1\",\"data-volume-2\"]\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone": { "get": { "operationId": "pcloud.v2.volumesclone.getall", "parameters": [ { "$ref": "#/components/parameters/volumes_clone_filter" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesClones" }, "examples": { "response": { "value": [ { "action": "prepare", "creationDate": "2020-09-28T20:09:33.829Z", "lastUpdateDate": "2020-09-28T20:09:50.749Z", "name": "test2-Sep28", "percentComplete": 70, "status": "preparing", "volumesCloneID": "a4945ba6-5b4c-45b5-8312-485e3ac1ec3d" }, { "action": "start", "creationDate": "2020-09-28T19:42:38.618Z", "lastUpdateDate": "2020-09-28T19:44:52.386Z", "name": "test1-Sep28", "percentComplete": 100, "status": "available", "volumesCloneID": "8553bb63-7eac-405c-af8c-ccfe71186ca8" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-clone.list" ] } ], "summary": "Get the list of volumes-clone request for a cloud instance", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-clone.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n http://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "description": "Requires a minimum of two volumes.\nRequires a minimum of one volume to be in the `in-use` state.\nRequires a unique volumes clone name.\nPrepare action does the preparatory work for creating the snapshot volumes.\n>**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.\n", "operationId": "pcloud.v2.volumesclone.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneCreate" } } }, "description": "Parameters for preparing a set of volumes to be cloned", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesClone" }, "examples": { "response": { "value": { "action": "prepare", "creationDate": "2020-09-28T19:42:38.618Z", "lastUpdateDate": "2020-09-28T19:42:38.618Z", "name": "test1-Sep28", "percentComplete": 0, "status": "preparing", "volumesCloneID": "8553bb63-7eac-405c-af8c-ccfe71186ca8" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.create" ] } ], "summary": "Create a new volumes clone request and initiates the Prepare action\n", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request POST \\\n http://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"name\": \"test1-Sep28\",\n \"volumeIDs\": [\n \"test-vm-capture-1-boot\",\n \"test-vm-capture-1-data-1\",\n \"test-vm-capture-1-data-2\",\n \"test-vm-capture-1-data-3\",\n \"test-vm-capture-1-data-4\"\n ]\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}": { "delete": { "operationId": "pcloud.v2.volumesclone.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.delete" ] } ], "summary": "Delete a volumes-clone request", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone/$VOLUMES_CLONE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.v2.volumesclone.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneDetail" }, "examples": { "response": { "value": { "action": "execute", "clonedVolumes": [ { "clone": { "name": "clone-tim-xyz-23222-5", "volumeID": "38809cf7-0c9e-4c21-b4f5-b3b99305bf1a" }, "source": { "name": "tim-vm-capture-1-data-2", "volumeID": "f2e3d534-c2af-4ead-9ba5-54ccb43ead79" } }, { "clone": { "name": "clone-tim-xyz-23222-4", "volumeID": "920863d2-f6c1-4e21-8df5-d016bf6c10ef" }, "source": { "name": "tim-vm-capture-1-data-3", "volumeID": "bfa57ddb-dcfa-4aad-aee2-e63a95519a07" } }, { "clone": { "name": "clone-tim-xyz-23222-1", "volumeID": "67316c07-877f-4e2b-8126-dce1e1d36302" }, "source": { "name": "tim-test-capture-1-boot", "volumeID": "cf367e26-12b7-4870-9cf3-bf9a75e565ca" } }, { "clone": { "name": "clone-tim-xyz-23222-3", "volumeID": "3e2c0def-783d-426b-9121-56c7cfd313bb" }, "source": { "name": "tim-vm-capture-1-data-4", "volumeID": "3b58f6ee-095e-4e95-9c82-615a07e7d661" } }, { "clone": { "name": "clone-tim-xyz-23222-2", "volumeID": "d83b83e0-a8db-4ecd-a660-58fe13a12dba" }, "source": { "name": "tim-vm-capture-1-data-1", "volumeID": "d313abd1-827d-4803-9712-122aa9b667b7" } } ], "creationDate": "2020-09-28T19:42:38.618Z", "lastUpdateDate": "2020-09-28T19:49:03.914Z", "name": "test1-Sep28", "percentComplete": 100, "status": "completed", "volumesCloneID": "8553bb63-7eac-405c-af8c-ccfe71186ca8" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-clone.read" ] } ], "summary": "Get the details for a volumes-clone request", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-clone.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request GET \\\n http://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone/$VOLUMES_CLONE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volumes_clone_id" } ] }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/cancel": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volumes_clone_id" } ], "post": { "description": "Initiates the cleanup action that performs the cleanup of the preparatory clones and snapshot volumes.", "operationId": "pcloud.v2.volumesclone.cancel.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneCancel" } } }, "description": "Parameters for cancelling a volumes-clone request" }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesClone" }, "examples": { "response": { "value": { "action": "cancel", "creationDate": "2020-09-28T20:09:33.829Z", "lastUpdateDate": "2020-09-28T20:16:31.950Z", "name": "test2-Sep28", "percentComplete": 0, "status": "cancelling", "volumesCloneID": "a4945ba6-5b4c-45b5-8312-485e3ac1ec3d" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.cancel" ] } ], "summary": "Cancel a volumes-clone request\n", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.cancel" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request POST \\\n http://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone/$VOLUMES_CLONE_ID/cancel \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"force\": true\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/execute": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volumes_clone_id" } ], "post": { "description": "Execute action creates the cloned volumes using the volume snapshots.", "operationId": "pcloud.v2.volumesclone.execute.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneExecute" } } }, "description": "Parameters for the cloning of volumes", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesClone" }, "examples": { "response": { "value": { "action": "execute", "creationDate": "2020-09-28T19:42:38.618Z", "lastUpdateDate": "2020-09-28T19:47:04.309Z", "name": "test1-Sep28", "percentComplete": 0, "status": "executing", "volumesCloneID": "8553bb63-7eac-405c-af8c-ccfe71186ca8" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.execute" ] } ], "summary": "Initiate the Execute action for a volumes-clone request\n", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.execute" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request POST \\\n http://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone/$VOLUMES_CLONE_ID/execute \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"name\":\"test-volume\",\n \"rollbackPrepare\": false\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes-clone/{volumes_clone_id}/start": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/volumes_clone_id" } ], "post": { "description": "Start action starts the consistency group to initiate the flash copy.", "operationId": "pcloud.v2.volumesclone.start.post", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesClone" }, "examples": { "response": { "value": { "action": "start", "creationDate": "2020-09-28T19:42:38.618Z", "lastUpdateDate": "2020-09-28T19:44:52.386Z", "name": "test1-Sep28", "percentComplete": 100, "status": "available", "volumesCloneID": "8553bb63-7eac-405c-af8c-ccfe71186ca8" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.start" ] } ], "summary": "Initiate the Start action for a volumes-clone request\n", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.start" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.start" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl --location --request POST \\\n http://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes-clone/$VOLUMES_CLONE_ID/start \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone": { "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" } ], "post": { "operationId": "pcloud.v2.volumes.clone.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumesCloneAsyncRequest" } } }, "description": "Parameters for the cloning of volumes", "required": true }, "x-codegen-request-body-name": "body", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneTaskReference" }, "examples": { "response": { "value": { "cloneTaskID": "fe14b0f3-9027-41c0-b804-760bf95ffc1d", "href": "pcloud/v2/cloud-instances/${CLOUD_INSTANCE_ID}/volumes/clone-tasks/fe14b0f3-9027-41c0-b804-760bf95ffc1d" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.volume-clone.create" ] } ], "summary": "Create a volume clone for specified volumes", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.volume-clone.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes/clone \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"base-name\",\n \"volumeIDs\": [\n \"3f3a0c29-d459-4397-920c-10e42eecb658\",\n \"my-data-volume\"\n ]\n }'" ] } ] } ] } } } }, "/pcloud/v2/cloud-instances/{cloud_instance_id}/volumes/clone-tasks/{clone_task_id}": { "get": { "operationId": "pcloud.v2.volumes.clonetasks.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloneTaskStatus" }, "examples": { "response": { "value": { "clonedVolumes": [ { "clonedVolumeID": "d21f6941-aeb8-467e-9bd1-c11c0c34cd77", "sourceVolumeID": "3a70a152-c097-4892-914f-57e33aa8af10" }, { "clonedVolumeID": "a649a8dc-8191-490b-8a56-c1da40ae0529", "sourceVolumeID": "9af30313-79d5-4e40-bedf-8e4cd30fd3fb" } ] } } } }, "percentComplete": { "examples": { "response": { "value": 100 } } }, "status": { "examples": { "response": { "value": "completed" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-clone.read" ] } ], "summary": "Get the status of a volumes clone request for the specified clone task ID", "tags": [ "PCloudVolumes" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-clone.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com//pcloud/v2/cloud-instances/$CLOUD_INSTANCE_ID/volumes/clone-tasks/$CLONE_TASK_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/cloud_instance_id" }, { "$ref": "#/components/parameters/clone_task_id" } ] }, "/v1/available-hosts": { "get": { "operationId": "v1.availableHosts", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AvailableHostList" }, "examples": { "response": { "value": { "s1022": { "capacity": { "cores": { "total": 40 }, "memory": { "total": 2048 } }, "count": 1, "sysType": "s1022" }, "s922": { "capacity": { "cores": { "total": 20 }, "memory": { "total": 1024 } }, "count": 2, "sysType": "s922" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.available-hosts.list" ] } ], "summary": "List all the hosts that can be reserved", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.available-hosts.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.available-hosts.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/available-hosts \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/v1/datacenters": { "get": { "operationId": "v1.datacenters.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datacenters" }, "examples": { "response": { "value": { "datacenters": [ { "capabilities": { "cloud-connections": true, "disaster-recovery-site": true, "metrics": true, "power-edge-router": true, "power-vpn-connections": true }, "capabilitiesDetails": { "disasterRecovery": { "asynchronousReplication": { "enabled": true, "targetLocations": [ { "region": "lon04", "status": "active" } ] } }, "supportedSystems": { "dedicated": [], "general": [ "e1080", "s922" ] } }, "href": "https://dal.power-iaas.test.cloud.ibm.com/v1/datacenters/dal10", "location": { "region": "dal10", "regionDisplayName": "Dallas 10", "type": "datacenter", "url": "https://dal.power-iaas.test.cloud.ibm.com" }, "status": "active", "type": "off-premises" }, { "capabilities": { "cloud-connections": true, "disaster-recovery-site": false, "metrics": true, "power-edge-router": false, "power-vpn-connections": true }, "capabilitiesDetails": { "disasterRecovery": { "asynchronousReplication": { "enabled": true, "targetLocations": [ { "region": "dal10", "status": "active" } ] } }, "supportedSystems": { "dedicated": [ "e1080" ], "general": [ "e1080", "e980" ] } }, "href": "https://lon.power-iaas.test.cloud.ibm.com/v1/datacenters/lon04", "location": { "region": "lon04", "regionDisplayName": "London 04", "type": "datacenter", "url": "https://lon.power-iaas.test.cloud.ibm.com" }, "status": "active", "type": "off-premises" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "summary": "Get all Datacenters information and capabilities", "tags": [ "Datacenters" ], "x-ibm-events": { "events": [ { "name": "power-iaas.datacenter.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/datacenters \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/v1/datacenters/private": { "get": { "operationId": "v1.datacentersPrivate.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datacenters" }, "examples": { "response": { "value": { "datacenters": [ { "capabilities": { "cloud-connections": true, "disaster-recovery-site": false, "metrics": true, "power-edge-router": true, "power-vpn-connections": true }, "capabilitiesDetails": { "disasterRecovery": { "asynchronousReplication": { "enabled": false, "targetLocations": [] } }, "supportedSystems": { "dedicated": [], "general": [ "e1080", "s922" ] } }, "href": "https://ibm001-api.ibm001-roks-004c466fe3134b86f4e4c38d1d0a19b1-0000.us-south.containers.appdomain.cloud/v1/datacenters/private/satloc_dal_cjkfnk0205fov31ir19g", "location": { "region": "satloc_dal_cjkfnk0205fov31ir19g", "regionDisplayName": "My Satellite Name", "type": "datacenter", "url": "https://ibm001-api.ibm001-roks-004c466fe3134b86f4e4c38d1d0a19b1-0000.us-south.containers.appdomain.cloud" }, "status": "active", "type": "on-premises" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.datacenter-private.list" ] } ], "summary": "Get private Datacenter information and capabilities", "tags": [ "Datacenters" ], "x-ibm-events": { "events": [ { "name": "power-iaas.datacenter-private.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.datacenter-private.list" } ] } } }, "/v1/datacenters/private/{datacenter_region}": { "get": { "operationId": "v1.datacentersPrivate.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datacenter" }, "examples": { "response": { "value": { "capabilities": { "cloud-connections": true, "disaster-recovery-site": false, "metrics": true, "power-edge-router": false, "power-vpn-connections": true }, "capabilitiesDetails": { "disasterRecovery": { "asynchronousReplication": { "enabled": false, "targetLocations": [] } }, "supportedSystems": { "dedicated": [], "general": [ "e1080", "s922" ] } }, "location": { "region": "satloc_dal_cjkfnk0205fov31ir19g", "regionDisplayName": "My Satellite Name", "type": "datacenter", "url": "https://ibm001-api.ibm001-roks-004c466fe3134b86f4e4c38d1d0a19b1-0000.us-south.containers.appdomain.cloud" }, "status": "active", "type": "on-premises" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.datacenter-private.read" ] } ], "summary": "Get a private Datacenter's information and capabilities", "tags": [ "Datacenters" ], "x-ibm-events": { "events": [ { "name": "power-iaas.datacenter-private.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.datacenter-private.read" } ] } }, "parameters": [ { "$ref": "#/components/parameters/datacenter_region" } ] }, "/v1/datacenters/{datacenter_region}": { "get": { "operationId": "v1.datacenters.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Datacenter" }, "examples": { "response": { "value": { "capabilities": { "cloud-connections": true, "disaster-recovery-site": false, "metrics": true, "power-edge-router": false, "power-vpn-connections": true }, "capabilitiesDetails": { "disasterRecovery": { "asynchronousReplication": { "enabled": false, "targetLocations": [] } }, "supportedSystems": { "dedicated": [], "general": [ "e1080", "s922" ] } }, "location": { "region": "lon04", "regionDisplayName": "London 04", "type": "datacenter", "url": "https://lon.power-iaas.test.cloud.ibm.com" }, "status": "active", "type": "off-premises" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [], "summary": "Get a Datacenter's information and capabilities", "tags": [ "Datacenters" ], "x-ibm-events": { "events": [ { "name": "power-iaas.datacenter.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/datacenters/$DATACENTER_REGION \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/datacenter_region" } ] }, "/v1/host-groups": { "get": { "operationId": "v1.hostGroups.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroupList" }, "examples": { "response": { "value": [ { "creationDate": "2024-04-17T06:44:49.000Z", "hosts": [ "/v1/hosts/269" ], "id": "2e408848-3b5e-44a6-afcc-4fb929cb15ac", "name": "testHostGroup", "primary": "7c107dc5-4b97-46af-a8b7-32c1aeabfb73", "secondaries": [ "f1ab14fc-b085-4ff0-a053-3e42515c3115" ] }, { "creationDate": "2024-04-18T00:43:17.000Z", "hosts": [ "/v1/hosts/311", "/v1/hosts/408" ], "id": "4434fb0b-3abd-4973-a3bb-65729b16f05f", "name": "anotherHostGroup", "primary": "7c107dc5-4b97-46af-a8b7-32c1aeabfb73" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.host-group.list" ] } ], "summary": "Get the list of host groups for the workspace", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.host-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/host-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "post": { "operationId": "v1.hostGroups.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroupCreate" } } }, "description": "Parameters for the creation of a new host group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroup" }, "examples": { "response": { "value": { "creationDate": "2024-04-17T06:44:49.000Z", "hosts": [ "/v1/hosts/269" ], "id": "2e408848-3b5e-44a6-afcc-4fb929cb15ac", "name": "testHostGroup", "primary": "7c107dc5-4b97-46af-a8b7-32c1aeabfb73", "secondaries": [ "f1ab14fc-b085-4ff0-a053-3e42515c3115" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.host-group.create" ] } ], "summary": "Create a host group with one (or more) host", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host-group.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.host-group.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/host-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"hosts\": {\n \"displayName\": \"s922Host\",\n \"sysType\": \"s922\"\n },\n \"name\": \"testHostGroup\"\n }'" ] } ] } ] } } } }, "/v1/host-groups/{host_group_id}": { "get": { "operationId": "v1.hostGroups.id.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroup" }, "examples": { "response": { "value": { "creationDate": "2024-04-17T06:44:49.000Z", "hosts": [ "/v1/hosts/269" ], "id": "2e408848-3b5e-44a6-afcc-4fb929cb15ac", "name": "testHostGroup", "primary": "7c107dc5-4b97-46af-a8b7-32c1aeabfb73" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.host-group.read" ] } ], "summary": "Get the details of a host group", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.host-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/host-groups/$HOST_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/host_group_id" } ], "put": { "operationId": "v1.hostGroups.id.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroupShareOp" } } }, "description": "Parameters to set the sharing status of the host group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostGroup" }, "examples": { "response": { "value": { "creationDate": "2024-04-17T06:44:49.000Z", "hosts": [ "/v1/hosts/269" ], "id": "2e408848-3b5e-44a6-afcc-4fb929cb15ac", "name": "HostGroupPrimaryName", "primary": "7c107dc5-4b97-46af-a8b7-32c1aeabfb73", "secondaries": [ "f1ab14fc-b085-4ff0-a053-3e42515c3115" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.host-group.update" ] } ], "summary": "Share/unshare a host group with another workspace", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.host-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/v1/host-groups/$HOST_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"add\": [\n \"workspace\": \"f1ab14fc-b085-4ff0-a053-3e42515c3115\",\n \"name\": \"HostGroupSecondaryName\"\n ]\n }'" ] } ] } ] } } } }, "/v1/hosts": { "get": { "operationId": "v1.hosts.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostList" }, "examples": { "response": { "value": [ { "capacity": { "cores": { "available": 15, "reserved": 5, "total": 20, "used": 0 }, "memory": { "available": 940.65, "reserved": 83.35, "total": 1024, "used": 0 } }, "displayName": "s922Host", "hostGroup": { "access": "primary", "href": "/v1/host-groups/f63294c1-642f-4d83-9bdc-221bf2b72674", "name": "testHostGroup" }, "id": 308, "state": "up", "status": "enabled", "sysType": "s922" }, { "capacity": { "cores": { "available": 35, "reserved": 5, "total": 40, "used": 0 }, "memory": { "available": 1924.75, "reserved": 123.25, "total": 2048, "used": 0 } }, "displayName": "s1022Host", "hostGroup": { "access": "primary", "href": "/v1/host-groups/f63294c1-642f-4d83-9bdc-221bf2b72674", "name": "testHostGroup" }, "id": 401, "state": "up", "status": "enabled", "sysType": "s1022" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.host.list" ] } ], "summary": "Get the list of all the hosts the workspace has access to", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.host.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/hosts \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "post": { "operationId": "v1.hosts.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostCreate" } } }, "description": "Parameters to add a host to an existing host group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostList" }, "examples": { "response": { "value": { "capacity": { "cores": { "available": 15, "reserved": 5, "total": 20, "used": 0 }, "memory": { "available": 940.65, "reserved": 83.35, "total": 1024, "used": 0 } }, "displayName": "myHost", "hostGroup": { "access": "primary", "href": "/v1/host-groups/f63294c1-642f-4d83-9bdc-221bf2b72674", "name": "testHostGroup" }, "id": 308, "state": "up", "status": "enabled", "sysType": "s922" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.host.create" ] } ], "summary": "Add new host(s) to an existing host group", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.host.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/hosts \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"hostGroupID\": \"308\",\n \"hosts\": [\n \"displayName\": \"myHost\",\n \"sysType\": \"s922\"\n ]\n }'" ] } ] } ] } } } }, "/v1/hosts/{host_id}": { "delete": { "operationId": "v1.hosts.id.delete", "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.host.delete" ] } ], "summary": "Release a host from its host group", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host-group.delete" }, { "name": "power-iaas.host.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.host.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/hosts/$HOST_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "v1.hosts.id.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" }, "examples": { "response": { "value": { "capacity": { "cores": { "available": 15, "reserved": 5, "total": 20, "used": 0 }, "memory": { "available": 940.65, "reserved": 83.35, "total": 1024, "used": 0 } }, "displayName": "myHost", "hostGroup": { "access": "primary", "href": "/v1/host-groups/f63294c1-642f-4d83-9bdc-221bf2b72674", "name": "testHostGroup" }, "id": 308, "state": "up", "status": "enabled", "sysType": "s922" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.host.read" ] } ], "summary": "Get the details about a host", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.host.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/hosts/$HOST_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/host_id" } ], "put": { "operationId": "v1.hosts.id.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HostPut" } } }, "description": "Parameters to modify a host", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Host" }, "examples": { "response": { "value": { "capacity": { "cores": { "available": 15, "reserved": 5, "total": 20, "used": 0 }, "memory": { "available": 940.65, "reserved": 83.35, "total": 1024, "used": 0 } }, "displayName": "updatedHostName", "hostGroup": { "access": "primary", "href": "/v1/host-groups/f63294c1-642f-4d83-9bdc-221bf2b72674", "name": "testHostGroup" }, "id": 308, "state": "up", "status": "enabled", "sysType": "s922" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "504": { "description": "Gateway Timeout. Request is still processing and taking longer than expected.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.host.update" ] } ], "summary": "Modify the display name of a host", "tags": [ "HostGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.host.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.host.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/v1/hosts/$HOST_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"displayName\": \"updatedHostName\"\n }'" ] } ] } ] } } } }, "/v1/network-address-groups": { "get": { "operationId": "v1.networkAddressGroups.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroups" }, "examples": { "response": { "value": { "networkAddressGroups": [ { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:fd069983-6f93-bbe-965a-4b28ead1d5da", "id": "fd069983-6f93-7bbe-965a-4b28ead1d5da", "members": [], "name": "My VPC hosts" }, { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:699fd087-f963-b90e-596a-21d54bda8ead", "id": "699fd087-f963-b90e-596a-21d54bda8ead", "members": [], "name": "My mgmt hosts" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-address-group.list" ] } ], "summary": "Get the list of Network Address Groups for a workspace", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-address-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "post": { "operationId": "v1.networkAddressGroups.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroupCreate" } } }, "description": "Parameters for the creation of a Network Address Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:fd069983-6f93-bbe-965a-4b28ead1d5da", "id": "fd069983-6f93-bbe-965a-4b28ead1d5da", "members": [], "name": "My VPC hosts" } } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:fd069983-6f93-bbe-965a-4b28ead1d5da", "id": "fd069983-6f93-bbe-965a-4b28ead1d5da", "members": [], "name": "My VPC hosts" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-address-group.create" ] } ], "summary": "Create a new Network Address Group", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-address-group.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"name\": \"test-nag\"\n }`" ] } ] } ] } } } }, "/v1/network-address-groups/{network_address_group_id}": { "delete": { "operationId": "v1.networkAddressGroups.id.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-address-group.delete" ] } ], "summary": "Delete a Network Address Group from a workspace", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-address-group.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups/$NETWORK_ADDRESS_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "v1.networkAddressGroups.id.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:fd069983-6f93-bbe-965a-4b28ead1d5da", "id": "fd069983-6f93-bbe-965a-4b28ead1d5da", "members": [ { "cidr": "192.168.66.12/32", "id": "38dc88ff-d423-4490-aa95-7badbaefed54" }, { "cidr": "192.168.66.23/32", "id": "dc88f38f-b23b-4940-ba91-57bed4adbaef" } ], "name": "My VPC hosts" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-address-group.read" ] } ], "summary": "Get the detail of a Network Address Group", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-address-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups/$NETWORK_ADDRESS_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_address_group_id" } ], "put": { "operationId": "v1.networkAddressGroups.id.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroupUpdate" } } }, "description": "Parameters for the update of a Network Address Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:fd069983-6f93-bbe-965a-4b28ead1d5da", "id": "fd069983-6f93-bbe-965a-4b28ead1d5da", "members": [ { "cidr": "192.168.66.12/32", "id": "38dc88ff-d423-4490-aa95-7badbaefed54" }, { "cidr": "192.168.66.23/32", "id": "dc88f38f-b23b-4940-ba91-57bed4adbaef" } ], "name": "VPC hosts" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-address-group.update" ] } ], "summary": "Update a Network Address Group", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-address-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups/$NETWORK_ADDRESS_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\n -d `{\n \"name\": \"new-test-nag\"\n }`" ] } ] } ] } } } }, "/v1/network-address-groups/{network_address_group_id}/members": { "parameters": [ { "$ref": "#/components/parameters/network_address_group_id" } ], "post": { "operationId": "v1.networkAddressGroups.members.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroupAddMember" } } }, "description": "Parameters for adding a member to a Network Address Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkAddressGroupMember" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-address-group:fd069983-6f93-bbe-965a-4b28ead1d5da", "id": "fd069983-6f93-bbe-965a-4b28ead1d5da", "members": [ { "cidr": "192.168.66.12/32", "id": "38dc88ff-d423-4490-aa95-7badbaefed54" }, { "cidr": "192.168.66.23/32", "id": "dc88f38f-b23b-4940-ba91-57bed4adbaef" }, { "cidr": "192.168.66.27/32", "id": "8f38dc8e-983f-0494-9ba1-adbaef57bed4" } ], "name": "My VPC hosts" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-address-group.update" ] } ], "summary": "Add a member to a Network Address Group", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-address-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups/$NETWORK_ADDRESS_GROUP_ID/members \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"cidr\": \"198.168.0.0/24\"\n }`" ] } ] } ] } } } }, "/v1/network-address-groups/{network_address_group_id}/members/{network_address_group_member_id}": { "delete": { "operationId": "v1.networkAddressGroups.members.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-address-group.update" ] } ], "summary": "Delete the member from a Network Address Group", "tags": [ "NetworkAddressGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-address-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-address-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-address-groups/$NETWORK_ADDRESS_GROUP_ID/members/$MEMBER_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_address_group_id" }, { "$ref": "#/components/parameters/network_address_group_member_id" } ] }, "/v1/network-security-groups": { "get": { "operationId": "v1.networkSecurityGroups.list", "parameters": [ { "in": "query", "name": "default_nsg", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroups" }, "examples": { "response": { "value": { "networkSecurityGroups": [ { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:6fd06f93-9983-4bbe-965a-4b2d1d5d8eaa", "default": false, "id": "6fd06f93-9983-4bbe-965a-4b2d1d5d8eaa", "members": [], "name": "Web_Servers", "rules": [] }, { "default": true, "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.66.2", "type": "ipv4-address" }, { "id": "8c5402e5-12e5-7d07-8753-8a7523712bc6", "target": "192.168.66.10", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "File_Servers", "rules": [] } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-security-group.list" ] } ], "summary": "Get the list of Network Security Groups for a workspace", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-security-group.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "post": { "operationId": "v1.networkSecurityGroups.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupCreate" } } }, "description": "Parameters for the creation of a Network Security Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8251:eb12d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:6fd06f93-9983-4bbe-965a-4b2d1d5d8eaa", "id": "6fd06f93-9983-4bbe-965a-4b2d1d5d8eaa", "members": [], "name": "Web_Servers", "rules": [], "tags": [ "webserver", "production" ] } } } } } }, "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8251:eb12d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:6fd06f93-9983-4bbe-965a-4b2d1d5d8eaa", "id": "6fd06f93-9983-4bbe-965a-4b2d1d5d8eaa", "members": [], "name": "Web_Servers", "rules": [], "tags": [ "webserver", "production" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.create" ] } ], "summary": "Create a new Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"name\": \"Web_Servers\"\n }`" ] } ] } ] } } } }, "/v1/network-security-groups/action": { "post": { "operationId": "v1.networkSecurityGroups.action.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupsAction" } } }, "description": "Parameters for the desired action", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "550": { "description": "Workspace Status Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.enable" ] } ], "summary": "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", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.workspace.enable" }, { "name": "power-iaas.workspace.disable" }, { "name": "power-iaas.workspace.unknown" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.enable" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/action \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"action\":\"enable\"\n }`" ] } ] } ] } } } }, "/v1/network-security-groups/{network_security_group_id}": { "delete": { "operationId": "v1.networkSecurityGroups.id.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.delete" ] } ], "summary": "Delete a Network Security Group from a workspace", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "v1.networkSecurityGroups.id.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:50368740-ff96-555d-999e-45c4a1535ddc", "default": "false", "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.66.2", "type": "ipv4-address" }, { "id": "8c5402e5-12e5-7d07-8753-8a7523712bc6", "target": "192.168.67.10", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "Production_Servers", "rules": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-security-group.read" ] } ], "summary": "Get the detail of a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-security-group.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_security_group_id" } ], "post": { "operationId": "v1.networkSecurityGroups.id.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupClone" } } }, "description": "Parameters for the clone of a Network Security Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:50368740-ff96-555d-999e-45c4a1535ddc", "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.1.5", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "Updated Production Servers", "rules": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.clone" ] } ], "summary": "Clone a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.clone" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.clone" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"name\": \"clone-nsg\"\n }`" ] } ] } ] } } }, "put": { "operationId": "v1.networkSecurityGroups.id.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupUpdate" } } }, "description": "Parameters for the update of a Network Security Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroup" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:50368740-ff96-555d-999e-45c4a1535ddc", "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.1.5", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "Updated Production Servers", "rules": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.update" ] } ], "summary": "Update a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"name\": \"new-test-nsg\"\n }`" ] } ] } ] } } } }, "/v1/network-security-groups/{network_security_group_id}/members": { "parameters": [ { "$ref": "#/components/parameters/network_security_group_id" } ], "post": { "operationId": "v1.networkSecurityGroups.members.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupAddMember" } } }, "description": "Parameters for adding a member to a Network Security Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupMember" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:50368740-ff96-555d-999e-45c4a1535ddc", "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.1.5", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "Production_Servers", "rules": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.update" ] } ], "summary": "Add a member to a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID/members \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"target\":\"99999999-9999-9999-9999-999999999999\",\n \"type\": \"network-interface\"\n }`" ] } ] } ] } } } }, "/v1/network-security-groups/{network_security_group_id}/members/{network_security_group_member_id}": { "delete": { "operationId": "v1.networkSecurityGroups.members.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.update" ] } ], "summary": "Delete the member from a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ "name:power-iaas.network-security-group.update" ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID/members/$MEMBER_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_security_group_id" }, { "$ref": "#/components/parameters/network_security_group_member_id" } ] }, "/v1/network-security-groups/{network_security_group_id}/move_member": { "parameters": [ { "$ref": "#/components/parameters/network_security_group_id" } ], "post": { "operationId": "v1.networkSecurityGroups.move_member.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupMoveMember" } } }, "description": "Parameters for moving a Network Security Group member to another Network Security Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupMember" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:50368740-ff96-555d-999e-45c4a1535ddc", "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.1.5", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "Updated Production Servers", "rules": [] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.update" ] } ], "summary": "Move a Network Security Group member to another Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X post \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID/move_member \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\\\n -d `{\n \"MemberID\":\"99999999-9999-9999-9999-999999999999\",\n \"NetworkSecurityGroupId\": \"99999999-9999-9999-9999-999999999999\"\n }`" ] } ] } ] } } } }, "/v1/network-security-groups/{network_security_group_id}/rules": { "parameters": [ { "$ref": "#/components/parameters/network_security_group_id" } ], "post": { "operationId": "v1.networkSecurityGroups.rules.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupAddRule" } } }, "description": "Parameters for adding a rule to a Network Security Group", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkSecurityGroupRule" }, "examples": { "response": { "value": { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-security-group:50368740-ff96-555d-999e-45c4a1535ddc", "id": "50368740-ff96-555d-999e-45c4a1535ddc", "members": [ { "id": "402333c5-bce5-9d08-1853-c652278a7b17", "target": "192.168.1.5", "type": "ipv4-address" }, { "id": "5402f8c5-b854-4e57-9222-bc6528a72753", "macAddress": "5E-B1-D0-63-C2-26", "target": "6f91f8c5-c871-423e-8922-8a727bc65243", "type": "network-interface" } ], "name": "Production_Servers", "rules": [ { "action": "allow", "id": "541133c2-ffe5-8608-4651-f6528a7b1727", "name": "Allow all inbound", "protocol": { "type": "all" }, "remote": { "id": "02f58c54-efe5-9807-1253-52278a76bc17", "type": "network-address-group" } }, { "action": "deny", "destinationPorts": { "maximum": 22, "minimum": 22 }, "id": "113354c2-e5ff-7707-6512-f7b176528a26", "name": "Deny inbound ssh", "protocol": "tcp", "remote": { "id": "02f58c54-efe5-9807-1253-52278a76bc17", "type": "network-address-group" } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.update" ] } ], "summary": "Add a rule to a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-address-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID/rules \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"action\":\"allow\",\n \"protocol\": {\n \"tcpFlags\": null,\n \"type\": \"all\"\n },\n \"remote\": {\n \"id\": \"e03e8cf3-790d-47ee-9e73-b46859317929\",\n \"type\": \"network-address-group\"\n }\n }`" ] } ] } ] } } } }, "/v1/network-security-groups/{network_security_group_id}/rules/{network_security_group_rule_id}": { "delete": { "operationId": "v1.networkSecurityGroups.rules.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-security-group.update" ] } ], "summary": "Delete the rule from a Network Security Group", "tags": [ "NetworkSecurityGroups" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-security-group.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-security-group.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/network-security-groups/$NETWORK_SECURITY_GROUP_ID/rules/$RULE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_security_group_id" }, { "$ref": "#/components/parameters/network_security_group_rule_id" } ] }, "/v1/networks/{network_id}/network-interfaces": { "get": { "operationId": "v1.networks.network-interfaces.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkInterfaces" }, "examples": { "response": { "value": { "network-interfaces": [ { "description": "", "href": "/v1/networks/4d8713c5-123d-4662-8f58-8578c79d6814/network-interface/10890e8a-158b-49b5-8d05-96efd9f44824", "ipAddress": "192.168.140.28", "macAddress": "fa:16:3e:6a:35:cd", "networkInterfaceID": "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": "/v1/networks/4d8713c5-123d-4662-8f58-8578c79d6814/network-interfaces/6a863b69-aa0c-48fa-8ce7-b69051f844ee", "ipAddress": "192.168.140.26", "macAddress": "fa:68:11:17:77:20", "networkInterfaceID": "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" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-interfaces.list" ] } ], "summary": "Get all Network Interfaces for this network", "tags": [ "Networks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-interfaces.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-interfaces.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/networks/$NETWORK_ID/network-interfaces \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_id" } ], "post": { "operationId": "v1.networks.network-interfaces.post", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkInterfaceCreate" } } }, "description": "Create a Network Interface" }, "x-codegen-request-body-name": "body", "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkInterface" }, "examples": { "response": { "value": { "networkInterfaces": [ { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-interface:4123d3c5-162d-48f5-5858-8578c479d681", "id": "4123d3c5-162d-48f5-5858-8578c479d681", "ipAddress": "192.168.140.28", "macAddress": "fa:16:3e:6a:35:cd", "name": "", "pvmInstance": { "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/08490a29-ce61-4064-9a3b-ca051e005cf7", "pvmInstanceID": "08490a29-ce61-4064-9a3b-ca051e005cf7" }, "status": "DOWN" }, { "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/ee765275f5d44b459e1ebfbc764a8252:4567d63c-b171-47ca-a8d8-51d2dc7674e6:network-interface: 6a863b69-aa0c-48fa-8ce7-b69051f844ee", "id": "6a863b69-aa0c-48fa-8ce7-b69051f844ee", "ipAddress": "192.168.140.26", "macAddress": "fa:68:11:17:77:20", "name": "", "pvmInstance": { "href": "/pcloud/v1/cloud-instances/66b2c271412a4726b4ba72db3637ee60/pvm-instances/ad2f6b96-9063-456c-a1a7-725eebdc86c1", "pvmInstanceID": "ad2f6b96-9063-456c-a1a7-725eebdc86c1" }, "status": "ACTIVE" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-interfaces.create" ] } ], "summary": "Perform Network Interface addition, deletion, and listing", "tags": [ "Networks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-interfaces.create" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-interfaces.create" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X POST \\\n https://us-east.power-iaas.cloud.ibm.com/v1/networks/$NETWORK_ID/network-interfaces \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"\\\n -d `{\n \"ipAddress\":\"192.168.3.2\",\n \"name\": \"test-interface\"\n }`" ] } ] } ] } } } }, "/v1/networks/{network_id}/network-interfaces/{network_interface_id}": { "delete": { "operationId": "v1.networks.network-interfaces.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-interfaces.delete" ] } ], "summary": "Delete a Network Interface", "tags": [ "Networks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-interfaces.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-interfaces.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com /v1/networks/$NETWORK_ID/network-interfaces/$NETWORK_INTERFACE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "v1.networks.network-interfaces.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkInterface" }, "examples": { "response": { "value": { "crn": null, "description": "", "ipAddress": "192.168.140.28", "macAddress": "fa:16:3e:6a:35:cd", "networkInterfaceID": "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" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.network-interfaces.read" ] } ], "summary": "Get a Network Interface's information", "tags": [ "Networks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-interfaces.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.network-interfaces.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com /v1/networks/$NETWORK_ID/network-interfaces/$NETWORK_INTERFACE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/network_id" }, { "$ref": "#/components/parameters/network_interface_id" } ], "put": { "operationId": "v1.networks.network-interfaces.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkInterfaceUpdate" } } }, "description": "Parameters for updating a Network Interface", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NetworkInterface" }, "examples": { "response": { "value": { "examples": { "crn": null, "description": "", "ipAddress": "192.168.140.28", "macAddress": "fa:16:3e:6a:35:cd", "networkInterfaceID": "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" } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.network-interfaces.update" ] } ], "summary": "Update a Network Interface's information", "tags": [ "Networks" ], "x-ibm-events": { "events": [ { "name": "power-iaas.network-interfaces.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.network-interfaces.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/v1/networks/$NETWORK_ID/network-interfaces/$NETWORK_INTERFACE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"name\": \"new-test-interface\"\n }`" ] } ] } ] } } } }, "/v1/snapshots": { "get": { "deprecated": true, "description": "This API is deprecated for /v1/snapshots.\nThe API v1/volume-snapshots has replaced this endpoint.\n\nView the usage of snapshots on the workspace. The snapshots may take time sync because the data is cached.\n", "operationId": "v1.snapshots.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotList" }, "examples": { "response": { "value": { "snapshots": [ { "creationDate": "2024-02-01T16:44:42.000Z", "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "name": "snapshot-list-1", "size": 0.5874996185302734, "status": "available", "updatedDate": "2024-02-01T16:44:42.000Z", "volumeID": "b77b3324-3958-4a08-851a-77a57a2d4720" }, { "creationDate": "2024-01-05T13:44:42.000Z", "id": "421328d7-78bd-4374-ad6b-479f43da838d", "name": "snapshot-list-2", "size": 0.2874396185302784, "status": "available", "updatedDate": "2024-01-05T16:44:42.000Z", "volumeID": "346f8fcd-a41c-4256-918f-5b07ac007914" } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.snapshot.list" ] } ], "summary": "Get a list of all the snapshots on a workspace", "tags": [ "Snapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.snapshot.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.snapshot.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/snapshots \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/v1/snapshots/{snapshot_id}": { "get": { "deprecated": true, "description": "This API is deprecated for /v1/snapshots.\nThe API v1/volume-snapshots has replaced this endpoint.\n\nView the usage of a snapshot. The snapshot may take time sync because the data is cached.\n", "operationId": "v1.snapshots.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotV1" }, "examples": { "response": { "value": { "creationDate": "2024-02-01T16:44:42.000Z", "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "name": "snapshot-list-1", "size": 0.5874996185302734, "status": "available", "updatedDate": "2024-02-01T16:44:42.000Z", "volumeID": "b77b3324-3958-4a08-851a-77a57a2d4720" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.snapshot.read" ] } ], "summary": "Get the detail of a snapshot", "tags": [ "Snapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.snapshot.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.snapshot.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/snapshots/$SNAPSHOT_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/snapshot_id" } ] }, "/v1/virtual-serial-number": { "get": { "operationId": "pcloud.virtualserialnumber.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSerialNumberList" }, "examples": { "response": { "value": [ { "description": "Retained VSN for VM1", "pvmInstanceID": "123db39a-e21d-4ad1-80dc-c39dd524aeb1", "serial": "VSPVCZ0" }, { "description": "Retained VSN for VM2", "pvmInstanceID": "null", "serial": "VSPVCZ1" }, { "description": "Retained VSN for VM3", "pvmInstanceID": "null", "serial": "VSPVCZ2" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.virtual-serial-number.list" ] } ], "summary": "List all utilized and retained VSNs", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.virtual-serial-number.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.virtual-serial-number.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/virtual-serial-number \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/pvmInstanceID" } ] }, "/v1/virtual-serial-number/{virtual_serial_number}": { "delete": { "operationId": "pcloud.virtualserialnumber.delete", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.virtual-serial-number.delete" ] } ], "summary": "Unreserve a retained Virtual Serial Number", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.virtual-serial-number.delete" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.virtual-serial-number.delete" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X DELETE \\\n https://us-east.power-iaas.cloud.ibm.com/v1/virtual-serial-number/$VIRTUAL_SERIAL_NUMBER \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "get": { "operationId": "pcloud.virtualserialnumber.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VirtualSerialNumber" }, "examples": { "response": { "value": [ { "description": "Description for VM-1", "pvmInstanceID": "vm-1", "serial": "VSPVCZ0" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.virtual-serial-number.read" ] } ], "summary": "Get information for a Virtual Serial Number", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.virtual-serial-number.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.virtual-serial-number.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/virtual-serial-number/$VIRTUAL_SERIAL_NUMBER \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/virtual_serial_number" } ], "put": { "operationId": "pcloud.virtualserialnumber.put", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVirtualSerialNumber" } } }, "description": "Parameters to edit description of a reserved Virtual Serial Number", "required": true }, "x-codegen-request-body-name": "body", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetServerVirtualSerialNumber" }, "examples": { "response": { "value": [ { "description": "Description for VM-1", "serial": "VSPVCZ0" } ] } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "410": { "description": "Gone", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.modify", "power-iaas.virtual-serial-number.update" ] } ], "summary": "Update Description of a Reserved Virtual Serial Number", "tags": [ "PCloudVirtualSerialNumber" ], "x-ibm-events": { "events": [ { "name": "power-iaas.virtual-serial-number.update" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "name": "power-iaas.virtual-serial-number.update" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X PUT \\\n https://us-east.power-iaas.cloud.ibm.com/v1/virtual-serial-number/$VIRTUAL_SERIAL_NUMBER \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\" \\\n -d `{\n \"description\": \"test-description\",\n \"serial\": \"'\"$VIRTUAL_SERIAL_NUMBER\"'\"\n }`" ] } ] } ] } } } }, "/v1/volume-snapshots": { "get": { "description": "View the usage of volume snapshots on the workspace. The volume snapshots may take time sync because the data is cached.", "operationId": "v1.volume-snapshots.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeSnapshotList" }, "examples": { "response": { "value": [ { "creationDate": "2024-02-01T16:44:42.000Z", "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "name": "snapshot-list-1", "size": 0.5874996185302734, "status": "available", "updatedDate": "2024-02-01T16:44:42.000Z", "volumeID": "b77b3324-3958-4a08-851a-77a57a2d4720" }, { "creationDate": "2024-01-05T13:44:42.000Z", "id": "421328d7-78bd-4374-ad6b-479f43da838d", "name": "snapshot-list-2", "size": 0.2874396185302784, "status": "available", "updatedDate": "2024-01-05T16:44:42.000Z", "volumeID": "346f8fcd-a41c-4256-918f-5b07ac007914" } ] } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-snapshot.list" ] } ], "summary": "Get the list of volume snapshots on a workspace", "tags": [ "Snapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-snapshot.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-snapshot.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/volume-snapshots \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/v1/volume-snapshots/{volume_snapshot_uuid}": { "get": { "description": "View the usage of a snapshot. The snapshot may take time sync because the data is cached.", "operationId": "v1.volume-snapshots.getall", "parameters": [ { "$ref": "#/components/parameters/volume_snapshot_uuid" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SnapshotV1" }, "examples": { "response": { "value": { "creationDate": "2024-02-01T16:44:42.000Z", "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "name": "snapshot-list-1", "size": 0.5874996185302734, "status": "available", "updatedDate": "2024-02-01T16:44:42.000Z", "volumeID": "b77b3324-3958-4a08-851a-77a57a2d4720" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Service Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "OauthSecurity": [ "power-iaas.cloud-instance.read", "power-iaas.volume-snapshot.read" ] } ], "summary": "Get the detail of a volume snapshot", "tags": [ "Snapshots" ], "x-ibm-events": { "events": [ { "name": "power-iaas.volume-snapshot.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.volume-snapshot.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/volume-snapshots/$VOLUME_SNAPSHOT_UUID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"CRN: $CRN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/v1/workspaces": { "get": { "operationId": "v1.workspaces.getall", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspaces" }, "examples": { "response": { "value": { "workspaces": [ { "capabilities": { "cloud-connections": false, "power-edge-router": true, "power-vpn-connections": false, "transit-gateway-connection": false }, "details": { "creationDate": "2023-02-09T04:28:26.961Z", "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/abc12345678910e112131c1516171d19:6da0fd14-f7d3-4142-96f5-078df36c2539::", "href": "https://dal.power-iaas.test.cloud.ibm.com/pcloud/v1/workspaces/6da0fd14-f7d3-4142-96f5-078df36c2539", "powerEdgeRouter": { "state": "active", "type": "automated" } }, "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "location": { "region": "dal10", "type": "datacenter", "url": "https://dal.power-iaas.test.cloud.ibm.com" }, "name": "Workspace for Power Systems Virtual Server Dallas", "status": "active", "type": "Off-Premises" }, { "capabilities": { "cloud-connections": true, "power-edge-router": false, "power-vpn-connections": true, "transit-gateway-connection": false }, "details": { "creationDate": "2022-04-17T15:30:47.961Z", "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/abc12345678910e112131c1516171d19:35c0e26c-e51f-4230-b556-49ada44d8831::", "href": "https://dal.power-iaas.test.cloud.ibm.com/pcloud/v1/workspaces/35c0e26c-e51f-4230-b556-49ada44d8831" }, "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "location": { "region": "dal13", "type": "datacenter", "url": "https://dal.power-iaas.test.cloud.ibm.com" }, "name": "Dallas13 Workspace", "status": "active", "type": "Off-Premises" } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "Get all Workspaces information and capabilities for a tenant", "tags": [ "Workspaces" ], "x-ibm-events": { "events": [ { "name": "power-iaas.workspace.list" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.workspace.list" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/workspaces \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } } }, "/v1/workspaces/{workspace_id}": { "get": { "operationId": "v1.workspaces.get", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workspace" }, "examples": { "response": { "value": { "capabilities": { "cloud-connections": true, "power-edge-router": false, "power-vpn-connections": true, "transit-gateway-connection": false }, "details": { "creationDate": "2022-04-17T15:30:47.961Z", "crn": "crn:v1:bluemix:public:power-iaas:dal12:a/abc12345678910e112131c1516171d19:35c0e26c-e51f-4230-b556-49ada44d8831::" }, "id": "35c0e26c-e51f-4230-b556-49ada44d8831", "location": { "region": "dal13", "type": "datacenter", "url": "https://dal.power-iaas.test.cloud.ibm.com" }, "name": "Workspace for Power Systems Virtual Server-test", "status": "active", "type": "Off-Premises" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "summary": "Get a Workspace's information and capabilities", "tags": [ "Workspaces" ], "x-ibm-events": { "events": [ { "name": "power-iaas.workspace.read" } ] }, "x-ibm-permissions": { "actions": [ { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.modify" }, { "description": "Grants access to this and other methods.", "name": "power-iaas.cloud-instance.read" }, { "name": "power-iaas.workspace.read" } ] }, "x-sdk-operations": { "request-examples": { "curl": [ { "name": "Example request", "example": [ { "type": "code", "lang": "curl", "source": [ "curl -X GET \\\n https://us-east.power-iaas.cloud.ibm.com/v1/workspaces/$WORKSPACE_ID \\\n -H \"Authorization: Bearer $TOKEN\" \\\n -H \"Content-Type: application/json\"" ] } ] } ] } } }, "parameters": [ { "$ref": "#/components/parameters/workspace_id" } ] } }, "components": { "parameters": { "accept_language": { "description": "The language requested for the return document", "in": "header", "name": "Accept-Language", "schema": { "type": "string" } }, "affinity": { "description": "A pvmInstance (id or name), limits a volumes list response to only volumes that have affinity to the pvmInstance", "in": "query", "name": "affinity", "schema": { "type": "string" } }, "auxiliary": { "description": "true or false, limits a volume list to auxiliary or non auxiliary volumes", "in": "query", "name": "auxiliary", "schema": { "type": "boolean" } }, "clone_task_id": { "description": "Volumes Clone Task ID", "in": "path", "name": "clone_task_id", "required": true, "schema": { "type": "string" } }, "cloud_connection_id": { "description": "Cloud Connection ID", "in": "path", "name": "cloud_connection_id", "required": true, "schema": { "type": "string" } }, "cloud_instance_id": { "description": "Cloud Instance ID of a PCloud Instance", "in": "path", "name": "cloud_instance_id", "required": true, "schema": { "type": "string" } }, "datacenter_region": { "description": "Datacenter Region", "in": "path", "name": "datacenter_region", "required": true, "schema": { "type": "string" } }, "delete_data_volumes": { "description": "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.", "in": "query", "name": "delete_data_volumes", "schema": { "type": "boolean" } }, "event_id": { "description": "Event ID", "in": "path", "name": "event_id", "required": true, "schema": { "type": "string" } }, "filter": { "description": "A filter expression that filters resources listed in the response", "in": "query", "name": "filter", "schema": { "type": "string" } }, "from_time": { "description": "A from query time in either ISO 8601 or unix epoch format", "in": "query", "name": "from_time", "schema": { "type": "string" } }, "host_group_id": { "description": "Hostgroup ID", "in": "path", "name": "host_group_id", "required": true, "schema": { "type": "string" } }, "host_id": { "description": "Host ID", "in": "path", "name": "host_id", "required": true, "schema": { "type": "string" } }, "ike_policy_id": { "description": "ID of a IKE Policy", "in": "path", "name": "ike_policy_id", "required": true, "schema": { "type": "string" } }, "image_id": { "description": "Image ID of a image", "in": "path", "name": "image_id", "required": true, "schema": { "type": "string" } }, "include_sap_images": { "description": "Include SAP images with get available stock images", "in": "query", "name": "sap", "schema": { "type": "boolean" } }, "include_vtl_images": { "description": "Include VTL images with get available stock images", "in": "query", "name": "vtl", "schema": { "type": "boolean" } }, "ipsec_policy_id": { "description": "ID of a IPSec Policy", "in": "path", "name": "ipsec_policy_id", "required": true, "schema": { "type": "string" } }, "job_id": { "description": "PCloud Job ID", "in": "path", "name": "job_id", "required": true, "schema": { "type": "string" } }, "network_address_group_id": { "description": "Network Address Group ID", "in": "path", "name": "network_address_group_id", "required": true, "schema": { "type": "string" } }, "network_address_group_member_id": { "description": "The Network Address Group Member ID", "in": "path", "name": "network_address_group_member_id", "required": true, "schema": { "type": "string" } }, "network_id": { "description": "Network ID", "in": "path", "name": "network_id", "required": true, "schema": { "type": "string" } }, "network_interface_id": { "description": "Network Interface ID", "in": "path", "name": "network_interface_id", "required": true, "schema": { "type": "string" } }, "network_security_group_id": { "description": "Network Security Group ID", "in": "path", "name": "network_security_group_id", "required": true, "schema": { "type": "string" } }, "network_security_group_member_id": { "description": "Network Security Group Member ID", "in": "path", "name": "network_security_group_member_id", "required": true, "schema": { "type": "string" } }, "network_security_group_rule_id": { "description": "Network Security Group Rule ID", "in": "path", "name": "network_security_group_rule_id", "required": true, "schema": { "type": "string" } }, "operation_action": { "description": "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)", "in": "query", "name": "operation.action", "schema": { "type": "string", "enum": [ "vmCapture", "imageExport", "imageImport", "storage" ] } }, "operation_id": { "description": "Operation ID to filter jobs (optional)", "in": "query", "name": "operation.id", "schema": { "type": "string" } }, "operation_target": { "description": "Operation target to filter jobs (optional)", "in": "query", "name": "operation.target", "schema": { "type": "string", "enum": [ "cloudConnection", "pvmInstance", "image", "vpnConnection" ] } }, "placement_group_id": { "description": "Placement Group ID", "in": "path", "name": "placement_group_id", "required": true, "schema": { "type": "string" } }, "port_id": { "description": "Port ID", "in": "path", "name": "port_id", "required": true, "schema": { "type": "string" } }, "profile_family_filter": { "description": "SAP profile family to filter by", "in": "query", "name": "profile_family", "schema": { "type": "string", "enum": [ "balanced", "compute", "memory", "sap-rise", "small", "ultra-memory" ] } }, "profile_prefix_filter": { "description": "SAP profile prefix to filter by", "in": "query", "name": "profile_prefix", "schema": { "type": "string", "enum": [ "bh1", "bh2", "ch1", "ch2", "mh1", "mh2", "umh", "ush1", "sh2", "sr2" ] } }, "pvmInstanceID": { "description": "PVM Instance ID", "in": "query", "name": "pvmInstanceID", "schema": { "type": "string" } }, "pvm_instance_id": { "description": "PCloud PVM Instance ID", "in": "path", "name": "pvm_instance_id", "required": true, "schema": { "type": "string" } }, "replication_enabled": { "description": "true or false, limits a volumes list to replication or non replication enabled volumes", "in": "query", "name": "replicationEnabled", "schema": { "type": "boolean" } }, "restore_fail_action": { "description": "Action to take on a failed snapshot restore", "in": "query", "name": "restore_fail_action", "schema": { "type": "string", "enum": [ "retry", "rollback" ] } }, "route_id": { "description": "Route ID", "in": "path", "name": "route_id", "required": true, "schema": { "type": "string" } }, "sap_profile_id": { "description": "SAP Profile ID", "in": "path", "name": "sap_profile_id", "required": true, "schema": { "type": "string" } }, "shared_processor_pool_id": { "description": "Shared Processor Pool ID or Name", "in": "path", "name": "shared_processor_pool_id", "required": true, "schema": { "type": "string" } }, "snapshot_id": { "description": "PVM Instance snapshot id", "in": "path", "name": "snapshot_id", "required": true, "schema": { "type": "string" } }, "snapshot_uuid": { "description": "The snapshot UUID", "in": "path", "name": "snapshot_uuid", "required": true, "schema": { "type": "string" } }, "spp_placement_group_id": { "description": "Shared Processor Pool Placement Group ID or Name", "in": "path", "name": "spp_placement_group_id", "required": true, "schema": { "type": "string" } }, "sshkey_name": { "description": "SSH key name for a pcloud tenant", "in": "path", "name": "sshkey_name", "required": true, "schema": { "type": "string" } }, "storage_pool_name": { "description": "Storage pool name", "in": "path", "name": "storage_pool_name", "required": true, "schema": { "type": "string" } }, "storage_type_name": { "description": "Storage type name", "in": "path", "name": "storage_type_name", "required": true, "schema": { "type": "string" } }, "task_id": { "description": "PCloud Task ID", "in": "path", "name": "task_id", "required": true, "schema": { "type": "string" } }, "tenant_id": { "description": "Tenant ID of a pcloud tenant", "in": "path", "name": "tenant_id", "required": true, "schema": { "type": "string" } }, "time": { "description": "(deprecated - use from_time) A time in either ISO 8601 or unix epoch format", "in": "query", "name": "time", "schema": { "type": "string" } }, "to_time": { "description": "A to query time in either ISO 8601 or unix epoch format", "in": "query", "name": "to_time", "schema": { "type": "string" } }, "virtual_serial_number": { "description": "Virtual Serial Number", "in": "path", "name": "virtual_serial_number", "required": true, "schema": { "type": "string" } }, "volume_group_id": { "description": "The ID of the volume group", "in": "path", "name": "volume_group_id", "required": true, "schema": { "type": "string" } }, "volume_id": { "description": "Volume ID", "in": "path", "name": "volume_id", "required": true, "schema": { "type": "string" } }, "volume_onboarding_id": { "description": "Indicates volume onboarding operation id", "in": "path", "name": "volume_onboarding_id", "required": true, "schema": { "type": "string" } }, "volume_snapshot_uuid": { "description": "The volume snapshot UUID", "in": "path", "name": "volume_snapshot_uuid", "required": true, "schema": { "type": "string" } }, "volumes_clone_filter": { "description": "volumes-clone filter to limit list items:\n prepare - includes status values (preparing, prepared)\n start - includes status values (starting, available)\n execute - includes status values (executing, available-rollback)\n cancel - includes status values (cancelling)\n completed - includes status values (completed)\n failed - includes status values (failed)\n cancelled - includes status values (cancelled)\n finalized - included status values (completed, failed, cancelled)\n", "in": "query", "name": "filter", "schema": { "type": "string", "enum": [ "prepare", "start", "execute", "cancel", "completed", "failed", "cancelled", "finalized" ] } }, "volumes_clone_id": { "description": "Volumes Clone ID", "in": "path", "name": "volumes_clone_id", "required": true, "schema": { "type": "string" } }, "vpn_connection_id": { "description": "ID of a VPN connection", "in": "path", "name": "vpn_connection_id", "required": true, "schema": { "type": "string" } }, "workspace_id": { "description": "Workspace ID", "in": "path", "name": "workspace_id", "required": true, "schema": { "type": "string" } } }, "securitySchemes": { "OauthSecurity": { "type": "oauth2", "x-google-audiences": "903592228867-h2v4860vq0lvids6bvqvr4ssjsobqeok.apps.googleusercontent.com", "x-google-issuer": "https://accounts.google.com", "flows": { "implicit": { "authorizationUrl": "/auth/v1/login", "scopes": {} } } } }, "schemas": { "AccessConfig": { "description": "(deprecated - replaced by network peer id)\nNetwork communication configuration (for satellite locations only)\n * `internal-only` - network is only used for internal host communication\n * `outbound-only` - network will be capable of egress traffic\n * `bidirectional-static-route` - network will be capable of ingress and egress traffic via static routes\n * `bidirectional-bgp` - network will be capable of ingress and egress traffic via bgp configuration\n * `bidirectional-l2out` - network will be capable of ingress and egress traffic via l2out ACI configuration\n", "enum": [ "internal-only", "outbound-only", "bidirectional-static-route", "bidirectional-bgp", "bidirectional-l2out" ], "type": "string", "x-deprecated": true }, "AddHost": { "description": "Host to add to a host group", "properties": { "displayName": { "description": "Name of the host chosen by the user", "type": "string" }, "sysType": { "description": "System type", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "sysType", "displayName" ], "type": "object" }, "AddServerVirtualSerialNumber": { "properties": { "description": { "description": "Description of the Virtual Serial Number", "type": "string" }, "serial": { "description": "Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.", "type": "string" } }, "required": [ "serial" ] }, "AuxiliaryVolumeForOnboarding": { "properties": { "auxVolumeName": { "description": "auxiliary volume name at storage host level", "type": "string" }, "name": { "description": "display name of auxVolumeName once onboarded,auxVolumeName will be set to display name if not provided.", "maxLength": 120, "pattern": "^[\\s]*[A-Za-z0-9:_.\\-][A-Za-z0-9\\s:_.\\-]*$", "type": "string" } }, "required": [ "auxVolumeName" ], "type": "object" }, "AuxiliaryVolumesForOnboarding": { "properties": { "auxiliaryVolumes": { "items": { "allOf": [ { "$ref": "#/components/schemas/AuxiliaryVolumeForOnboarding" }, { "type": "object" } ] }, "type": "array" }, "sourceCRN": { "description": "CRN of source ServiceBroker instance from where auxiliary volumes need to be onboarded", "type": "string" } }, "required": [ "sourceCRN", "auxiliaryVolumes" ], "type": "object" }, "AvailableHost": { "description": "Reservable host description", "properties": { "capacity": { "allOf": [ { "$ref": "#/components/schemas/AvailableHostCapacity" }, { "description": "Resource capacities for that system type and configuration", "type": "object" } ] }, "count": { "description": "How many hosts of such type/capacities are available", "type": "integer" }, "sysType": { "description": "System type", "type": "string" } }, "type": "object" }, "AvailableHostCapacity": { "properties": { "cores": { "allOf": [ { "$ref": "#/components/schemas/AvailableHostResourceCapacity" }, { "description": "Core capacity of the host", "type": "object" } ] }, "memory": { "allOf": [ { "$ref": "#/components/schemas/AvailableHostResourceCapacity" }, { "description": "Memory capacity of the host (in GB)", "type": "object" } ] } }, "type": "object" }, "AvailableHostList": { "additionalProperties": { "$ref": "#/components/schemas/AvailableHost" }, "type": "object" }, "AvailableHostResourceCapacity": { "properties": { "total": { "type": "number" } }, "required": [ "total" ], "type": "object" }, "AvailableStockImages": { "additionalProperties": { "$ref": "#/components/schemas/StockImages" }, "description": "A map of an array of stock images for each available storage type", "type": "object" }, "CRN": { "description": "The CRN for this resource", "type": "string" }, "CapabilitiesDetails": { "properties": { "disasterRecovery": { "allOf": [ { "$ref": "#/components/schemas/DisasterRecovery" }, { "description": "Disaster Recovery Information", "type": "object" } ] }, "supportedSystems": { "allOf": [ { "$ref": "#/components/schemas/SupportedSystems" }, { "description": "Datacenter System Types Information", "type": "object" } ] } }, "required": [ "supportedSystems", "disasterRecovery" ], "type": "object" }, "CloneTaskReference": { "properties": { "cloneTaskID": { "description": "ID of a long running PowerVC clone task", "type": "string" }, "href": { "description": "Link to PowerVC clone task resource", "type": "string" } }, "required": [ "cloneTaskID", "href" ], "type": "object" }, "CloneTaskStatus": { "properties": { "clonedVolumes": { "description": "List of cloned volumes created from the clone volumes task", "items": { "$ref": "#/components/schemas/ClonedVolume" }, "type": "array" }, "failedReason": { "description": "The reason the clone volumes task has failed", "type": "string", "x-omitempty": true }, "percentComplete": { "description": "Snapshot completion percentage", "type": "integer" }, "status": { "description": "Status of the clone volumes task", "enum": [ "running", "completed", "failed", "unknown" ], "type": "string" } }, "required": [ "status", "percentComplete" ], "type": "object" }, "ClonedVolume": { "properties": { "clonedVolumeID": { "description": "ID of the new cloned volume", "type": "string" }, "sourceVolumeID": { "description": "ID of the source volume to be cloned", "type": "string" } }, "type": "object" }, "ClonedVolumeDetail": { "properties": { "clone": { "allOf": [ { "$ref": "#/components/schemas/VolumeInfo" }, { "type": "object" } ] }, "source": { "allOf": [ { "$ref": "#/components/schemas/VolumeInfo" }, { "type": "object" } ] } }, "required": [ "source", "clone" ], "type": "object" }, "CloudConnection": { "properties": { "classic": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionEndpointClassic" }, { "type": "object" } ] }, "cloudConnectionID": { "description": "cloud connection ID", "type": "string" }, "connectionMode": { "description": "type of service the gateway is attached to", "type": "string" }, "creationDate": { "description": "creation date", "format": "date-time", "type": "string" }, "globalRouting": { "description": "enable global routing for this cloud connection (default=false)", "type": "boolean" }, "ibmIPAddress": { "description": "IBM IP address", "type": "string" }, "linkStatus": { "description": "link status", "type": "string" }, "metered": { "description": "metered", "type": "boolean" }, "name": { "description": "name of the cloud connection", "type": "string" }, "networks": { "description": "Network References", "items": { "$ref": "#/components/schemas/NetworkReference" }, "type": "array", "x-omitempty": true }, "port": { "description": "port", "type": "string" }, "speed": { "description": "speed of the cloud connection (speed in megabits per second)", "type": "integer" }, "userIPAddress": { "description": "user IP address", "type": "string" }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionEndpointVPC" }, { "type": "object" } ] } }, "required": [ "cloudConnectionID", "name", "speed", "globalRouting", "creationDate", "userIPAddress", "ibmIPAddress", "port", "linkStatus", "metered" ], "type": "object" }, "CloudConnectionCreate": { "properties": { "classic": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionEndpointClassicUpdate" }, { "type": "object" } ] }, "globalRouting": { "description": "enable global routing for this cloud connection (default=false)", "type": "boolean" }, "metered": { "description": "enable metered for this cloud connection (default=false)", "type": "boolean" }, "name": { "description": "name of the cloud connection", "type": "string" }, "speed": { "description": "speed of the cloud connection (speed in megabits per second)", "enum": [ 50, 100, 200, 500, 1000, 2000, 5000, 10000 ], "type": "integer" }, "subnets": { "description": "list of subnets to attach to cloud connection", "items": { "type": "string" }, "type": "array" }, "transitEnabled": { "description": "enable transit gateway for this cloud connection (default=false)", "type": "boolean" }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionEndpointVPC" }, { "type": "object" } ] } }, "required": [ "name", "speed" ], "type": "object" }, "CloudConnectionCreateResponse": { "allOf": [ { "$ref": "#/components/schemas/CloudConnection" } ], "properties": { "jobRef": { "$ref": "#/components/schemas/JobReference" } } }, "CloudConnectionEndpointClassic": { "properties": { "enabled": { "description": "enable classic endpoint destination (default=false)", "type": "boolean", "x-omitempty": false }, "gre": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionGRETunnel" }, { "x-omitempty": true } ] } }, "type": "object" }, "CloudConnectionEndpointClassicUpdate": { "properties": { "enabled": { "description": "enable classic endpoint destination (default=false)", "type": "boolean", "x-omitempty": false }, "gre": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionGRETunnelCreate" }, { "x-omitempty": true } ] } }, "type": "object" }, "CloudConnectionEndpointVPC": { "properties": { "enabled": { "description": "enable vpc for this cloud connection (default=false)", "type": "boolean", "x-omitempty": false }, "vpcs": { "description": "vpc connections", "items": { "$ref": "#/components/schemas/CloudConnectionVPC" }, "type": "array", "x-omitempty": true } }, "type": "object" }, "CloudConnectionGRETunnel": { "properties": { "destIPAddress": { "description": "gre destination IP address", "type": "string" }, "sourceIPAddress": { "description": "gre auto-assigned source IP address", "type": "string" } }, "required": [ "destIPAddress", "sourceIPAddress" ], "type": "object" }, "CloudConnectionGRETunnelCreate": { "properties": { "cidr": { "description": "gre network in CIDR notation (192.168.0.0/24)", "type": "string" }, "destIPAddress": { "description": "gre destination IP address", "type": "string" } }, "required": [ "destIPAddress", "cidr" ], "type": "object" }, "CloudConnectionUpdate": { "properties": { "classic": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionEndpointClassicUpdate" }, { "type": "object" } ] }, "globalRouting": { "description": "enable global routing for this cloud connection (default=false)", "type": "boolean", "x-isnullable": true }, "metered": { "description": "enable metered for this cloud connection (default=false)", "type": "boolean", "x-isnullable": true }, "name": { "description": "name of the cloud connection", "type": "string", "x-isnullable": true }, "speed": { "description": "speed of the cloud connection (speed in megabits per second)", "enum": [ 50, 100, 200, 500, 1000, 2000, 5000, 10000 ], "type": "integer", "x-isnullable": true }, "vpc": { "allOf": [ { "$ref": "#/components/schemas/CloudConnectionEndpointVPC" }, { "type": "object" } ] } }, "type": "object" }, "CloudConnectionVPC": { "properties": { "name": { "description": "vpc name", "type": "string" }, "vpcID": { "description": "vpc id", "type": "string" } }, "required": [ "vpcID" ], "type": "object" }, "CloudConnectionVirtualPrivateClouds": { "properties": { "virtualPrivateClouds": { "description": "list of available virtual private clouds", "items": { "properties": { "classicAccess": { "description": "indicates if vpc uses classic architecture", "type": "boolean" }, "name": { "description": "name for the vpc", "type": "string" }, "status": { "description": "status of this vpc", "type": "string" }, "vpcID": { "description": "virtual private cloud id", "type": "string" } }, "required": [ "classicAccess", "vpcID", "name", "status" ], "type": "object", "x-go-name": "CloudConnectionVirtualPrivateCloud" }, "type": "array" } }, "required": [ "virtualPrivateClouds" ], "type": "object" }, "CloudConnections": { "properties": { "cloudConnections": { "description": "Cloud Connections", "items": { "$ref": "#/components/schemas/CloudConnection" }, "type": "array" } }, "required": [ "cloudConnections" ], "type": "object" }, "CloudInstance": { "properties": { "capabilities": { "description": "Cloud Instance Capabilities", "items": { "description": "Capability for this Cloud Instance", "type": "string" }, "type": "array" }, "cloudInstanceID": { "description": "Cloud Instance ID", "type": "string" }, "enabled": { "description": "Indicates if the cloud instance is enabled", "type": "boolean" }, "initialized": { "description": "Indicates if the cloud instance is initialized and ready for use", "type": "boolean" }, "limits": { "allOf": [ { "$ref": "#/components/schemas/CloudInstanceUsageLimits" }, { "description": "Limits on the cloud instance" } ] }, "name": { "description": "Cloud Instance Name", "type": "string" }, "openstackID": { "description": "The open stack ID that controls this cloud instance", "type": "string" }, "pvmInstances": { "description": "PVM instances owned by the Cloud Instance", "items": { "$ref": "#/components/schemas/PVMInstanceReference" }, "type": "array" }, "region": { "description": "The region the cloud instance lives", "type": "string" }, "tenantID": { "description": "The tenant ID that owns this cloud instance", "type": "string" }, "usage": { "allOf": [ { "$ref": "#/components/schemas/CloudInstanceUsageLimits" }, { "description": "Current usage on the cloud instance" } ] } }, "required": [ "cloudInstanceID", "name", "tenantID", "openstackID", "region", "enabled", "initialized", "limits", "usage", "pvmInstances" ], "type": "object" }, "CloudInstanceReference": { "properties": { "capabilities": { "description": "Cloud Instance Capabilities", "items": { "description": "Capability for this Cloud Instance", "type": "string" }, "type": "array" }, "cloudInstanceID": { "description": "Cloud Instance ID", "type": "string" }, "enabled": { "description": "Indicates if the cloud instance is enabled", "type": "boolean" }, "href": { "description": "Link to Cloud Instance resource", "type": "string" }, "initialized": { "description": "Indicates if the cloud instance is initialized and ready for use", "type": "boolean" }, "limits": { "allOf": [ { "$ref": "#/components/schemas/CloudInstanceUsageLimits" }, { "description": "Limits on the cloud instance" } ] }, "name": { "description": "Cloud Instance Name", "type": "string" }, "region": { "description": "The region the cloud instance lives", "type": "string" } }, "required": [ "cloudInstanceID", "name", "region", "enabled", "initialized", "limits", "href" ], "type": "object" }, "CloudInstanceUsageLimits": { "properties": { "instanceMemory": { "description": "Maximum memory (in GB) per PVMInstance", "type": "number", "x-isnullable": true, "x-omitempty": true }, "instanceProcUnits": { "description": "Maximum proc units per PVMInstance", "type": "number", "x-isnullable": true, "x-omitempty": true }, "instances": { "description": "Number of power instances allowed", "type": "number" }, "memory": { "description": "Amount of memory allowed", "type": "number" }, "peeringBandwidth": { "description": "Maximum network bandwidth to GCP Mbps", "type": "integer", "x-isnullable": true, "x-omitempty": true }, "peeringNetworks": { "description": "Amount of peering networks allowed", "type": "integer", "x-isnullable": true, "x-omitempty": true }, "procUnits": { "description": "Number of processor units allowed", "type": "number" }, "processors": { "description": "Number of processors allowed", "type": "number" }, "storage": { "description": "Amount of storage allowed (TB)", "type": "number" }, "storageSSD": { "description": "Amount of SSD storage allowed (TB)", "type": "number", "x-isnullable": true, "x-omitempty": true }, "storageStandard": { "description": "Amount of standard (HDD) storage allowed (TB)", "type": "number", "x-isnullable": true, "x-omitempty": true } }, "required": [ "processors", "procUnits", "memory", "instances", "storage" ], "type": "object" }, "ConsoleLanguage": { "properties": { "code": { "description": "language code", "type": "string" }, "language": { "description": "language description", "type": "string" } }, "required": [ "code" ], "type": "object" }, "ConsoleLanguages": { "properties": { "consoleLanguages": { "description": "console languages", "items": { "$ref": "#/components/schemas/ConsoleLanguage" }, "type": "array" } }, "required": [ "consoleLanguages" ], "type": "object" }, "CreateCosImageImportJob": { "properties": { "accessKey": { "description": "Cloud Object Storage access key; required for buckets with private access", "type": "string" }, "bucketAccess": { "default": "private", "description": "indicates if the bucket has public or private access public access require no authentication keys private access requires hmac authentication keys (access,secret)", "enum": [ "public", "private" ], "type": "string" }, "bucketName": { "description": "Cloud Object Storage bucket name; bucket-name[/optional/folder]", "type": "string" }, "imageFilename": { "description": "Cloud Object Storage image filename", "type": "string" }, "imageName": { "description": "Name for the image that will be loaded into the boot image catalog", "type": "string" }, "importDetails": { "allOf": [ { "$ref": "#/components/schemas/ImageImportDetails" }, { "description": "Import details for SAP images" } ] }, "osType": { "description": "Image OS Type, required if importing a raw image; raw images can only be imported using the command line interface", "enum": [ "aix", "ibmi", "rhel", "sles" ], "type": "string" }, "region": { "description": "Cloud Object Storage region", "type": "string" }, "secretKey": { "description": "Cloud Object Storage secret key; required for buckets with private access", "type": "string" }, "storageAffinity": { "allOf": [ { "$ref": "#/components/schemas/StorageAffinity" }, { "description": "Storage affinity data used for storage pool selection" } ] }, "storagePool": { "description": "Storage pool where the image will be loaded, if provided then storageAffinity will be ignored", "type": "string" }, "storageType": { "description": "Type of storage; If only using storageType for storage selection then the storage pool with the most available space will be selected if storageType is not provided the storage type will default to 'tier3'.", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "imageName", "region", "imageFilename", "bucketName" ], "type": "object" }, "CreateDataVolume": { "properties": { "affinityPVMInstance": { "description": "PVM Instance (ID or Name) to base volume affinity policy against; required if requesting affinity and affinityVolume is not provided", "type": "string", "x-isnullable": true }, "affinityPolicy": { "description": "Affinity policy for data volume being created; ignored if volumePool provided; for policy 'affinity' requires one of affinityPVMInstance or affinityVolume to be specified; for policy 'anti-affinity' requires one of antiAffinityPVMInstances or antiAffinityVolumes to be specified", "enum": [ "affinity", "anti-affinity" ], "type": "string", "x-isnullable": true }, "affinityVolume": { "description": "Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and affinityPVMInstance is not provided", "type": "string", "x-isnullable": true }, "antiAffinityPVMInstances": { "description": "List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityVolumes is not provided", "items": { "description": "PVM Instance (ID or Name)", "type": "string" }, "type": "array" }, "antiAffinityVolumes": { "description": "List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityPVMInstances is not provided", "items": { "description": "Volume (ID or Name)", "type": "string" }, "type": "array" }, "diskType": { "description": "Type of Disk; if diskType is not provided the disk type will default to 'tier3'.", "type": "string" }, "name": { "description": "Volume Name", "type": "string" }, "replicationEnabled": { "description": "Indicates if the volume should be replication enabled or not", "type": "boolean", "x-isnullable": true }, "shareable": { "description": "Indicates if the volume is shareable between VMs", "type": "boolean", "x-isnullable": true }, "size": { "description": "Volume Size (GB)", "type": "number" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumePool": { "description": "Volume pool where the volume will be created; if provided then affinityPolicy value will be ignored", "type": "string" } }, "required": [ "name", "size" ], "type": "object" }, "CreateImage": { "properties": { "accessKey": { "description": "Cloud Storage access key; required for import image", "type": "string" }, "bucketName": { "description": "Cloud Storage bucket name; bucket-name[/optional/folder]; required for import image", "type": "string" }, "diskType": { "description": "Type of Disk; if diskType is not provided the disk type will default to 'tier3'. Used only when importing an image from cloud storage.", "type": "string" }, "imageFilename": { "description": "Cloud Storage image filename; required for import image", "type": "string" }, "imageID": { "description": "Image ID of existing source image; required for copy image", "type": "string" }, "imageName": { "description": "Name to give created image; required for import image", "type": "string" }, "imagePath": { "description": "(deprecated - replaced by region, imageFilename and bucketName) Path to image starting with service endpoint and ending with image filename", "type": "string" }, "osType": { "description": "Image OS Type, required if importing a raw image; raw images can only be imported using the command line interface", "enum": [ "aix", "ibmi", "rhel", "sles" ], "type": "string" }, "region": { "description": "Cloud Storage Region; only required to access IBM Cloud Storage", "type": "string" }, "secretKey": { "description": "Cloud Storage secret key; required for import image", "type": "string" }, "source": { "description": "Source of the image\n>*Note*: url option is deprecated, this option is supported till Oct 2022\n", "enum": [ "root-project", "url" ], "type": "string" }, "storageAffinity": { "allOf": [ { "$ref": "#/components/schemas/StorageAffinity" }, { "description": "The storage affinity data; ignored if storagePool is provided; Used only when importing an image from cloud storage." } ] }, "storagePool": { "description": "Storage pool where the image will be loaded; if provided then storageAffinity will be ignored; Used only when importing an image from cloud storage.", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "source" ], "type": "object" }, "CreateServerVirtualSerialNumber": { "properties": { "description": { "description": "Description of the Virtual Serial Number", "type": "string" }, "serial": { "description": "Provide an existing reserved Virtual Serial Number or specify 'auto-assign' for auto generated Virtual Serial Number.", "type": "string" } }, "required": [ "serial" ] }, "Datacenter": { "properties": { "capabilities": { "additionalProperties": { "type": "boolean" }, "description": "Datacenter Capabilities", "type": "object" }, "capabilitiesDetails": { "allOf": [ { "$ref": "#/components/schemas/CapabilitiesDetails" }, { "description": "Additional Datacenter Capabilities Details" } ] }, "href": { "description": "Link to Datacenter Region", "type": "string" }, "location": { "allOf": [ { "$ref": "#/components/schemas/DatacenterLocation" }, { "description": "The Datacenter location" } ] }, "status": { "description": "The Datacenter status", "enum": [ "active", "maintenance", "down" ], "type": "string" }, "type": { "description": "The Datacenter type", "enum": [ "off-premises", "on-premises" ], "type": "string" } }, "required": [ "location", "type", "status", "capabilities" ], "type": "object" }, "DatacenterLocation": { "properties": { "region": { "description": "The Datacenter location region zone", "type": "string" }, "regionDisplayName": { "description": "The Datacenter location region display name", "type": "string" }, "type": { "description": "The Datacenter location region type", "type": "string" }, "url": { "description": "The Datacenter location region url", "type": "string" } }, "required": [ "region", "url", "type", "regionDisplayName" ], "type": "object" }, "Datacenters": { "properties": { "datacenters": { "description": "Power Systems Virtual Server available Datacenters", "items": { "$ref": "#/components/schemas/Datacenter" }, "type": "array" } }, "required": [ "datacenters" ], "type": "object" }, "DeadPeerDetection": { "description": "Dead Peer Detection of the VPN Connection", "properties": { "action": { "description": "Action to take when a Peer Gateway stops responding", "enum": [ "restart" ], "type": "string" }, "interval": { "default": 10, "description": "How often to test that the Peer Gateway is responsive", "example": 10, "maximum": 60, "minimum": 2, "type": "integer" }, "threshold": { "default": 5, "description": "The number of attempts to connect before tearing down the connection", "example": 5, "maximum": 5, "minimum": 1, "type": "integer" } }, "required": [ "action", "interval", "threshold" ], "type": "object" }, "DeleteServerVirtualSerialNumber": { "properties": { "retainVSN": { "description": "Indicates if the Virtual Serial Number attached to a PVM Instance is retained or not", "type": "boolean" } } }, "DeploymentTarget": { "properties": { "id": { "description": "The uuid of the host group or host", "type": "string" }, "type": { "description": "specify if deploying to a host group or a host", "enum": [ "hostGroup", "host" ], "type": "string" } }, "required": [ "type", "id" ], "type": "object" }, "DisasterRecovery": { "properties": { "asynchronousReplication": { "allOf": [ { "$ref": "#/components/schemas/ReplicationService" }, { "description": "Asynchronous Replication Target Information", "type": "object" } ] }, "synchronousReplication": { "allOf": [ { "$ref": "#/components/schemas/ReplicationService" }, { "description": "Synchronous Replication Target Information", "type": "object" } ] } }, "required": [ "asynchronousReplication" ], "type": "object" }, "DisasterRecoveryLocation": { "properties": { "location": { "description": "regionZone of a site", "type": "string" }, "replicationSites": { "allOf": [ { "$ref": "#/components/schemas/ReplicationSites" }, { "description": "The list of replication sites has mapped for the given location" } ] } }, "type": "object" }, "DisasterRecoveryLocations": { "properties": { "disasterRecoveryLocations": { "description": "The list of Disaster Recovery Locations", "items": { "$ref": "#/components/schemas/DisasterRecoveryLocation" }, "type": "array" } }, "required": [ "disasterRecoveryLocations" ], "type": "object" }, "Error": { "properties": { "description": { "type": "string" }, "error": { "type": "string" } }, "type": "object" }, "Event": { "properties": { "action": { "description": "Type of action for this event", "type": "string" }, "eventID": { "description": "ID of the Activity", "type": "string" }, "level": { "description": "Level of the event (notice, info, warning, error)", "enum": [ "notice", "info", "warning", "error" ], "type": "string" }, "message": { "description": "The (translated) message of the event", "type": "string" }, "metadata": { "description": "Any metadata associated with the event", "type": "object" }, "resource": { "description": "Type of resource for this event", "type": "string" }, "time": { "description": "Time of activity in ISO 8601 - RFC3339", "format": "date-time", "type": "string" }, "timestamp": { "description": "Time of activity in unix epoch", "type": "integer" }, "user": { "$ref": "#/components/schemas/EventUser" } }, "required": [ "eventID", "time", "timestamp", "level", "resource", "action", "message" ], "type": "object" }, "EventUser": { "properties": { "email": { "description": "Email of the User", "type": "string" }, "name": { "description": "Name of the User", "type": "string" }, "userID": { "description": "ID of user who created/caused the event", "type": "string" } }, "required": [ "userID" ], "type": "object" }, "Events": { "properties": { "events": { "description": "Events", "items": { "$ref": "#/components/schemas/Event" }, "type": "array" } }, "required": [ "events" ], "type": "object" }, "ExportImage": { "properties": { "accessKey": { "description": "Cloud Object Storage Access key", "type": "string" }, "bucketName": { "description": "Cloud Object Storage Bucket name", "type": "string" }, "region": { "description": "Cloud Object Storage Region; required for IBM COS", "type": "string" }, "secretKey": { "description": "Cloud Object Storage Secret key", "type": "string" } }, "required": [ "bucketName", "accessKey" ], "type": "object" }, "FlashCopyMapping": { "properties": { "copyRate": { "description": "Indicates the rate of flash copy operation of a volume", "type": "integer" }, "flashCopyName": { "description": "Indicates flash copy name of the volume", "type": "string" }, "progress": { "description": "Indicates the progress of flash copy operation", "type": "integer" }, "sourceVolumeName": { "description": "Indicates name of the source volume", "type": "string" }, "startTime": { "description": "Indicates the start time of flash copy operation", "format": "date-time", "type": "string" }, "status": { "description": "Copy status of a volume", "type": "string" }, "targetVolumeName": { "description": "Indicates name of the target volume", "type": "string" } }, "required": [ "flashCopyName" ], "type": "object" }, "FlashCopyMappings": { "items": { "$ref": "#/components/schemas/FlashCopyMapping" }, "type": "array" }, "GetBulkVolume": { "properties": { "volumeList": { "description": "List of volumes to be fetched", "items": { "description": "Volume (ID or Name)", "type": "string" }, "type": "array" } }, "required": [ "volumeList" ], "type": "object" }, "GetServerVirtualSerialNumber": { "properties": { "description": { "description": "Description of the Virtual Serial Number", "type": "string" }, "serial": { "description": "Virtual Serial Number", "type": "string" } }, "required": [ "serial", "description" ] }, "Host": { "description": "Host description", "properties": { "capacity": { "allOf": [ { "$ref": "#/components/schemas/HostCapacity" }, { "description": "Capacities of the host", "type": "object" } ] }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "displayName": { "description": "Name of the host (chosen by the user)", "type": "string" }, "hostGroup": { "allOf": [ { "$ref": "#/components/schemas/HostGroupSummary" }, { "description": "Information about the owning host group", "type": "object" } ] }, "id": { "description": "ID of the host", "type": "string" }, "state": { "description": "State of the host (up/down)", "type": "string" }, "status": { "description": "Status of the host (enabled/disabled)", "type": "string" }, "sysType": { "description": "System type", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "type": "object" }, "HostCapacity": { "properties": { "cores": { "allOf": [ { "$ref": "#/components/schemas/HostResourceCapacity" }, { "description": "Core capacity of the host", "type": "object" } ] }, "memory": { "allOf": [ { "$ref": "#/components/schemas/HostResourceCapacity" }, { "description": "Memory capacity of the host (in GB)", "type": "object" } ] } }, "type": "object" }, "HostCreate": { "description": "Parameters to add a host to an existing host group", "properties": { "hostGroupID": { "description": "ID of the host group to which the host should be added", "type": "string" }, "hosts": { "description": "Hosts to be added", "items": { "$ref": "#/components/schemas/AddHost" }, "type": "array" } }, "required": [ "hostGroupID", "hosts" ], "type": "object" }, "HostGroup": { "description": "Description of a host group", "properties": { "creationDate": { "description": "Date/Time of host group creation", "format": "date-time", "type": "string" }, "hosts": { "description": "List of hosts", "items": { "$ref": "#/components/schemas/HostHref" }, "type": "array" }, "id": { "description": "Host group ID", "type": "string" }, "name": { "description": "Name of the host group", "type": "string" }, "primary": { "description": "ID of the workspace owning the host group", "type": "string" }, "secondaries": { "description": "IDs of workspaces the host group has been shared with", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "HostGroupCreate": { "description": "Parameters for the creation of a new host group", "properties": { "hosts": { "description": "List of hosts to add to the host group", "items": { "$ref": "#/components/schemas/AddHost" }, "type": "array" }, "name": { "description": "Name of the host group to create", "type": "string" }, "secondaries": { "description": "List of workspaces to share the host group with (optional)", "items": { "$ref": "#/components/schemas/Secondary" }, "type": "array" } }, "required": [ "name", "hosts" ], "type": "object" }, "HostGroupList": { "items": { "$ref": "#/components/schemas/HostGroup" }, "type": "array" }, "HostGroupShareOp": { "description": "Operation updating the sharing status (mutually exclusive)", "properties": { "add": { "description": "List of workspaces to share the host group with", "items": { "$ref": "#/components/schemas/Secondary" }, "type": "array" }, "remove": { "description": "A workspace ID to stop sharing the host group with", "type": "string" } }, "type": "object" }, "HostGroupSummary": { "properties": { "access": { "description": "Whether the host group is a primary or secondary host group", "type": "string" }, "href": { "description": "Link to the host group resource", "type": "string" }, "name": { "description": "Name of the host group", "type": "string" } }, "type": "object" }, "HostHref": { "description": "Link to host resource", "type": "string" }, "HostList": { "items": { "$ref": "#/components/schemas/Host" }, "type": "array" }, "HostPut": { "description": "Parameters to modify a host", "properties": { "displayName": { "description": "Name of the host chosen by the user", "type": "string" } }, "required": [ "displayName" ], "type": "object" }, "HostResourceCapacity": { "properties": { "available": { "type": "number" }, "reserved": { "type": "number" }, "total": { "type": "number" }, "used": { "type": "number" } }, "required": [ "total", "reserved", "used", "available" ], "type": "object" }, "IKEPolicies": { "properties": { "ikePolicies": { "description": "IKE Policies array", "items": { "$ref": "#/components/schemas/IKEPolicy" }, "type": "array" } }, "required": [ "ikePolicies" ], "type": "object" }, "IKEPolicy": { "description": "IKE Policy object", "properties": { "authentication": { "$ref": "#/components/schemas/IKEPolicyAuthentication" }, "dhGroup": { "description": "DH group of the IKE Policy", "enum": [ 1, 2, 5, 14, 19, 20, 24 ], "example": 2, "type": "integer" }, "encryption": { "description": "encryption of the IKE Policy", "enum": [ "aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-128-gcm", "3des-cbc" ], "example": "aes-256-cbc", "type": "string" }, "id": { "description": "unique identifier of the IKE Policy object", "example": "7edc8988-eb18-4b5c-a594-0d73d8254463", "type": "string" }, "keyLifetime": { "$ref": "#/components/schemas/KeyLifetime" }, "name": { "description": "name of the IKE Policy", "example": "ikePolicy1", "type": "string" }, "version": { "description": "version of the IKE Policy", "enum": [ 1, 2 ], "example": 2, "type": "integer" } }, "required": [ "authentication", "dhGroup", "encryption", "id", "keyLifetime", "name", "version" ], "type": "object" }, "IKEPolicyAuthentication": { "description": "authentication of the IKE policy", "enum": [ "sha-256", "sha-384", "sha1", "none" ], "example": "sha-256", "type": "string" }, "IKEPolicyCreate": { "description": "IKE Policy object used for creation", "properties": { "authentication": { "$ref": "#/components/schemas/IKEPolicyAuthentication" }, "dhGroup": { "description": "DH group of the IKE Policy", "enum": [ 1, 2, 5, 14, 19, 20, 24 ], "example": 2, "type": "integer" }, "encryption": { "description": "encryption of the IKE Policy", "enum": [ "aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-128-gcm", "3des-cbc" ], "example": "aes-256-cbc", "type": "string" }, "keyLifetime": { "$ref": "#/components/schemas/KeyLifetime" }, "name": { "description": "name of the IKE Policy", "example": "ikePolicy1", "maxLength": 47, "minLength": 1, "type": "string" }, "presharedKey": { "description": "Preshared key used in this IKE Policy (length of preshared key must be even)", "type": "string" }, "version": { "description": "version of the IKE Policy", "enum": [ 1, 2 ], "example": 2, "type": "integer" } }, "required": [ "dhGroup", "encryption", "keyLifetime", "name", "presharedKey", "version" ], "type": "object" }, "IKEPolicyRef": { "description": "IKE Policy reference object", "properties": { "id": { "description": "unique identifier of IKE Policy", "example": "6edc8988-ab18-4b5c-b123-0d73e8254463", "type": "string" }, "name": { "description": "name of IKE Policy", "example": "IKE Policy 1", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "IKEPolicyUpdate": { "additionalProperties": true, "description": "IKE Policy object used for update", "minProperties": 1, "properties": { "authentication": { "$ref": "#/components/schemas/IKEPolicyAuthentication" }, "dhGroup": { "description": "DH group of the IKE Policy", "enum": [ 1, 2, 5, 14, 19, 20, 24 ], "example": 2, "type": "integer" }, "encryption": { "description": "encryption of the IKE Policy", "enum": [ "aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-128-gcm", "3des-cbc" ], "example": "aes-256-cbc", "type": "string" }, "keyLifetime": { "$ref": "#/components/schemas/KeyLifetime" }, "name": { "description": "name of the IKE Policy", "example": "ikePolicy1", "maxLength": 47, "minLength": 1, "type": "string" }, "presharedKey": { "description": "Preshared key used in this IKE Policy (length of preshared key must be even)", "type": "string" }, "version": { "description": "version of the IKE Policy", "enum": [ 1, 2 ], "example": 2, "type": "integer" } }, "type": "object" }, "IPAddressRange": { "properties": { "endingIPAddress": { "description": "Ending IP Address", "type": "string" }, "startingIPAddress": { "description": "Starting IP Address", "type": "string" } }, "required": [ "startingIPAddress", "endingIPAddress" ], "type": "object" }, "IPSECPolicyAuthentication": { "description": "authentication for IPSec policy", "enum": [ "hmac-sha-256-128", "hmac-sha1-96", "none" ], "example": "hmac-sha-256-128", "type": "string" }, "IPSecPolicies": { "properties": { "ipSecPolicies": { "description": "IPSec Policies array", "items": { "$ref": "#/components/schemas/IPSecPolicy" }, "type": "array" } }, "required": [ "ipSecPolicies" ], "type": "object" }, "IPSecPolicy": { "description": "IPSec Policy object", "properties": { "authentication": { "$ref": "#/components/schemas/IPSECPolicyAuthentication" }, "dhGroup": { "description": "Diffie-Hellman group", "enum": [ 1, 2, 5, 14, 19, 20, 24 ], "example": 2, "type": "integer" }, "encryption": { "description": "connection encryption policy", "enum": [ "aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-192-gcm", "aes-128-gcm", "3des-cbc" ], "example": "aes-256-cbc", "type": "string" }, "id": { "description": "unique identifier of the IPSec Policy", "example": "6edc8988-eb18-4b5c-a594-0d73d8254463", "type": "string" }, "keyLifetime": { "$ref": "#/components/schemas/KeyLifetime" }, "name": { "description": "IPSec Policy name", "example": "ipSecPolicy2", "type": "string" }, "pfs": { "description": "Perfect Forward Secrecy", "example": true, "type": "boolean" } }, "required": [ "authentication", "dhGroup", "encryption", "id", "keyLifetime", "name", "pfs" ], "type": "object" }, "IPSecPolicyCreate": { "description": "IPSec Policy object used for creation", "properties": { "authentication": { "$ref": "#/components/schemas/IPSECPolicyAuthentication" }, "dhGroup": { "description": "Diffie-Hellman group", "enum": [ 1, 2, 5, 14, 19, 20, 24 ], "example": 2, "type": "integer" }, "encryption": { "description": "connection encryption policy", "enum": [ "aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-192-gcm", "aes-128-gcm", "3des-cbc" ], "example": "aes-256-cbc", "type": "string" }, "keyLifetime": { "$ref": "#/components/schemas/KeyLifetime" }, "name": { "description": "IPSec Policy name", "example": "ipSecPolicy2", "maxLength": 47, "minLength": 1, "type": "string" }, "pfs": { "description": "Perfect Forward Secrecy", "example": true, "type": "boolean" } }, "required": [ "encryption", "dhGroup", "name", "pfs", "keyLifetime" ], "type": "object" }, "IPSecPolicyRef": { "description": "IPSec Policy reference object", "properties": { "id": { "description": "unique identifier of IPSec Policy", "example": "7abc1234-ab18-4b5c-b123-0d73e8254463", "type": "string" }, "name": { "description": "name of IPSec Policy", "example": "IPSec Policy 1", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "IPSecPolicyUpdate": { "additionalProperties": true, "description": "IPSEc Policy object used for update", "minProperties": 1, "properties": { "authentication": { "$ref": "#/components/schemas/IPSECPolicyAuthentication" }, "dhGroup": { "description": "Diffie-Hellman group", "enum": [ 1, 2, 5, 14, 19, 20, 24 ], "example": 2, "type": "integer" }, "encryption": { "description": "connection encryption policy", "enum": [ "aes-256-cbc", "aes-192-cbc", "aes-128-cbc", "aes-256-gcm", "aes-192-gcm", "aes-128-gcm", "3des-cbc" ], "example": "aes-256-cbc", "type": "string" }, "keyLifetime": { "$ref": "#/components/schemas/KeyLifetime" }, "name": { "description": "IPSec Policy name", "example": "ipSecPolicy2", "maxLength": 47, "minLength": 1, "type": "string" }, "pfs": { "description": "Perfect Forward Secrecy", "example": true, "type": "boolean", "x-isnullable": true } }, "type": "object" }, "Image": { "properties": { "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "description": { "description": "Description", "type": "string" }, "imageID": { "description": "Image ID", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "maxImageVolumeSize": { "description": "Maximum image volume size for multi-volume image", "type": "number" }, "name": { "description": "Image Name", "type": "string" }, "servers": { "description": "List of Servers that have deployed the image", "items": { "description": "Server name", "type": "string" }, "type": "array" }, "size": { "description": "Image Size", "type": "number" }, "specifications": { "allOf": [ { "$ref": "#/components/schemas/ImageSpecifications" }, { "type": "object" } ] }, "state": { "description": "Image State", "type": "string" }, "storagePool": { "description": "Storage pool where the image resides", "type": "string" }, "storageType": { "description": "Storage type for image", "type": "string" }, "taskref": { "allOf": [ { "$ref": "#/components/schemas/TaskReference" }, { "type": "object", "x-omitempty": true } ] }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumes": { "description": "Image Volumes", "items": { "$ref": "#/components/schemas/ImageVolume" }, "type": "array" } }, "required": [ "imageID", "name", "size", "storageType", "storagePool", "creationDate", "lastUpdateDate", "maxImageVolumeSize" ], "type": "object" }, "ImageImportDetails": { "properties": { "licenseType": { "description": "Origin of the license of the product", "enum": [ "byol" ], "type": "string" }, "product": { "description": "Product within the image", "enum": [ "Hana", "Netweaver" ], "type": "string" }, "vendor": { "description": "Vendor supporting the product", "enum": [ "SAP" ], "type": "string" } }, "required": [ "licenseType", "product", "vendor" ], "type": "object" }, "ImageReference": { "properties": { "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "description": { "description": "Description", "type": "string" }, "href": { "description": "Link to Image resource", "type": "string" }, "imageID": { "description": "Image ID", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "name": { "description": "Image Name", "type": "string" }, "specifications": { "allOf": [ { "$ref": "#/components/schemas/ImageSpecifications" }, { "type": "object" } ] }, "state": { "description": "Image State", "type": "string" }, "storagePool": { "description": "Storage pool where image resides", "type": "string" }, "storageType": { "description": "Storage type for image", "type": "string" } }, "required": [ "imageID", "name", "state", "description", "storageType", "storagePool", "creationDate", "lastUpdateDate", "specifications", "href" ], "type": "object" }, "ImageSpecifications": { "properties": { "architecture": { "description": "Architecture", "type": "string" }, "containerFormat": { "description": "Container Format", "type": "string" }, "diskFormat": { "description": "Disk Format", "type": "string" }, "endianness": { "description": "Endianness", "type": "string" }, "hypervisorType": { "description": "Hypervisor Type", "type": "string" }, "imageType": { "description": "Image Type", "type": "string" }, "operatingSystem": { "description": "Operating System", "type": "string" } }, "type": "object" }, "ImageVolume": { "properties": { "bootable": { "description": "Indicates if the volume is boot capable", "type": "boolean" }, "name": { "description": "Volume Name", "type": "string" }, "size": { "description": "Volume Size", "type": "number" }, "volumeID": { "description": "Volume ID", "type": "string" } }, "required": [ "volumeID", "name", "size", "bootable" ], "type": "object" }, "Images": { "properties": { "images": { "description": "Images", "items": { "$ref": "#/components/schemas/ImageReference" }, "type": "array" } }, "required": [ "images" ], "type": "object" }, "Job": { "properties": { "createTimestamp": { "description": "create timestamp for the job", "format": "date-time", "type": "string" }, "id": { "description": "id of a job", "type": "string" }, "operation": { "allOf": [ { "$ref": "#/components/schemas/Operation" }, { "type": "object" } ] }, "status": { "allOf": [ { "$ref": "#/components/schemas/Status" }, { "type": "object" } ] } }, "required": [ "id", "operation", "status" ], "type": "object" }, "JobReference": { "properties": { "href": { "description": "Link to job resource", "type": "string" }, "id": { "description": "id of a job used to get status of long running operation", "type": "string" } }, "required": [ "id", "href" ], "type": "object" }, "Jobs": { "properties": { "jobs": { "description": "Jobs", "items": { "$ref": "#/components/schemas/Job" }, "type": "array" } }, "required": [ "jobs" ], "type": "object" }, "KeyLifetime": { "description": "Policy key lifetime", "example": 28800, "maximum": 86400, "minimum": 180, "type": "integer" }, "MaximumStorageAllocation": { "description": "Maximum storage allocation", "properties": { "maxAllocationSize": { "description": "Maximum allocation storage size (GB)", "type": "integer" }, "storagePool": { "description": "Storage pool", "type": "string" }, "storageType": { "description": "Storage type", "type": "string" } }, "required": [ "maxAllocationSize", "storageType", "storagePool" ], "type": "object" }, "MinMaxDefault": { "properties": { "default": { "description": "default value", "type": "number" }, "max": { "description": "max value", "type": "number" }, "min": { "description": "min value", "type": "number" } }, "required": [ "min", "max", "default" ], "type": "object" }, "MultiVolumesCreate": { "properties": { "affinityPVMInstance": { "description": "PVM Instance (ID or Name)to base volume affinity policy against; required if requesting affinity and affinityVolume is not provided", "type": "string", "x-isnullable": true }, "affinityPolicy": { "description": "Affinity policy for data volume being created; ignored if volumePool provided; for policy 'affinity' requires one of affinityPVMInstance or affinityVolume to be specified; for policy 'anti-affinity' requires one of antiAffinityPVMInstances or antiAffinityVolumes to be specified", "enum": [ "affinity", "anti-affinity" ], "type": "string", "x-isnullable": true }, "affinityVolume": { "description": "Volume (ID or Name) to base volume affinity policy against; required if requesting affinity and affinityPVMInstance is not provided", "type": "string", "x-isnullable": true }, "antiAffinityPVMInstances": { "description": "List of pvmInstances to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityVolumes is not provided", "items": { "description": "PVM Instance (ID or Name)", "type": "string" }, "type": "array" }, "antiAffinityVolumes": { "description": "List of volumes to base volume anti-affinity policy against; required if requesting anti-affinity and antiAffinityPVMInstances is not provided", "items": { "description": "Volume (ID or Name)", "type": "string" }, "type": "array" }, "count": { "description": "Number of volumes to create", "type": "integer" }, "diskType": { "description": "Type of Disk; if diskType is not provided the disk type will default to 'tier3'.", "type": "string" }, "name": { "description": "Base name of the volume(s)", "type": "string" }, "replicationEnabled": { "description": "Indicates if the volume should be replication enabled or not", "type": "boolean", "x-isnullable": true }, "shareable": { "description": "Indicates if the volume is shareable between VMs", "type": "boolean", "x-isnullable": true }, "size": { "description": "Volume Size (GB)", "type": "integer" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumePool": { "description": "Volume pool where the volume will be created; if provided then affinityPolicy value will be ignored", "type": "string" } }, "required": [ "name", "size" ], "type": "object" }, "Network": { "properties": { "accessConfig": { "$ref": "#/components/schemas/AccessConfig" }, "cidr": { "description": "Network in CIDR notation (192.168.0.0/24)", "type": "string" }, "cloudConnections": { "description": "(currently not available) cloud connections this network is attached", "items": { "properties": { "cloudConnectionID": { "description": "the cloud connection id", "type": "string" }, "href": { "description": "link to the cloud connection resource", "type": "string" } }, "type": "object" }, "type": "array", "x-omitempty": true }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "dhcpManaged": { "description": "DHCP Managed Network", "type": "boolean" }, "dnsServers": { "description": "DNS Servers", "items": { "type": "string" }, "type": "array" }, "gateway": { "description": "Gateway IP Address", "type": "string" }, "ipAddressMetrics": { "description": "IP Address Metrics", "properties": { "available": { "description": "Number of available IP addresses", "type": "number" }, "total": { "description": "Total number of all IP addresses in all ipAddressRanges", "type": "number" }, "used": { "description": "Number of IP addresses currently in use", "type": "number" }, "utilization": { "description": "Utilization of IP addresses in percent form (used / total) [0 - 100]", "type": "number" } }, "required": [ "available", "used", "total", "utilization" ], "type": "object" }, "ipAddressRanges": { "description": "IP Address Ranges", "items": { "$ref": "#/components/schemas/IPAddressRange" }, "type": "array" }, "jumbo": { "description": "(deprecated - replaced by mtu) Enable MTU Jumbo Network (for multi-zone locations only)", "type": "boolean" }, "mtu": { "description": "Maximum transmission unit", "maximum": 9000, "minimum": 1450, "type": "integer", "x-isnullable": true }, "name": { "description": "Network Name", "type": "string" }, "networkID": { "description": "Unique Network ID", "type": "string" }, "publicIPAddressRanges": { "description": "Public IP Address Ranges (for pub-vlan networks)", "items": { "$ref": "#/components/schemas/IPAddressRange" }, "type": "array", "x-omitempty": true }, "type": { "default": "vlan", "description": "Type of Network - 'vlan' (private network) 'pub-vlan' (public network) 'dhcp-vlan' (for satellite locations only)", "enum": [ "vlan", "pub-vlan", "dhcp-vlan" ], "type": "string" }, "vlanID": { "description": "VLAN ID", "type": "number" } }, "required": [ "networkID", "name", "type", "vlanID", "cidr", "dnsServers", "ipAddressRanges", "ipAddressMetrics" ], "type": "object" }, "NetworkAddressGroup": { "properties": { "crn": { "description": "The Network Address Group's crn", "type": "string" }, "id": { "description": "The id of the Network Address Group", "type": "string" }, "members": { "description": "The list of IP addresses in CIDR notation (for example 192.168.66.2/32) in the Network Address Group", "items": { "$ref": "#/components/schemas/NetworkAddressGroupMember" }, "type": "array" }, "name": { "description": "The name of the Network Address Group", "type": "string" }, "userTags": { "description": "The user tags associated with this resource.", "items": { "type": "string" }, "type": "array", "x-omitempty": true } }, "required": [ "id", "name", "crn" ], "type": "object" }, "NetworkAddressGroupAddMember": { "properties": { "cidr": { "description": "The member to add in CIDR format", "type": "string" } }, "required": [ "cidr" ], "type": "object" }, "NetworkAddressGroupCreate": { "properties": { "name": { "description": "The name of the Network Address Group", "type": "string" }, "userTags": { "description": "The user tags associated with this resource.", "items": { "type": "string" }, "type": "array", "x-omitempty": true } }, "required": [ "name" ], "type": "object" }, "NetworkAddressGroupMember": { "properties": { "cidr": { "description": "The IP addresses in CIDR notation for example 192.168.1.5/32", "type": "string" }, "id": { "description": "The id of the Network Address Group member IP addresses", "type": "string" } }, "required": [ "id", "cidr" ], "type": "object" }, "NetworkAddressGroupUpdate": { "properties": { "name": { "description": "Replaces the current Network Address Group Name", "type": "string" } }, "type": "object" }, "NetworkAddressGroups": { "properties": { "networkAddressGroups": { "description": "list of Network Address Groups", "items": { "$ref": "#/components/schemas/NetworkAddressGroup" }, "type": "array" } }, "type": "object" }, "NetworkAddressTranslation": { "description": "Contains the Network Address Translation Details", "properties": { "sourceIP": { "description": "source IP address, required if network peer type is L3BGP\nor L3STATIC and if Network Address Translation (NAT) is\nenabled\n", "type": "string" } }, "type": "object" }, "NetworkCreate": { "example": { "cidr": "192.168.1.0/24", "gateway": "192.168.1.1", "ipAddressRanges": [ { "endingIPAddress": "192.168.1.254", "startingIPAddress": "192.168.1.2" } ], "mtu": 1450, "name": "sample-network", "type": "vlan" }, "properties": { "accessConfig": { "$ref": "#/components/schemas/AccessConfig" }, "cidr": { "description": "Network in CIDR notation (192.168.0.0/24)", "type": "string" }, "dnsServers": { "description": "DNS Servers. If not specified, default is 127.0.0.1 for 'vlan' (private network) and 9.9.9.9 for 'pub-vlan' (public network)", "items": { "type": "string" }, "type": "array" }, "gateway": { "description": "Gateway IP Address", "type": "string" }, "ipAddressRanges": { "description": "IP Address Ranges", "items": { "$ref": "#/components/schemas/IPAddressRange" }, "type": "array" }, "jumbo": { "description": "(deprecated - replaced by mtu) Enable MTU Jumbo Network (for multi-zone locations only)", "type": "boolean" }, "mtu": { "description": "Maximum transmission unit", "maximum": 9000, "minimum": 1450, "type": "integer", "x-isnullable": true }, "name": { "description": "Network Name", "maxLength": 128, "pattern": "^[a-zA-Z0-9-_][a-zA-Z0-9-_]*$", "type": "string" }, "type": { "default": "vlan", "description": "Type of Network - 'vlan' (private network) 'pub-vlan' (public network) 'dhcp-vlan' (for satellite locations only)", "enum": [ "vlan", "pub-vlan", "dhcp-vlan" ], "type": "string" } }, "required": [ "type" ], "type": "object" }, "NetworkID": { "description": "unique identifier of a network", "properties": { "networkID": { "example": "7f950c76-8582-11qeb-8dcd-0242ac172", "type": "string" } }, "required": [ "networkID" ], "type": "object" }, "NetworkIDs": { "properties": { "networkIDs": { "description": "an array of network IDs", "example": [ "7f950c76-8582-11qeb-8dcd-0242ac143", "7f950c76-8582-11veb-8dcd-0242ac153", "7f950c76-8582-11deb-8dcd-0242ac163" ], "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "NetworkInterface": { "properties": { "crn": { "description": "The Network Interface's crn", "type": "string" }, "id": { "description": "The unique Network Interface ID", "type": "string" }, "instance": { "description": "The attached instance to this Network Interface", "properties": { "href": { "description": "Link to instance resource", "type": "string" }, "instanceID": { "description": "The attached instance ID", "type": "string" } }, "type": "object", "x-omitempty": true }, "ipAddress": { "description": "The ip address of this Network Interface", "type": "string" }, "macAddress": { "description": "The mac address of the Network Interface", "type": "string" }, "name": { "description": "Name of the Network Interface (not unique or indexable)", "type": "string" }, "networkSecurityGroupID": { "description": "(deprecated - replaced by networkSecurityGroupIDs) ID of the Network Security Group the network interface will be added to", "type": "string", "x-deprecated": true }, "networkSecurityGroupIDs": { "description": "Network security groups that the network interface is a member of.", "items": { "type": "string" }, "type": "array" }, "status": { "description": "The status of the network address group", "type": "string" }, "userTags": { "description": "The user tags associated with this resource.", "items": { "type": "string" }, "type": "array", "x-omitempty": true } }, "required": [ "id", "name", "crn", "status", "macAddress", "ipAddress" ], "type": "object" }, "NetworkInterfaceCreate": { "properties": { "ipAddress": { "description": "The requested IP address of this Network Interface", "type": "string" }, "name": { "description": "Name of the Network Interface", "type": "string" }, "userTags": { "description": "The user tags associated with this resource.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "NetworkInterfaceUpdate": { "properties": { "instanceID": { "description": "If supplied populated it attaches to the InstanceID, if empty detaches from InstanceID", "type": "string", "x-isnullable": true }, "name": { "description": "Name of the Network Interface", "type": "string", "x-isnullable": true } }, "type": "object" }, "NetworkInterfaces": { "properties": { "interfaces": { "description": "Network Interfaces", "items": { "$ref": "#/components/schemas/NetworkInterface" }, "type": "array" } }, "required": [ "interfaces" ], "type": "object" }, "NetworkPort": { "properties": { "description": { "description": "Description of the port (not unique or indexable)", "type": "string" }, "externalIP": { "description": "The external ip address (for pub-vlan networks)", "type": "string", "x-omitempty": true }, "href": { "description": "Link to port resource", "type": "string" }, "ipAddress": { "description": "The ip address of this port", "type": "string" }, "macAddress": { "description": "The mac address of the network interface", "type": "string" }, "portID": { "description": "The unique Port ID", "type": "string" }, "pvmInstance": { "description": "The attached pvm-instance to this port", "properties": { "href": { "description": "Link to pvm-instance resource", "type": "string" }, "pvmInstanceID": { "description": "The attached pvm-instance ID", "type": "string" } }, "type": "object", "x-omitempty": true }, "status": { "description": "Te", "type": "string" } }, "required": [ "portID", "description", "status", "macAddress", "ipAddress" ], "type": "object" }, "NetworkPortCreate": { "properties": { "description": { "description": "Description of the port (not unique or indexable)", "type": "string" }, "ipAddress": { "description": "The requested ip address of this port", "type": "string" } }, "type": "object" }, "NetworkPortUpdate": { "properties": { "description": { "description": "Description of the port (not unique or indexable)", "type": "string", "x-isnullable": true }, "pvmInstanceID": { "description": "If supplied populated it attaches to the PVMInstanceID, if empty detaches from PVMInstanceID", "type": "string", "x-isnullable": true } }, "type": "object" }, "NetworkPorts": { "properties": { "ports": { "description": "Network Ports", "items": { "$ref": "#/components/schemas/NetworkPort" }, "type": "array" } }, "required": [ "ports" ], "type": "object" }, "NetworkReference": { "properties": { "accessConfig": { "$ref": "#/components/schemas/AccessConfig" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "dhcpManaged": { "description": "DHCP Managed Network", "type": "boolean" }, "href": { "description": "Link to Network resource", "type": "string" }, "jumbo": { "description": "(deprecated - replaced by mtu) Enable MTU Jumbo Network (for multi-zone locations only)", "type": "boolean" }, "mtu": { "description": "Maximum transmission unit", "maximum": 9000, "minimum": 1450, "type": "integer", "x-isnullable": true }, "name": { "description": "Network Name", "type": "string" }, "networkID": { "description": "Unique Network ID", "type": "string" }, "type": { "default": "vlan", "description": "Type of Network - 'vlan' (private network) 'pub-vlan' (public network) 'dhcp-vlan' (for satellite locations only)", "enum": [ "vlan", "pub-vlan", "dhcp-vlan" ], "type": "string" }, "vlanID": { "description": "VLAN ID", "type": "number" } }, "required": [ "networkID", "name", "vlanID", "type", "href" ], "type": "object" }, "NetworkSecurityGroup": { "properties": { "crn": { "description": "The Network Security Group's crn", "type": "string" }, "default": { "description": "Indicates if the Network Security Group is the default Network Security Group in the workspace", "type": "boolean" }, "id": { "description": "The ID of the Network Security Group", "type": "string" }, "members": { "description": "The list of IPv4 addresses and\\or Network Interfaces in the Network Security Group", "items": { "$ref": "#/components/schemas/NetworkSecurityGroupMember" }, "type": "array" }, "name": { "description": "The name of the Network Security Group", "type": "string" }, "rules": { "description": "The list of rules in the Network Security Group", "items": { "$ref": "#/components/schemas/NetworkSecurityGroupRule" }, "type": "array" }, "userTags": { "description": "The user tags associated with this resource.", "items": { "type": "string" }, "type": "array", "x-omitempty": true } }, "required": [ "id", "name", "crn" ], "type": "object" }, "NetworkSecurityGroupAddMember": { "properties": { "target": { "description": "The target member to add. An IP4 address if ipv4-address type or a network interface ID if network-interface type", "type": "string" }, "type": { "description": "The type of member", "enum": [ "ipv4-address", "network-interface" ], "type": "string" } }, "required": [ "type", "target" ], "type": "object" }, "NetworkSecurityGroupAddRule": { "properties": { "action": { "description": "The action to take if the rule matches network traffic", "enum": [ "allow", "deny" ], "type": "string" }, "destinationPort": { "allOf": [ { "$ref": "#/components/schemas/NetworkSecurityGroupRulePort" }, { "description": "The destination port for a network security group rule." } ] }, "destinationPorts": { "allOf": [ { "$ref": "#/components/schemas/NetworkSecurityGroupRulePort" }, { "description": "(deprecated - replaced by destinationPort) The destination port for a network security group rule.", "x-deprecated": true } ] }, "protocol": { "$ref": "#/components/schemas/NetworkSecurityGroupRuleProtocol" }, "remote": { "$ref": "#/components/schemas/NetworkSecurityGroupRuleRemote" }, "sourcePort": { "allOf": [ { "$ref": "#/components/schemas/NetworkSecurityGroupRulePort" }, { "description": "The source port for a network security group rule." } ] }, "sourcePorts": { "allOf": [ { "$ref": "#/components/schemas/NetworkSecurityGroupRulePort" }, { "description": "(deprecated - replaced by sourcePort) The source port for a network security group rule.", "x-deprecated": true } ] } }, "required": [ "action", "protocol", "remote" ], "type": "object" }, "NetworkSecurityGroupClone": { "properties": { "name": { "description": "The name of the cloned network security group", "type": "string" } }, "required": [ "name" ], "type": "object" }, "NetworkSecurityGroupCreate": { "properties": { "name": { "description": "The name of the Network Security Group", "type": "string" }, "userTags": { "description": "The user tags associated with this resource.", "items": { "type": "string" }, "type": "array", "x-omitempty": true } }, "required": [ "name" ], "type": "object" }, "NetworkSecurityGroupMember": { "properties": { "id": { "description": "The ID of the member in a Network Security Group", "type": "string" }, "macAddress": { "description": "The mac address of a Network Interface included if the type is network-interface", "type": "string" }, "networkInterfaceNetworkID": { "description": "The network ID of a Network Interface included if the type is network-interface", "type": "string" }, "target": { "description": "If ipv4-address type, then IPv4 address or if network-interface type, then network interface ID", "type": "string" }, "type": { "description": "The type of member", "enum": [ "ipv4-address", "network-interface" ], "type": "string" } }, "required": [ "id", "type", "target" ], "type": "object" }, "NetworkSecurityGroupMoveMember": { "properties": { "MemberID": { "description": "The member to move", "type": "string" }, "NetworkSecurityGroupId": { "description": "The ID of the Network Security Group the member will be moved to", "type": "string" } }, "required": [ "NetworkSecurityGroupId", "MemberID" ], "type": "object" }, "NetworkSecurityGroupRule": { "properties": { "action": { "description": "The action to take if the rule matches network traffic", "enum": [ "allow", "deny" ], "type": "string" }, "destinationPort": { "$ref": "#/components/schemas/NetworkSecurityGroupRulePort" }, "id": { "description": "The ID of the rule in a Network Security Group", "type": "string" }, "protocol": { "$ref": "#/components/schemas/NetworkSecurityGroupRuleProtocol" }, "remote": { "$ref": "#/components/schemas/NetworkSecurityGroupRuleRemote" }, "sourcePort": { "$ref": "#/components/schemas/NetworkSecurityGroupRulePort" } }, "required": [ "id", "action", "protocol", "remote" ], "type": "object" }, "NetworkSecurityGroupRulePort": { "properties": { "maximum": { "description": "The end of the port range, if applicable. If the value is not present then the default value of 65535 will be the maximum port number.", "maximum": 65535, "type": "integer" }, "minimum": { "description": "The start of the port range, if applicable. If the value is not present then the default value of 1 will be the minimum port number.", "minimum": 1, "type": "integer" } } }, "NetworkSecurityGroupRuleProtocol": { "properties": { "icmpType": { "description": "If icmp type, a ICMP packet type affected by ICMP rules and if not present then all types are matched", "enum": [ "all", "echo", "echo-reply", "source-quench", "time-exceeded", "destination-unreach" ], "type": "string", "x-isnullable": true }, "tcpFlags": { "description": "If tcp type, the list of TCP flags and if not present then all flags are matched", "items": { "$ref": "#/components/schemas/NetworkSecurityGroupRuleProtocolTcpFlag" }, "type": "array" }, "type": { "description": "The protocol of the network traffic", "enum": [ "icmp", "tcp", "udp", "all" ], "type": "string" } } }, "NetworkSecurityGroupRuleProtocolTcpFlag": { "properties": { "flag": { "description": "TCP flag", "enum": [ "syn", "ack", "fin", "rst" ], "type": "string" } } }, "NetworkSecurityGroupRuleRemote": { "properties": { "id": { "description": "The ID of the remote Network Address Group or Network Security Group the rules apply to. Not required for default-network-address-group", "type": "string" }, "type": { "description": "The type of remote group the rules apply to", "enum": [ "network-security-group", "network-address-group", "default-network-address-group" ], "type": "string" } } }, "NetworkSecurityGroupUpdate": { "properties": { "name": { "description": "Replaces the current Network Security Group Name", "type": "string" } }, "type": "object" }, "NetworkSecurityGroups": { "properties": { "networkSecurityGroups": { "description": "list of Network Security Groups", "items": { "$ref": "#/components/schemas/NetworkSecurityGroup" }, "type": "array" } }, "type": "object" }, "NetworkSecurityGroupsAction": { "properties": { "action": { "description": "Name of the action to take; can be enable to enable NSGs in a workspace or disable to disable NSGs in a workspace", "enum": [ "enable", "disable" ], "type": "string" } }, "required": [ "action" ], "type": "object" }, "NetworkUpdate": { "properties": { "dnsServers": { "description": "Replaces the current DNS Servers", "items": { "type": "string" }, "type": "array", "x-isnullable": true }, "gateway": { "description": "Replaces the current Gateway IP Address", "type": "string", "x-isnullable": true }, "ipAddressRanges": { "description": "Replaces the current IP Address Ranges", "items": { "$ref": "#/components/schemas/IPAddressRange" }, "type": "array", "x-isnullable": true }, "name": { "description": "Replaces the current Network Name", "type": "string", "x-isnullable": true } }, "type": "object" }, "Networks": { "properties": { "networks": { "description": "Network References", "items": { "$ref": "#/components/schemas/NetworkReference" }, "type": "array" } }, "required": [ "networks" ], "type": "object" }, "Object": { "type": "object" }, "Operation": { "properties": { "action": { "description": "current action of the operation", "type": "string" }, "id": { "description": "ID of an operation", "type": "string" }, "target": { "description": "target resource of the operation", "type": "string" } }, "required": [ "id", "target", "action" ], "type": "object" }, "Operations": { "properties": { "bootMode": { "description": "Name of the server boot mode a(Boot from disk using copy A), b(Boot from disk using copy B), c(Reserved for IBM lab use only), d(Boot from media/drives)", "enum": [ "a", "b", "c", "d" ], "type": "string" }, "operatingMode": { "description": "Name of the server operating mode", "enum": [ "normal", "manual" ], "type": "string" }, "task": { "description": "Name of the job task to execute", "enum": [ "dston", "retrydump", "consoleservice", "iopreset", "remotedstoff", "remotedston", "iopdump", "dumprestart" ], "type": "string" } }, "type": "object" }, "PVMInstance": { "properties": { "addresses": { "description": "(deprecated - replaced by networks) The list of addresses and their network information", "items": { "$ref": "#/components/schemas/PVMInstanceNetwork" }, "type": "array" }, "consoleLanguage": { "allOf": [ { "$ref": "#/components/schemas/ConsoleLanguage" }, { "description": "Console language and code" } ] }, "creationDate": { "description": "Date/Time of PVM creation", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "dedicatedHostID": { "description": "ID of the dedicated host where the PVM Instance is running, if applicable", "type": "string" }, "deploymentType": { "description": "The custom deployment type", "type": "string" }, "diskSize": { "description": "Size of allocated disk (in GB)", "type": "number" }, "fault": { "$ref": "#/components/schemas/PVMInstanceFault" }, "health": { "$ref": "#/components/schemas/PVMInstanceHealth" }, "hostID": { "description": "The PVM Instance Host ID (Internal Use Only)", "type": "integer" }, "imageID": { "description": "The ImageID used by the server", "type": "string" }, "licenseRepositoryCapacity": { "description": "The VTL license repository capacity TB value", "type": "integer" }, "maxmem": { "description": "Maximum amount of memory that can be allocated (in GB, for resize)", "type": "number" }, "maxproc": { "description": "Maximum number of processors that can be allocated (for resize)", "type": "number" }, "memory": { "description": "Amount of memory allocated (in GB)", "type": "number" }, "migratable": { "default": true, "description": "whether the instance can be migrated", "type": "boolean" }, "minmem": { "description": "Minimum amount of memory that can be allocated (in GB, for resize)", "type": "number" }, "minproc": { "description": "Minimum number of processors that can be allocated (for resize)", "type": "number" }, "networkIDs": { "description": "(deprecated - replaced by networks) List of Network IDs", "items": { "description": "Network ID", "type": "string" }, "type": "array" }, "networks": { "description": "The pvm instance networks information", "items": { "$ref": "#/components/schemas/PVMInstanceNetwork" }, "type": "array" }, "operatingSystem": { "description": "OS system information (usually version and build)", "type": "string" }, "osType": { "description": "Type of the OS [aix, ibmi, rhel, sles, vtl, rhcos]", "type": "string" }, "pinPolicy": { "description": "VM pinning policy to use [none, soft, hard]", "type": "string" }, "placementGroup": { "default": "none", "description": "The placement group of the server", "type": "string" }, "procType": { "default": "dedicated", "description": "Processor type (dedicated, shared, capped)", "enum": [ "dedicated", "shared", "capped", "" ], "type": "string" }, "processors": { "description": "Number of processors allocated", "type": "number" }, "progress": { "description": "The progress of an operation", "type": "number" }, "pvmInstanceID": { "description": "PCloud PVM Instance ID", "type": "string" }, "sapProfile": { "allOf": [ { "$ref": "#/components/schemas/SAPProfileReference" }, { "description": "If this is an SAP pvm-instance the profile reference will link to the SAP profile" } ] }, "serverName": { "description": "Name of the server", "type": "string" }, "sharedProcessorPool": { "description": "The shared processor pool of the server", "type": "string" }, "sharedProcessorPoolID": { "description": "The shared processor pool id", "type": "string" }, "softwareLicenses": { "allOf": [ { "$ref": "#/components/schemas/SoftwareLicenses" }, { "description": "The pvm instance Software Licenses", "x-isnullable": true } ] }, "srcs": { "description": "The pvm instance SRC lists", "items": { "items": { "$ref": "#/components/schemas/SRC" }, "type": "array" }, "type": "array" }, "status": { "description": "The status of the instance", "type": "string" }, "storageConnection": { "description": "The storage connection type", "type": "string" }, "storagePool": { "description": "Storage Pool where server is deployed", "type": "string" }, "storagePoolAffinity": { "default": true, "description": "Indicates if all volumes attached to the server must reside in the same storage pool; Defaults to true when initially deploying a PVMInstance", "type": "boolean" }, "storageType": { "description": "Storage type where server is deployed", "type": "string" }, "sysType": { "description": "System type used to host the instance", "type": "string" }, "taskState": { "description": "Represents the task state of a virtual machine (VM).", "type": "string" }, "updatedDate": { "description": "Date/Time of PVM last update", "format": "date-time", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "virtualCores": { "allOf": [ { "$ref": "#/components/schemas/VirtualCores" }, { "description": "The pvm instance virtual CPU information" } ] }, "virtualSerialNumber": { "allOf": [ { "$ref": "#/components/schemas/GetServerVirtualSerialNumber" }, { "description": "Information about Virtual Serial Number assigned to the PVM Instance", "x-omitempty": true } ] }, "volumeIDs": { "description": "List of volume IDs", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "pvmInstanceID", "serverName", "imageID", "processors", "procType", "memory", "diskSize", "networkIDs", "volumeIDs", "status", "storageType", "osType" ], "type": "object" }, "PVMInstanceAction": { "properties": { "action": { "description": "Name of the action to take; can be start, stop, hard-reboot, soft-reboot, immediate-shutdown, reset-state, dhcp-ip-sync (on-prem only)", "enum": [ "start", "stop", "immediate-shutdown", "hard-reboot", "soft-reboot", "reset-state", "dhcp-ip-sync" ], "type": "string" } }, "required": [ "action" ], "type": "object" }, "PVMInstanceAddNetwork": { "properties": { "ipAddress": { "description": "The requested ip address of this network interface", "type": "string" }, "networkID": { "description": "ID of the network", "type": "string" }, "networkSecurityGroupIDs": { "description": "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.", "items": { "type": "string" }, "type": "array" } }, "required": [ "networkID" ], "type": "object" }, "PVMInstanceCapture": { "properties": { "captureDestination": { "default": "cloud-storage", "description": "Destination for the deployable image", "enum": [ "image-catalog", "cloud-storage", "both" ], "type": "string" }, "captureName": { "description": "Name of the deployable image created for the captured PVMInstance", "type": "string" }, "captureVolumeIDs": { "description": "List of Data volume IDs to include in the captured PVMInstance", "items": { "description": "Volume ID", "type": "string" }, "type": "array" }, "cloudStorageAccessKey": { "description": "Cloud Storage Access key", "type": "string" }, "cloudStorageImagePath": { "description": "Cloud Storage Image Path (bucket-name [/folder/../..])", "type": "string" }, "cloudStorageRegion": { "description": "Cloud Storage Region", "type": "string" }, "cloudStorageSecretKey": { "description": "Cloud Storage Secret key", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "captureName", "captureDestination" ], "type": "object" }, "PVMInstanceConfiguration": { "properties": { "consoleLanguage": { "allOf": [ { "$ref": "#/components/schemas/ConsoleLanguage" }, { "description": "Console language and code" } ] }, "licenseRepositoryCapacity": { "description": "The VTL license repository capacity TB value", "type": "integer" }, "sapProfile": { "allOf": [ { "$ref": "#/components/schemas/SAPProfileReference" }, { "description": "If this is an SAP pvm-instance the profile reference will link to the SAP profile" } ] }, "softwareLicenses": { "allOf": [ { "$ref": "#/components/schemas/SoftwareLicenses" }, { "description": "The pvm instance Software Licenses", "x-isnullable": true, "x-omitempty": true } ] }, "systemReferenceCodes": { "description": "The pvm instance system reference code lists", "items": { "items": { "$ref": "#/components/schemas/SRC" }, "type": "array" }, "type": "array" } }, "type": "object" }, "PVMInstanceConsole": { "properties": { "consoleURL": { "description": "The URL to the noVNC console for the PVM Instance", "type": "string" } }, "required": [ "consoleURL" ], "type": "object" }, "PVMInstanceCores": { "properties": { "assigned": { "description": "The active processor information", "type": "number" }, "maximum": { "description": "The maximum number of processors that can be allocated (for resize)", "type": "number" }, "minimum": { "description": "The minimum number of processors that can be allocated (for resize)", "type": "number" } }, "required": [ "assigned" ], "type": "object" }, "PVMInstanceCreate": { "properties": { "deploymentTarget": { "allOf": [ { "$ref": "#/components/schemas/DeploymentTarget" }, { "description": "The deployment of a dedicated host" } ] }, "deploymentType": { "description": "The custom deployment type", "type": "string" }, "imageID": { "description": "Image ID of the image to use for the server", "type": "string" }, "keyPairName": { "description": "The name of the SSH key pair provided to the server for authenticating users (looked up in the tenant's list of keys)", "type": "string" }, "licenseRepositoryCapacity": { "description": "The VTL license repository capacity TB value", "type": "integer" }, "memory": { "description": "Amount of memory allocated (in GB)", "type": "number" }, "migratable": { "default": true, "description": "(deprecated - replaced by pinPolicy) Indicates if the server is allowed to migrate between hosts", "type": "boolean" }, "networkIDs": { "description": "(deprecated - replaced by networks) List of Network IDs", "items": { "description": "Network ID", "type": "string" }, "type": "array" }, "networks": { "description": "The pvm instance networks information", "items": { "$ref": "#/components/schemas/PVMInstanceAddNetwork" }, "type": "array" }, "pinPolicy": { "$ref": "#/components/schemas/PinPolicy" }, "placementGroup": { "description": "The placement group for the server", "type": "string" }, "procType": { "default": "dedicated", "description": "Processor type (dedicated, shared, capped)", "enum": [ "dedicated", "shared", "capped" ], "type": "string" }, "processors": { "description": "Number of processors allocated", "type": "number" }, "replicantAffinityPolicy": { "default": "none", "description": "Affinity policy for replicants being created; affinity for the same host, anti-affinity for different hosts, none for no preference", "enum": [ "affinity", "anti-affinity", "none" ], "type": "string" }, "replicantNamingScheme": { "default": "suffix", "description": "How to name the created vms", "enum": [ "prefix", "suffix" ], "type": "string" }, "replicants": { "description": "Number of duplicate instances to create in this request", "minimum": 1, "type": "number", "x-isnullable": true }, "serverName": { "description": "Name of the server to create", "type": "string" }, "sharedProcessorPool": { "description": "The shared processor pool for server deployment", "type": "string" }, "softwareLicenses": { "allOf": [ { "$ref": "#/components/schemas/SoftwareLicenses" }, { "description": "The pvm instance Software Licenses", "x-isnullable": true } ] }, "storageAffinity": { "allOf": [ { "$ref": "#/components/schemas/StorageAffinity" }, { "description": "The storage affinity data; ignored if storagePool is provided; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage pool the image was created in" } ] }, "storageConnection": { "description": "The storage connection type", "enum": [ "vSCSI", "maxVolumeSupport" ], "type": "string" }, "storagePool": { "description": "Storage Pool for server deployment; if provided then storageAffinity will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage pool the image was created in", "type": "string" }, "storagePoolAffinity": { "default": true, "description": "Indicates if all volumes attached to the PVMInstance must reside in the same storage pool. If set to false, volumes from any storage pool can be attached to the PVMInstance. This flag only impacts PVMInstance snapshot and capture operations. For capture, only volumes that reside in the same storage pool as the PVMInstance's boot volume can be included. For snapshots, all volumes included in the snapshot must reside in the same storage pool.", "type": "boolean" }, "storageType": { "description": "Storage type for server deployment; if storageType is not provided the storage type will default to 'tier3'.", "type": "string" }, "sysType": { "description": "System type used to host the instance", "type": "string" }, "userData": { "description": "Cloud init user defined data; For FLS, only cloud-config user-data is supported and data must not be compressed or exceed 63K", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "virtualCores": { "allOf": [ { "$ref": "#/components/schemas/VirtualCores" }, { "description": "The pvm instance virtual CPU information" } ] }, "virtualSerialNumber": { "allOf": [ { "$ref": "#/components/schemas/CreateServerVirtualSerialNumber" }, { "description": "Virtual Serial Number information", "x-omitempty": true } ] }, "volumeIDs": { "description": "List of volume IDs", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "serverName", "imageID", "processors", "procType", "memory" ], "type": "object" }, "PVMInstanceDelete": { "properties": { "retainVSN": { "description": "Indicates if the Virtual Serial Number attached to a PVM Instance is retained or not", "type": "boolean", "x-isnullable": true } } }, "PVMInstanceFault": { "description": "Fault information (if occurred)", "properties": { "code": { "description": "The fault status of the server, if any", "type": "number" }, "created": { "description": "The date and time the fault occurred", "format": "date-time", "type": "string" }, "details": { "description": "The fault details of the server, if any", "type": "string" }, "message": { "description": "The fault message of the server, if any", "type": "string" } }, "type": "object" }, "PVMInstanceHealth": { "description": "PVM's health status details", "properties": { "lastUpdate": { "description": "Date/Time of PVM last health status change", "type": "string" }, "reason": { "description": "The health status reason, if any", "type": "string" }, "status": { "description": "The PVM's health status value", "type": "string" } }, "type": "object" }, "PVMInstanceList": { "description": "A list of PVMInstances", "items": { "$ref": "#/components/schemas/PVMInstance" }, "type": "array" }, "PVMInstanceMemory": { "properties": { "assigned": { "description": "The active memory information", "type": "number" }, "maximum": { "description": "The maximum amount of memory that can be allocated (in GB, for resize)", "type": "number" }, "minimum": { "description": "The minimum amount of memory that can be allocated (in GB, for resize)", "type": "number" } }, "required": [ "assigned" ], "type": "object" }, "PVMInstanceMultiCreate": { "properties": { "affinityPolicy": { "default": "none", "description": "Affinity policy for pvm-instances being created; affinity for the same host, anti-affinity for different hosts, none for no preference", "enum": [ "affinity", "anti-affinity", "none" ], "type": "string" }, "count": { "description": "Number of pvm-instances to create", "type": "integer" }, "numerical": { "default": "suffix", "description": "Where to place the numerical number of the multi-created instance", "enum": [ "prefix", "suffix" ], "type": "string" } }, "type": "object" }, "PVMInstanceNetwork": { "description": "A map containing information about a network address", "properties": { "externalIP": { "description": "The external ip address (for pub-vlan networks)", "type": "string", "x-omitempty": true }, "href": { "description": "Link to PVM Instance Network", "type": "string", "x-omitempty": true }, "ip": { "description": "(deprecated - replaced by ipAddress)", "type": "string" }, "ipAddress": { "description": "The ip address of this network interface", "type": "string" }, "macAddress": { "description": "The mac address of the network interface", "type": "string" }, "networkID": { "description": "ID of the network", "type": "string" }, "networkInterfaceID": { "description": "ID of the network interface", "type": "string" }, "networkName": { "description": "The name of the network the address is on", "type": "string" }, "networkSecurityGroupIDs": { "description": "IDs of the network necurity groups that the network interface is a member of", "items": { "type": "string" }, "type": "array", "x-omitempty": true }, "networkSecurityGroupsHref": { "description": "Links to the network security groups that the network interface is a member of", "items": { "type": "string" }, "type": "array", "x-omitempty": true }, "type": { "description": "The address type (fixed or dynamic)", "type": "string" }, "version": { "description": "The version of the information provided", "type": "number" } }, "type": "object" }, "PVMInstanceNetworks": { "properties": { "networks": { "description": "PVM Instance Networks", "items": { "$ref": "#/components/schemas/PVMInstanceNetwork" }, "type": "array" } }, "required": [ "networks" ], "type": "object" }, "PVMInstanceOperatingSystem": { "properties": { "type": { "description": "Type of the OS [aix, ibmi, rhel, sles, vtl, rhcos]", "type": "string" }, "version": { "description": "OS system information (usually version and build)", "type": "string" } }, "required": [ "type" ], "type": "object" }, "PVMInstanceOperation": { "properties": { "operation": { "$ref": "#/components/schemas/Operations" }, "operationType": { "description": "Name of the operation to execute; can be job or boot", "enum": [ "job", "boot" ], "type": "string" } }, "required": [ "operationType", "operation" ], "type": "object" }, "PVMInstanceReference": { "properties": { "addresses": { "description": "(deprecated - replaced by networks) The list of addresses and their network information", "items": { "$ref": "#/components/schemas/PVMInstanceNetwork" }, "type": "array" }, "consoleLanguage": { "allOf": [ { "$ref": "#/components/schemas/ConsoleLanguage" }, { "description": "Console language and code" } ] }, "creationDate": { "description": "Date/Time of PVM creation", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "dedicatedHostID": { "description": "ID of the dedicated host where the PVM Instance is running, if applicable", "type": "string" }, "diskSize": { "description": "Size of allocated disk (in GB)", "type": "number" }, "fault": { "$ref": "#/components/schemas/PVMInstanceFault" }, "health": { "$ref": "#/components/schemas/PVMInstanceHealth" }, "hostID": { "description": "The PVM Instance Host ID (Internal Use Only)", "type": "integer" }, "href": { "description": "Link to Cloud Instance resource", "type": "string" }, "imageID": { "description": "The ImageID used by the server", "type": "string" }, "licenseRepositoryCapacity": { "description": "The VTL license repository capacity TB value", "type": "integer" }, "maxmem": { "description": "Maximum amount of memory that can be allocated (in GB, for resize)", "type": "number" }, "maxproc": { "description": "Maximum number of processors that can be allocated (for resize)", "type": "number" }, "memory": { "description": "Amount of memory allocated (in GB)", "type": "number" }, "minmem": { "description": "Minimum amount of memory that can be allocated (in GB, for resize)", "type": "number" }, "minproc": { "description": "Minimum number of processors that can be allocated (for resize)", "type": "number" }, "networks": { "description": "The list of addresses and their network information", "items": { "$ref": "#/components/schemas/PVMInstanceNetwork" }, "type": "array" }, "operatingSystem": { "description": "OS system information (usually version and build)", "type": "string" }, "osType": { "description": "Type of the OS [aix, ibmi, rhel, sles, vtl, rhcos]", "type": "string" }, "pinPolicy": { "description": "VM pinning policy to use [none, soft, hard]", "type": "string" }, "placementGroup": { "default": "none", "description": "The placement group of the server", "type": "string" }, "procType": { "default": "dedicated", "description": "Processor type (dedicated, shared, capped)", "enum": [ "dedicated", "shared", "capped" ], "type": "string" }, "processors": { "description": "Number of processors allocated", "type": "number" }, "progress": { "description": "The progress of an operation", "type": "number" }, "pvmInstanceID": { "description": "PCloud PVM Instance ID", "type": "string" }, "sapProfile": { "allOf": [ { "$ref": "#/components/schemas/SAPProfileReference" }, { "description": "If this is an SAP pvm-instance the profile reference will link to the SAP profile" } ] }, "serverName": { "description": "Name of the server", "type": "string" }, "sharedProcessorPool": { "description": "The shared processor pool of the server", "type": "string" }, "sharedProcessorPoolID": { "description": "The shared processor pool id", "type": "string" }, "softwareLicenses": { "allOf": [ { "$ref": "#/components/schemas/SoftwareLicenses" }, { "description": "The pvm instance Software Licenses", "x-isnullable": true, "x-omitempty": true } ] }, "srcs": { "description": "The pvm instance SRC lists", "items": { "items": { "$ref": "#/components/schemas/SRC" }, "type": "array" }, "type": "array" }, "status": { "description": "The status of the instance", "type": "string" }, "storageConnection": { "description": "The storage connection type", "type": "string" }, "storagePool": { "description": "Storage Pool where server is deployed", "type": "string" }, "storagePoolAffinity": { "default": true, "description": "Indicates if all volumes attached to the server must reside in the same storage pool", "type": "boolean" }, "storageType": { "description": "Storage type of the deployment storage pool", "type": "string" }, "sysType": { "description": "System type used to host the instance", "type": "string" }, "taskState": { "description": "Represents the task state of a virtual machine (VM).", "type": "string" }, "updatedDate": { "description": "Date/Time of PVM last update", "format": "date-time", "type": "string" }, "virtualCores": { "allOf": [ { "$ref": "#/components/schemas/VirtualCores" }, { "description": "The pvm instance virtual CPU information" } ] }, "virtualSerialNumber": { "allOf": [ { "$ref": "#/components/schemas/GetServerVirtualSerialNumber" }, { "description": "Information about Virtual Serial Number assigned to the PVM Instance", "x-omitempty": true } ] } }, "required": [ "pvmInstanceID", "serverName", "imageID", "processors", "procType", "memory", "diskSize", "status", "osType", "href" ], "type": "object" }, "PVMInstanceReferenceV2": { "properties": { "configuration": { "allOf": [ { "$ref": "#/components/schemas/PVMInstanceConfiguration" }, { "description": "The pvm instance server configuration" } ] }, "cores": { "allOf": [ { "$ref": "#/components/schemas/PVMInstanceCores" }, { "description": "The pvm instance cores information" } ] }, "creationDate": { "description": "Date/Time of PVM creation", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "deployment": { "allOf": [ { "$ref": "#/components/schemas/PvmInstanceDeployment" }, { "description": "The pvm instance deployment information" } ] }, "health": { "$ref": "#/components/schemas/PVMInstanceV2Health" }, "host": { "allOf": [ { "$ref": "#/components/schemas/PvmInstanceHost" }, { "description": "The pvm instance host information" } ] }, "href": { "description": "Link to Cloud Instance resource", "type": "string" }, "id": { "description": "PCloud PVM Instance ID", "type": "string" }, "memory": { "allOf": [ { "$ref": "#/components/schemas/PVMInstanceMemory" }, { "description": "The pvm instance memory information" } ] }, "name": { "description": "Name of the server", "type": "string" }, "networkPorts": { "description": "The pvm instance network ports information", "items": { "$ref": "#/components/schemas/PVMInstanceV2NetworkPort" }, "type": "array" }, "operatingSystem": { "allOf": [ { "$ref": "#/components/schemas/PVMInstanceOperatingSystem" }, { "description": "The pvm instance OS system information" } ] }, "placementGroup": { "allOf": [ { "$ref": "#/components/schemas/PvmInstancePlacementGroup" }, { "description": "The pvm instance placement group information" } ] }, "status": { "description": "The status of the instance", "type": "string" }, "virtualCores": { "allOf": [ { "$ref": "#/components/schemas/PVMInstanceVirtualCores" }, { "description": "The pvm instance virtual CPU information" } ] } }, "required": [ "id", "name", "cores", "memory", "status", "operatingSystem", "href", "deployment", "networkPorts" ], "type": "object" }, "PVMInstanceRemoveNetwork": { "properties": { "macAddress": { "description": "The mac address of the network interface to be removed", "type": "string" } }, "type": "object" }, "PVMInstanceUpdate": { "properties": { "licenseRepositoryCapacity": { "description": "The VTL license repository capacity TB value", "type": "integer" }, "memory": { "description": "Amount of memory allocated (in GB)", "type": "number" }, "migratable": { "default": true, "description": "(deprecated - replaced by pinPolicy) Indicates if the server is allowed to migrate between hosts", "type": "boolean" }, "pinPolicy": { "$ref": "#/components/schemas/PinPolicy" }, "procType": { "description": "Processor type (dedicated, shared, capped)", "enum": [ "dedicated", "shared", "capped" ], "type": "string" }, "processors": { "description": "Number of processors allocated", "type": "number" }, "sapProfileID": { "description": "If an SAP pvm-instance, the SAP profile ID to switch to (only while shutdown)", "type": "string" }, "serverName": { "description": "Name of the server to create", "type": "string" }, "softwareLicenses": { "allOf": [ { "$ref": "#/components/schemas/SoftwareLicenses" }, { "description": "The pvm instance Software Licenses", "x-isnullable": true } ] }, "storagePoolAffinity": { "default": true, "description": "Indicates if all volumes attached to the server must reside in the same storage pool; If set to false then volumes from any storage type and pool can be attached to the PVMInstance; Impacts PVMInstance snapshot, capture, and clone, for capture and clone - only data volumes that are of the same storage type and in the same storage pool of the PVMInstance's boot volume can be included; for snapshot - all data volumes to be included in the snapshot must reside in the same storage type and pool. Once set to false, cannot be set back to true unless all volumes attached reside in the same storage type and pool.", "type": "boolean" }, "virtualCores": { "allOf": [ { "$ref": "#/components/schemas/VirtualCores" }, { "description": "The pvm instance virtual CPU information" } ] } }, "type": "object" }, "PVMInstanceUpdateResponse": { "properties": { "licenseRepositoryCapacity": { "description": "The VTL license repository capacity TB value", "type": "integer" }, "memory": { "description": "Amount of memory allocated (in GB)", "type": "number" }, "pinPolicy": { "$ref": "#/components/schemas/PinPolicy" }, "procType": { "description": "Processor type (dedicated, shared, capped)", "enum": [ "dedicated", "shared", "capped" ], "type": "string" }, "processors": { "description": "Number of processors allocated", "type": "number" }, "serverName": { "description": "Name of the server", "type": "string" }, "statusUrl": { "description": "URL to check for status of the operation (for now, just the URL for the GET on the server, which has status information from powervc)", "type": "string" }, "storagePoolAffinity": { "default": true, "description": "Indicates if all volumes attached to the server must reside in the same storage pool; If set to false then volumes from any storage type and pool can be attached to the PVMInstance; Impacts PVMInstance snapshot, capture, and clone, for capture and clone - only data volumes that are of the same storage type and in the same storage pool of the PVMInstance's boot volume can be included; for snapshot - all data volumes to be included in the snapshot must reside in the same storage type and pool. Once set to false, cannot be set back to true unless all volumes attached reside in the same storage type and pool.", "type": "boolean" }, "virtualCores": { "allOf": [ { "$ref": "#/components/schemas/VirtualCores" }, { "description": "The pvm instance virtual CPU information" } ] } }, "type": "object" }, "PVMInstanceV2Health": { "description": "PVM's health status details", "properties": { "status": { "description": "The PVM's health status value", "type": "string" } }, "required": [ "status" ], "type": "object" }, "PVMInstanceV2NetworkPort": { "description": "PVM's Port information", "properties": { "id": { "description": "Unique Port ID", "type": "string" }, "ipProtocol": { "description": "Dynamic Host Configuration Protocol {IPv4, IPv6}", "enum": [ "IPv4", "IPv6" ], "type": "string" }, "macAddress": { "description": "The mac address of the network interface", "type": "string" }, "privateIP": { "description": "The private ip address", "type": "string", "x-omitempty": true }, "type": { "description": "The type of ip allocation {dhcp, static}", "enum": [ "dhcp", "static" ], "type": "string" } }, "type": "object" }, "PVMInstanceVirtualCores": { "properties": { "assigned": { "description": "The active virtual Cores", "minimum": 1, "type": "integer" }, "maximum": { "description": "The maximum DLPAR range for virtual Cores (Display only support)", "type": "integer" }, "minimum": { "description": "The minimum DLPAR range for virtual Cores (Display only support)", "type": "integer" } }, "required": [ "assigned" ], "type": "object" }, "PVMInstanceVolumeUpdate": { "properties": { "deleteOnTermination": { "description": "Indicates if the volume should be deleted when the PVMInstance is terminated.", "type": "boolean" } }, "required": [ "deleteOnTermination" ], "type": "object" }, "PVMInstances": { "properties": { "pvmInstances": { "description": "PVM Instance References", "items": { "$ref": "#/components/schemas/PVMInstanceReference" }, "type": "array" } }, "required": [ "pvmInstances" ], "type": "object" }, "PVMInstancesV2": { "properties": { "pvmInstances": { "description": "PVM Instance References", "items": { "$ref": "#/components/schemas/PVMInstanceReferenceV2" }, "type": "array" } }, "required": [ "pvmInstances" ], "type": "object" }, "PeerGatewayAddress": { "description": "IP address of the Peer Gateway attached to this VPNConnection", "example": "192.168.1.1", "format": "ipv4", "type": "string" }, "PeerSubnetUpdate": { "description": "CIDR of peer subnet to attach/detach", "properties": { "cidr": { "example": "128.170.1.0/32", "type": "string" } }, "required": [ "cidr" ], "type": "object" }, "PeerSubnets": { "properties": { "peerSubnets": { "description": "an array of strings containing CIDR of peer subnets", "example": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27", "128.170.1.0/32" ], "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "PeeringNetwork": { "properties": { "cidr": { "description": "Network in CIDR notation (192.168.0.0/24)", "type": "string", "x-go-custom-tag": "datastore:\"cidr\"" }, "dnsServers": { "description": "DNS Servers", "items": { "type": "string" }, "type": "array", "x-go-custom-tag": "datastore:\"dnsServers\"", "x-omitempty": true }, "projectName": { "description": "Name of project to be peered", "type": "string", "x-go-custom-tag": "datastore:\"projectName\"" } }, "required": [ "projectName", "cidr" ], "type": "object" }, "PinPolicy": { "description": "Specify PVM pin policy", "enum": [ "none", "soft", "hard" ], "type": "string" }, "PlacementGroup": { "properties": { "id": { "description": "The id of the Placement Group", "type": "string" }, "members": { "description": "The List of PVM Instance IDs associated with the Placement Group", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the Placement Group", "type": "string" }, "policy": { "description": "The Placement Group Policy", "enum": [ "affinity", "anti-affinity" ], "type": "string" } }, "required": [ "id", "name", "policy", "members" ], "type": "object" }, "PlacementGroupCreate": { "properties": { "name": { "description": "The name of the Placement Group", "type": "string" }, "policy": { "description": "The Placement Group Policy", "enum": [ "affinity", "anti-affinity" ], "type": "string" } }, "required": [ "name", "policy" ], "type": "object" }, "PlacementGroupServer": { "properties": { "id": { "description": "The ID of the Server", "type": "string" } }, "required": [ "id" ], "type": "object" }, "PlacementGroups": { "properties": { "placementGroups": { "description": "List of Server Placement Groups", "items": { "$ref": "#/components/schemas/PlacementGroup" }, "type": "array" } }, "required": [ "placementGroups" ], "type": "object" }, "PodCapacity": { "description": "List of available resources within a Pod", "properties": { "PodData": { "$ref": "#/components/schemas/PodData" }, "StorageControllers": { "$ref": "#/components/schemas/StorageControllers" }, "SystemPools": { "$ref": "#/components/schemas/SystemPoolsCapacity" } }, "type": "object" }, "PodData": { "description": "Description of a PPCaaS Pod", "properties": { "cores": { "description": "Number of available cores in the Pod", "type": "number" }, "memory": { "description": "Amount of available memory in the Pod (GB)", "type": "integer" }, "satLocationID": { "description": "ID of the Satellite Location", "type": "string" }, "storage": { "description": "Amount of available storage in the Pod (GB)", "type": "integer" }, "totalCores": { "description": "Total number of usable cores in the Pod", "type": "number" }, "totalMemory": { "description": "Total amount of usable memory in the Pod (GB)", "type": "integer" }, "totalPhysCores": { "description": "Total number of physical cores in the Pod", "type": "number" }, "totalPhysMemory": { "description": "Total amount of physical memory in the Pod (GB)", "type": "integer" }, "totalPhysStorage": { "description": "Total amount of physical storage in the Pod (GB)", "type": "number" }, "totalStorage": { "description": "Total amount of usable storage in the Pod (GB)", "type": "integer" } }, "required": [ "cores", "memory", "storage", "satLocationID", "totalCores", "totalMemory", "totalStorage", "totalPhysCores", "totalPhysMemory", "totalPhysStorage" ], "type": "object" }, "PvmInstanceDeployment": { "properties": { "machineType": { "description": "Machine type used to host the instance", "type": "string" }, "pinPolicy": { "description": "VM pin policy to use [none, soft, hard]", "type": "string" }, "processorMode": { "default": "dedicated", "description": "Processor mode (dedicated, shared, capped)", "enum": [ "dedicated", "shared", "capped" ], "type": "string" }, "type": { "description": "Type of Deployment [SAP-RISE, EPIC]", "type": "string" } }, "required": [ "processorMode" ], "type": "object" }, "PvmInstanceHost": { "properties": { "dedicatedHostID": { "description": "ID of the dedicated host where the PVM Instance is running, if applicable", "type": "string" }, "id": { "description": "The PVM Instance Host ID (Internal Use Only)", "type": "integer" } }, "type": "object" }, "PvmInstancePlacementGroup": { "properties": { "id": { "description": "The placement group id of the server", "type": "string" } }, "required": [ "id" ], "type": "object" }, "RegionStorageTiers": { "description": "An array of of storage tiers supported in a region", "items": { "$ref": "#/components/schemas/StorageTier" }, "type": "array" }, "RemoteCopyRelationship": { "properties": { "auxChangedVolumeName": { "description": "Name of the volume that is acting as the auxiliary change volume for the relationship", "type": "string" }, "auxVolumeName": { "description": "Auxiliary volume name at storage host level", "type": "string" }, "consistencyGroupName": { "description": "Consistency Group Name if volume is a part of volume group", "type": "string" }, "copyType": { "description": "Indicates the copy type.", "type": "string" }, "cyclingMode": { "description": "Indicates the type of cycling mode used.", "type": "string" }, "freezeTime": { "description": "Freeze time of remote copy relationship", "format": "date-time", "type": "string" }, "masterChangedVolumeName": { "description": "Name of the volume that is acting as the master change volume for the relationship", "type": "string" }, "masterVolumeName": { "description": "Master volume name at storage host level", "type": "string" }, "name": { "description": "Remote copy relationship name", "type": "string" }, "primaryRole": { "description": "Indicates whether master/aux volume is playing the primary role", "type": "string" }, "progress": { "description": "Indicates the relationship progress", "type": "integer" }, "remoteCopyID": { "description": "Remote copy relationship ID", "type": "string" }, "state": { "description": "Indicates the relationship state", "type": "string" }, "sync": { "description": "Indicates whether the relationship is synchronized", "type": "string" } }, "required": [ "name", "remoteCopyID" ], "type": "object" }, "RemoveVirtualSerialNumber": { "properties": { "serial": { "description": "Provide a reserved Virtual Serial Number", "type": "string" } }, "required": [ "serial" ] }, "ReplicationService": { "properties": { "enabled": { "description": "Service Enabled", "type": "boolean" }, "targetLocations": { "description": "List of all replication targets", "items": { "$ref": "#/components/schemas/ReplicationTargetLocation" }, "type": "array" } }, "required": [ "enabled", "targetLocations" ], "type": "object" }, "ReplicationSites": { "description": "list of Replication Sites", "items": { "$ref": "#/components/schemas/Site" }, "type": "array" }, "ReplicationTargetLocation": { "properties": { "region": { "description": "regionZone of replication site", "type": "string" }, "status": { "description": "the replication site is active / down", "enum": [ "active", "down" ], "type": "string" } }, "type": "object" }, "SAPCreate": { "properties": { "deploymentTarget": { "allOf": [ { "$ref": "#/components/schemas/DeploymentTarget" }, { "description": "The deployment of a dedicated host" } ] }, "deploymentType": { "description": "Custom SAP Deployment Type Information (For Internal Use Only)", "type": "string" }, "imageID": { "description": "Image ID of the sap image to use for the server", "type": "string" }, "instances": { "$ref": "#/components/schemas/PVMInstanceMultiCreate" }, "name": { "description": "Name of the sap pvm-instance", "type": "string" }, "networks": { "description": "The pvm instance networks information", "items": { "$ref": "#/components/schemas/PVMInstanceAddNetwork" }, "type": "array" }, "pinPolicy": { "$ref": "#/components/schemas/PinPolicy" }, "placementGroup": { "description": "The placement group for the server", "type": "string" }, "profileID": { "description": "SAP Profile ID for the amount of cores and memory", "pattern": "^[\\s]*[A-Za-z][A-Za-z0-9\\-]{3,}$", "type": "string" }, "sshKeyName": { "description": "The name of the SSH Key to provide to the server for authenticating", "type": "string" }, "storageAffinity": { "allOf": [ { "$ref": "#/components/schemas/StorageAffinity" }, { "description": "The storage affinity data; ignored if storagePool is provided; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage pool the image was created in" } ] }, "storagePool": { "description": "Storage Pool for server deployment; if provided then storageAffinity and storageType will be ignored; Only valid when you deploy one of the IBM supplied stock images. Storage pool for a custom image (an imported image or an image that is created from a PVMInstance capture) defaults to the storage pool the image was created in", "type": "string" }, "storagePoolAffinity": { "default": true, "description": "Indicates if all volumes attached to the server must reside in the same storage pool; Defaults to true when initially deploying a PVMInstance", "type": "boolean" }, "storageType": { "description": "Storage type for server deployment; if storageType is not provided the storage type will default to 'tier3'.", "type": "string" }, "sysType": { "description": "System type used to host the instance. Only e880, e980, e1080 are supported", "type": "string" }, "userData": { "description": "Cloud init user defined data; For FLS, only cloud-config user-data is supported and data must not be compressed or exceed 63K", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumeIDs": { "description": "List of Volume IDs to attach to the pvm-instance on creation", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "name", "imageID", "profileID", "networks" ], "type": "object" }, "SAPProfile": { "properties": { "certified": { "description": "Has certification been performed on profile", "type": "boolean" }, "cores": { "description": "Amount of cores", "type": "integer" }, "defaultSystem": { "description": "System to use if not provided", "type": "string" }, "fullSystemProfile": { "description": "Requires full system for deployment", "type": "boolean", "x-omitempty": false }, "memory": { "description": "Amount of memory (in GB)", "type": "integer" }, "profileID": { "description": "SAP Profile ID", "type": "string" }, "saps": { "description": "SAP Application Performance Standard", "type": "integer", "x-omitempty": false }, "smtMode": { "description": "Required smt mode for that profile", "enum": [ 4, 8 ], "type": "integer", "x-omitempty": false }, "supportedSystems": { "description": "List of supported systems", "items": { "description": "System name", "type": "string" }, "type": "array" }, "type": { "default": "balanced", "description": "Type of profile", "enum": [ "balanced", "compute", "memory", "non-production", "ultra-memory", "small", "SAP Rise Optimized" ], "type": "string" }, "workloadTypes": { "description": "List of supported workload types", "items": { "description": "Workload type", "type": "string" }, "type": "array", "x-omitempty": false } }, "required": [ "profileID", "type", "cores", "memory", "certified" ], "type": "object" }, "SAPProfileReference": { "properties": { "href": { "description": "Link to SAP profile resource", "type": "string" }, "profileID": { "description": "SAP Profile ID", "type": "string" } }, "required": [ "profileID", "href" ], "type": "object" }, "SAPProfiles": { "properties": { "profiles": { "description": "SAP Profiles", "items": { "$ref": "#/components/schemas/SAPProfile" }, "type": "array" } }, "required": [ "profiles" ], "type": "object" }, "SPPPlacementGroup": { "properties": { "id": { "description": "The id of the Shared Processor Pool Placement Group", "type": "string" }, "memberSharedProcessorPools": { "description": "The list of Shared Processor Pool names that are a member of the Shared Processor Pool Placement Group", "items": { "type": "string" }, "type": "array" }, "name": { "description": "The name of the Shared Processor Pool Placement Group", "type": "string" }, "policy": { "description": "The Shared Processor Pool Placement Group policy", "type": "string" } }, "required": [ "id", "name", "policy" ], "type": "object" }, "SPPPlacementGroupCreate": { "properties": { "name": { "description": "The name of the Shared Processor Pool Placement Group; minimum of 2 characters, maximum of 12, the only special character allowed is the underscore '_'.", "maxLength": 12, "minLength": 2, "pattern": "^[a-zA-Z0-9_]+$", "type": "string" }, "policy": { "description": "The placement group policy", "enum": [ "affinity", "anti-affinity" ], "type": "string" } }, "required": [ "name", "policy" ], "type": "object" }, "SPPPlacementGroups": { "properties": { "sppPlacementGroups": { "description": "list of Shared Processor Pool Placement Groups", "items": { "$ref": "#/components/schemas/SPPPlacementGroup" }, "type": "array" } }, "type": "object" }, "SRC": { "properties": { "src": { "description": "The SRC reference code", "type": "string" }, "timestamp": { "description": "The date stamp of the SRC", "type": "string" } }, "type": "object" }, "SSHKey": { "properties": { "creationDate": { "description": "Date of sshkey creation", "format": "date-time", "type": "string", "x-go-custom-tag": "datastore:\"creationDate\"", "x-isnullable": true }, "name": { "description": "User defined name for the SSH key", "type": "string", "x-go-custom-tag": "datastore:\"name\"" }, "sshKey": { "description": "SSH RSA key", "type": "string", "x-go-custom-tag": "datastore:\"sshKey\"" } }, "required": [ "name", "sshKey" ], "type": "object" }, "SSHKeys": { "properties": { "sshKeys": { "description": "SSH Keys", "items": { "$ref": "#/components/schemas/SSHKey" }, "type": "array" } }, "required": [ "sshKeys" ], "type": "object" }, "Secondary": { "description": "Information to create a secondary host group", "properties": { "name": { "description": "Name of the host group to create in the secondary workspace", "type": "string" }, "workspace": { "description": "ID of the workspace to share the host group with", "type": "string" } }, "required": [ "workspace" ], "type": "object" }, "SharedProcessorPool": { "properties": { "allocatedCores": { "description": "The amount of allocated processor cores for the Shared Processor Pool", "type": "number" }, "availableCores": { "description": "The amount of available processor cores for the Shared Processor Pool", "type": "number" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "dedicatedHostID": { "description": "ID of the dedicated host where the Shared Processor Pool resides, if applicable", "type": "string" }, "hostGroup": { "description": "The host group the host belongs to", "type": "string" }, "hostID": { "description": "The ID of the host where the Shared Processor Pool resides", "type": "integer" }, "id": { "description": "The id of the Shared Processor Pool", "type": "string" }, "name": { "description": "The name of the Shared Processor Pool", "type": "string" }, "reservedCores": { "description": "The amount of reserved processor cores for the Shared Processor Pool", "type": "integer" }, "sharedProcessorPoolPlacementGroups": { "description": "list of Shared Processor Pool Placement Groups", "items": { "$ref": "#/components/schemas/SharedProcessorPoolPlacementGroup" }, "type": "array" }, "status": { "description": "The status of the Shared Processor Pool", "type": "string" }, "statusDetail": { "description": "The status details of the Shared Processor Pool", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "id", "name", "reservedCores", "allocatedCores", "availableCores" ], "type": "object" }, "SharedProcessorPoolCreate": { "properties": { "hostGroup": { "description": "The host group; a host from the group will be automatically selected based on available resources", "type": "string" }, "hostID": { "description": "The host id of a host in a host group (only available for dedicated hosts)", "type": "string" }, "name": { "description": "The name of the Shared Processor Pool; minumum of 2 characters, maximum of 12, the only special character allowed is the underscore '_'.", "type": "string" }, "placementGroupID": { "description": "The ID of the placement group", "type": "string" }, "reservedCores": { "description": "The amount of reserved processor cores for the Shared Processor Pool; only integers allowed, no fractional values", "type": "integer", "nullable": true }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "hostGroup", "name", "reservedCores" ], "type": "object" }, "SharedProcessorPoolDetail": { "properties": { "servers": { "description": "list of servers deployed in the Shared Processor Pool", "items": { "$ref": "#/components/schemas/SharedProcessorPoolServer" }, "type": "array" }, "sharedProcessorPool": { "allOf": [ { "$ref": "#/components/schemas/SharedProcessorPool" }, { "type": "object" } ] } }, "required": [ "sharedProcessorPool", "servers" ], "type": "object" }, "SharedProcessorPoolPlacementGroup": { "properties": { "id": { "description": "The id of the Shared Processor Pool Placement Group", "type": "string" }, "name": { "description": "The name of the Shared Processor Pool Placement Group", "type": "string" }, "policy": { "description": "The Shared Processor Pool Placement Group policy", "type": "string" } }, "required": [ "id", "name", "policy" ], "type": "object" }, "SharedProcessorPoolServer": { "properties": { "Cpus": { "description": "The amount of cpus for the server", "type": "number" }, "Uncapped": { "description": "Identifies if uncapped or not", "type": "boolean" }, "availabilityZone": { "description": "Availability zone for the server", "type": "string" }, "id": { "description": "The server ID", "type": "string" }, "memory": { "description": "The amount of memory for the server", "type": "integer" }, "name": { "description": "The server name", "type": "string" }, "status": { "description": "Status of the server", "type": "string" }, "vcpus": { "description": "The amout of vcpus for the server", "type": "integer" } }, "type": "object" }, "SharedProcessorPoolUpdate": { "properties": { "name": { "description": "The new name for the Shared Processor Pool; minumum of 2 characters, maximum of 12, the only special character allowed is the underscore '_'.", "type": "string" }, "reservedCores": { "description": "The amount of reserved processor cores for the Shared Processor Pool; only integers allowed, no fractional values; the amount can be increased (dependent on available resources) or decreased (dependent on currently allocated resources)", "type": "integer", "nullable": true } }, "type": "object" }, "SharedProcessorPools": { "properties": { "sharedProcessorPools": { "description": "list of Shared Processor Pools", "items": { "$ref": "#/components/schemas/SharedProcessorPool" }, "type": "array" } }, "type": "object" }, "Site": { "properties": { "isActive": { "description": "true if location is active , otherwise it is false", "type": "boolean" }, "location": { "description": "regionZone of the location", "type": "string" } }, "type": "object" }, "Snapshot": { "properties": { "action": { "description": "Action performed on the instance snapshot", "type": "string" }, "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "description": { "description": "Description of the PVM instance snapshot", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "name": { "description": "Name of the PVM instance snapshot", "type": "string" }, "percentComplete": { "description": "Snapshot completion percentage", "type": "integer" }, "pvmInstanceID": { "description": "PCloud PVM Instance ID", "type": "string" }, "snapshotID": { "description": "ID of the PVM instance snapshot", "type": "string" }, "status": { "description": "Status of the PVM instance snapshot", "type": "string" }, "statusDetail": { "description": "Detailed information for the last PVM instance snapshot action", "type": "string" }, "volumeSnapshots": { "additionalProperties": { "description": "a volume snapshot ID", "type": "string" }, "description": "A map of volume snapshots included in the PVM instance snapshot", "type": "object" } }, "required": [ "snapshotID", "pvmInstanceID", "name", "volumeSnapshots" ], "type": "object" }, "SnapshotCreate": { "properties": { "description": { "description": "Description of the PVM instance snapshot", "type": "string" }, "name": { "description": "Name of the PVM instance snapshot to create", "maxLength": 120, "pattern": "^[a-zA-Z0-9_.-]+$", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumeIDs": { "description": "List of volumes to include in the PVM instance snapshot", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" }, "SnapshotCreateResponse": { "properties": { "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "snapshotID": { "description": "ID of the PVM instance snapshot", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "snapshotID" ], "type": "object" }, "SnapshotList": { "properties": { "snapshots": { "description": "The list of volume snapshots.", "items": { "$ref": "#/components/schemas/SnapshotV1" }, "type": "array" } }, "required": [ "snapshots" ], "type": "object" }, "SnapshotRestore": { "properties": { "force": { "default": false, "description": "By default the VM must be shutoff during a snapshot restore, force set to true will relax the VM shutoff pre-condition.", "type": "boolean" } }, "type": "object" }, "SnapshotUpdate": { "properties": { "description": { "description": "Description of the PVM instance snapshot", "type": "string" }, "name": { "description": "Name of the PVM instance snapshot", "maxLength": 120, "pattern": "^[a-zA-Z0-9_.-]+$", "type": "string" } }, "type": "object" }, "SnapshotV1": { "properties": { "creationDate": { "description": "The date and time when the volume snapshot was created.", "format": "date-time", "type": "string" }, "id": { "description": "The volume snapshot UUID.", "type": "string" }, "name": { "description": "The volume snapshot name.", "type": "string" }, "size": { "description": "The size of the volume snapshot, in gibibytes (GiB).", "type": "number" }, "status": { "description": "The status for the volume snapshot.", "type": "string" }, "updatedDate": { "description": "The date and time when the volume snapshot was last updated.", "format": "date-time", "type": "string" }, "volumeID": { "description": "The volume UUID associated with the snapshot.", "type": "string" } }, "required": [ "id", "name", "size", "status", "volumeID" ], "type": "object" }, "Snapshots": { "properties": { "snapshots": { "description": "List of PVM instance snapshots", "items": { "$ref": "#/components/schemas/Snapshot" }, "type": "array" } }, "required": [ "snapshots" ], "type": "object" }, "SoftwareLicenses": { "properties": { "ibmiCSS": { "default": false, "description": "IBMi Cloud Storage Solution", "type": "boolean" }, "ibmiDBQ": { "default": false, "description": "IBMi Cloud Storage Solution", "type": "boolean" }, "ibmiPHA": { "default": false, "description": "IBMi Power High Availability", "type": "boolean" }, "ibmiRDS": { "default": false, "description": "IBMi Rational Dev Studio", "type": "boolean" }, "ibmiRDSUsers": { "description": "IBMi Rational Dev Studio Number of User Licenses", "type": "integer", "x-omitempty": true } }, "type": "object" }, "Status": { "properties": { "message": { "description": "message detailing current state", "type": "string" }, "progress": { "description": "progress of a job", "type": "string" }, "state": { "description": "state of a job", "type": "string" } }, "required": [ "state", "progress" ], "type": "object" }, "StatusDescription": { "description": "Status details of the volume group", "properties": { "errors": { "description": "List of descriptive error messages.", "items": { "$ref": "#/components/schemas/StatusDescriptionError" }, "type": "array" } }, "type": "object" }, "StatusDescriptionError": { "description": "Error status details of a volume group", "properties": { "key": { "description": "Indicates the volume group error key", "type": "string" }, "message": { "description": "Failure message providing more details about the error key", "type": "string" }, "volIDs": { "description": "List of volume IDs, which failed to be added/removed to/from the volume-group, with the given error.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "StockImage": { "description": "Stock image detail", "properties": { "id": { "description": "Image ID", "type": "string" }, "storagePool": { "description": "Storage pool for a stock image", "type": "string" }, "storageType": { "description": "Storage type for a stock image", "type": "string" } }, "type": "object" }, "StockImages": { "description": "List of stock images", "items": { "$ref": "#/components/schemas/StockImage" }, "type": "array" }, "StorageAffinity": { "properties": { "affinityPVMInstance": { "description": "PVM Instance (ID or Name) to base storage affinity policy against; required if requesting storage affinity and affinityVolume is not provided", "type": "string", "x-isnullable": true }, "affinityPolicy": { "description": "Affinity policy for storage pool selection; ignored if storagePool provided; for policy 'affinity' requires one of affinityPVMInstance or affinityVolume to be specified; for policy 'anti-affinity' requires one of antiAffinityPVMInstances or antiAffinityVolumes to be specified", "enum": [ "affinity", "anti-affinity" ], "type": "string", "x-isnullable": true }, "affinityVolume": { "description": "Volume (ID or Name) to base storage affinity policy against; required if requesting storage affinity and affinityPVMInstance is not provided", "type": "string", "x-isnullable": true }, "antiAffinityPVMInstances": { "description": "List of pvmInstances to base storage anti-affinity policy against; required if requesting storage anti-affinity and antiAffinityVolumes is not provided", "items": { "description": "PVM Instance (ID or Name)", "type": "string" }, "type": "array" }, "antiAffinityVolumes": { "description": "List of volumes to base storage anti-affinity policy against; required if requesting storage anti-affinity and antiAffinityPVMInstances is not provided", "items": { "description": "Volume (ID or Name)", "type": "string" }, "type": "array" } }, "type": "object" }, "StorageController": { "description": "Description of a Storage Controller", "properties": { "displayName": { "description": "Display Name of the Storage Controller", "type": "string" }, "health": { "description": "Health status of this storage controller", "type": "string" }, "poolStorage": { "description": "Free storage in user pools on this storage controller (GB)", "type": "number" }, "poolTotalStorage": { "description": "Total storage capacity of user pools in this storage controller (GB)", "type": "number" }, "pools": { "additionalProperties": { "$ref": "#/components/schemas/StoragePoolCombined" }, "description": "List of storage pools within this storage controller", "type": "object" } }, "required": [ "displayName", "health", "poolStorage", "poolTotalStorage", "pools" ] }, "StorageControllers": { "additionalProperties": { "$ref": "#/components/schemas/StorageController" }, "description": "List of available storage controllers within a particular DataCenter", "type": "object" }, "StoragePoolCapacity": { "description": "Storage pool capacity", "properties": { "availableCapacity": { "description": "Available/Unused pool capacity (GB)", "type": "integer" }, "maxAllocationSize": { "description": "Maximum allocation storage size (GB)", "type": "integer" }, "poolName": { "description": "Pool name", "type": "string" }, "replicationEnabled": { "description": "true if storage-pool is replication enabled and can be used to manage replication enabled volumes", "type": "boolean", "x-isnullable": true }, "storageHost": { "description": "Storage host/controller for this storage pool", "type": "string" }, "storageType": { "description": "Storage type of the storage pool", "type": "string" }, "totalCapacity": { "description": "Total pool capacity (GB)", "type": "integer" } }, "required": [ "maxAllocationSize" ], "type": "object" }, "StoragePoolCombined": { "description": "Combined Storage Pool Capacity", "properties": { "poolName": { "description": "Pool name", "type": "string" }, "storage": { "description": "Available/Unused pool capacity (GB)", "type": "integer" }, "totalStorage": { "description": "Total pool capacity (GB)", "type": "integer" } }, "required": [ "storage", "totalStorage", "poolName" ], "type": "object" }, "StoragePoolMap": { "properties": { "remotePool": { "type": "string" }, "volumePool": { "type": "string" } }, "type": "object" }, "StoragePoolsCapacity": { "description": "Storage capacity for all storage pools", "properties": { "maximumStorageAllocation": { "allOf": [ { "$ref": "#/components/schemas/MaximumStorageAllocation" }, { "description": "maximum storage allocation", "type": "object" } ] }, "storagePoolsCapacity": { "items": { "$ref": "#/components/schemas/StoragePoolCapacity" }, "type": "array" } }, "type": "object" }, "StorageTier": { "description": "Storage tier detail", "properties": { "description": { "description": "Description, storage tier label", "type": "string" }, "name": { "description": "Name of the storage tier", "type": "string" }, "state": { "default": "active", "description": "State of the storage tier (active or inactive)", "enum": [ "active", "inactive" ], "type": "string" } }, "type": "object" }, "StorageTypeCapacity": { "description": "Storage type capacity", "properties": { "maximumStorageAllocation": { "allOf": [ { "$ref": "#/components/schemas/MaximumStorageAllocation" }, { "description": "maximum storage allocation", "type": "object" } ] }, "storagePoolsCapacity": { "description": "List of storage pool capacity for storage type", "items": { "$ref": "#/components/schemas/StoragePoolCapacity" }, "type": "array" }, "storageType": { "description": "Storage type", "type": "string" } }, "type": "object" }, "StorageTypesCapacity": { "description": "Storage types capacity", "properties": { "maximumStorageAllocation": { "allOf": [ { "$ref": "#/components/schemas/MaximumStorageAllocation" }, { "description": "maximum storage allocation", "type": "object" } ] }, "storageTypesCapacity": { "items": { "$ref": "#/components/schemas/StorageTypeCapacity" }, "type": "array" } }, "type": "object" }, "SupportedSystems": { "properties": { "dedicated": { "description": "List of all available dedicated host types", "items": { "type": "string" }, "type": "array" }, "general": { "description": "List of all available host types", "items": { "type": "string" }, "type": "array" } }, "required": [ "general", "dedicated" ], "type": "object" }, "System": { "properties": { "availableCores": { "description": "The host available Processor units", "type": "number" }, "availableMemory": { "description": "The host available RAM memory in GiB", "type": "integer" }, "cores": { "description": "The host available Processor units", "type": "number" }, "hostMTMSName": { "description": "The host MTMS name", "type": "string" }, "id": { "description": "The host identifier", "type": "integer" }, "memory": { "description": "The host total RAM memory in GiB", "type": "integer" }, "totalCores": { "description": "The host total usable Processor units", "type": "number" }, "totalMemory": { "description": "The host total usable RAM memory in GiB", "type": "integer" }, "totalPhysCores": { "description": "Total number of physical cores in the Pod", "type": "number" }, "totalPhysMemory": { "description": "Total amount of physical memory in the Pod (GB)", "type": "integer" } }, "required": [ "memory", "cores" ], "type": "object" }, "SystemPool": { "description": "Hardware platform detailing its limits and statistics", "properties": { "capacity": { "allOf": [ { "$ref": "#/components/schemas/System" }, { "description": "Advertised capacity cores and memory (GB)", "type": "object" } ] }, "coreIncrement": { "description": "Core allocation increment", "type": "number" }, "coreMemoryRatio": { "description": "Processor to Memory (GB) Ratio", "type": "number" }, "maxAvailable": { "allOf": [ { "$ref": "#/components/schemas/System" }, { "description": "Maximum configurable cores and memory (GB) (aggregated from all hosts)", "type": "object" } ] }, "maxCoresAvailable": { "allOf": [ { "$ref": "#/components/schemas/System" }, { "description": "Maximum configurable cores available combined with available memory of that host", "type": "object" } ] }, "maxMemoryAvailable": { "allOf": [ { "$ref": "#/components/schemas/System" }, { "description": "Maximum configurable memory available combined with available cores of that host", "type": "object" } ] }, "sharedCoreRatio": { "allOf": [ { "$ref": "#/components/schemas/MinMaxDefault" }, { "description": "min-max-default allocation percentage of shared core per vCPU", "type": "object" } ] }, "systems": { "description": "The DataCenter list of servers and their available resources", "items": { "$ref": "#/components/schemas/System" }, "type": "array" }, "type": { "description": "Type of system hardware", "type": "string" } }, "type": "object" }, "SystemPoolCapacity": { "description": "Description of a System Pool's Capacity", "properties": { "cores": { "description": "Number of available cores in the System Pool", "type": "number" }, "memory": { "description": "Amount of available memory in the System Pool (GB)", "type": "integer" }, "systems": { "description": "The DataCenter list of servers and their available resources", "items": { "$ref": "#/components/schemas/SystemResources" }, "type": "array" }, "totalCores": { "description": "Total number of cores in the System Pool", "type": "number" }, "totalMemory": { "description": "Total amount of memory in the System Pool (GB)", "type": "integer" }, "totalPhysCores": { "description": "Total number of physical cores in the Pod", "type": "number" }, "totalPhysMemory": { "description": "Total amount of physical memory in the Pod (GB)", "type": "integer" } }, "required": [ "cores", "totalCores", "memory", "totalMemory", "totalPhysCores", "totalPhysMemory" ] }, "SystemPools": { "additionalProperties": { "$ref": "#/components/schemas/SystemPool" }, "description": "List of available system pools within a particular DataCenter", "type": "object" }, "SystemPoolsCapacity": { "additionalProperties": { "$ref": "#/components/schemas/SystemPoolCapacity" }, "description": "List of available system pools within a Pod", "type": "object" }, "SystemResources": { "description": "Information about the resources that a single system contains", "properties": { "cores": { "description": "The host available Processor units", "type": "number" }, "hostMTMSName": { "description": "The host MTMS name", "type": "string" }, "id": { "description": "The host identifier", "type": "integer" }, "memory": { "description": "The host available RAM memory in GiB", "type": "integer" }, "totalCores": { "description": "The host total usable Processor units", "type": "number" }, "totalMemory": { "description": "The host total usable RAM memory in GiB", "type": "integer" }, "totalPhysCores": { "description": "Total number of physical cores in the Pod", "type": "number" }, "totalPhysMemory": { "description": "Total amount of physical memory in the Pod (GB)", "type": "integer" } }, "required": [ "id", "memory", "cores", "totalCores", "totalMemory", "totalPhysCores", "totalPhysMemory" ] }, "Tags": { "description": "List of user tags", "items": { "maxLength": 128, "pattern": "^[\\s]*[A-Za-z0-9:_.\\-][A-Za-z0-9\\s:_.\\-]*$", "type": "string" }, "maxItems": 100, "type": "array" }, "Task": { "properties": { "cloudInstanceID": { "description": "Cloud Instance ID of task owner", "type": "string" }, "componentID": { "description": "the component id of the task", "type": "string" }, "componentType": { "description": "the component type of the task", "type": "string" }, "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "operation": { "description": "Task Operation", "type": "string" }, "status": { "description": "status code of the task", "type": "string" }, "statusDetail": { "description": "status detail of the task", "type": "string" }, "taskID": { "description": "Pcloud Task ID", "type": "string" } }, "required": [ "taskID", "cloudInstanceID", "componentType", "componentID", "operation", "status", "statusDetail", "creationDate", "lastUpdateDate" ], "type": "object" }, "TaskReference": { "properties": { "href": { "description": "Link to Task resource", "type": "string" }, "taskID": { "description": "ID of Task used to get status of long running operation", "type": "string" } }, "required": [ "taskID", "href" ], "type": "object" }, "Tenant": { "properties": { "cloudInstances": { "description": "Cloud Instances owned by the Tenant", "items": { "$ref": "#/components/schemas/CloudInstanceReference" }, "type": "array" }, "creationDate": { "description": "Date of Tenant creation", "format": "date-time", "type": "string" }, "enabled": { "description": "Indicates if the tenant is enabled", "type": "boolean" }, "icn": { "description": "IBM Customer Number", "type": "string", "x-omitempty": true }, "peeringNetworks": { "description": "Peering Network Information (optional)", "items": { "$ref": "#/components/schemas/PeeringNetwork" }, "type": "array", "x-omitempty": true }, "sshKeys": { "description": "Tenant SSH Keys", "items": { "$ref": "#/components/schemas/SSHKey" }, "type": "array" }, "tenantID": { "description": "Tenant ID", "type": "string" } }, "required": [ "tenantID", "enabled", "creationDate", "cloudInstances" ], "type": "object" }, "TenantUpdate": { "properties": { "icn": { "description": "IBM Customer Number", "type": "string", "x-isnullable": true }, "peeringNetworks": { "description": "Peering Network Information (optional)", "items": { "$ref": "#/components/schemas/PeeringNetwork" }, "type": "array" } }, "type": "object" }, "UpdateServerVirtualSerialNumber": { "properties": { "description": { "description": "Description of the Virtual Serial Number", "type": "string", "x-isnullable": true } } }, "UpdateVirtualSerialNumber": { "properties": { "description": { "description": "Description of the Virtual Serial Number", "type": "string" } }, "required": [ "description" ] }, "UpdateVolume": { "properties": { "bootable": { "description": "Indicates if the volume is boot capable", "type": "boolean", "x-isnullable": true }, "name": { "description": "Name", "type": "string", "x-isnullable": true }, "shareable": { "description": "Indicates if the volume is shareable between VMs", "type": "boolean", "x-isnullable": true }, "size": { "description": "New Volume size", "type": "number" } }, "type": "object" }, "VPNConnection": { "properties": { "deadPeerDetection": { "$ref": "#/components/schemas/DeadPeerDetection" }, "id": { "description": "unique identifier for VPN Connection", "example": "123e4567-e89b-12d3-a456-42661475", "type": "string" }, "ikePolicy": { "$ref": "#/components/schemas/IKEPolicyRef" }, "ipSecPolicy": { "$ref": "#/components/schemas/IPSecPolicyRef" }, "localGatewayAddress": { "description": "local Gateway address, only in 'route' mode.", "example": "192.168.1.1", "type": "string" }, "mode": { "description": "Mode used by this VPNConnection, either policy-based, or route-based, this attribute is set at the creation and cannot be updated later.", "enum": [ "policy", "route" ], "example": "policy", "type": "string" }, "name": { "description": "VPN Connection name", "example": "VPN-Connection-1", "type": "string" }, "networkIDs": { "description": "an array of network IDs", "items": { "type": "string" }, "type": "array" }, "peerGatewayAddress": { "$ref": "#/components/schemas/PeerGatewayAddress" }, "peerSubnets": { "description": "an array of strings containing CIDR of peer subnets", "example": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27", "128.170.1.0/32" ], "items": { "type": "string" }, "type": "array" }, "status": { "description": "status of the VPN connection", "enum": [ "active", "warning", "disabled" ], "type": "string" }, "vpnGatewayAddress": { "description": "public IP address of the VPN Gateway (vSRX) attached to this VPNConnection", "example": "192.168.204.1", "type": "string" } }, "required": [ "deadPeerDetection", "id", "ikePolicy", "ipSecPolicy", "localGatewayAddress", "mode", "name", "networkIDs", "peerGatewayAddress", "peerSubnets", "status", "vpnGatewayAddress" ], "type": "object" }, "VPNConnectionCreate": { "properties": { "ikePolicy": { "description": "unique identifier of IKEPolicy selected for this VPNConnection", "example": "c36723ec-8593-11eb-8dcd-0242ac133853", "type": "string" }, "ipSecPolicy": { "description": "unique identifier of IPSecPolicy selected for this VPNConnection", "example": "c12345d-8593-11eb-8dcd-0242ac134573", "type": "string" }, "mode": { "description": "Mode used by this VPNConnection, either policy-based, or route-based, this attribute is set at the creation and cannot be updated later.", "enum": [ "policy", "route" ], "example": "policy", "type": "string" }, "name": { "description": "VPN Connection name", "example": "VPN-Connection-1", "type": "string" }, "networks": { "description": "an array of network IDs to attach to this VPNConnection", "example": [ "7f950c76-8582-11veb-8dcd-0242ac153", "7f950c76-8582-11veb-8dcd-0242ac144", "7f950c76-8582-11veb-8dcd-0242ac199" ], "items": { "type": "string" }, "type": "array" }, "peerGatewayAddress": { "$ref": "#/components/schemas/PeerGatewayAddress" }, "peerSubnets": { "description": "an array of strings containing CIDR of peer subnets", "example": [ "128.170.1.0/20", "128.169.1.0/24", "128.168.1.0/27", "128.170.1.0/32" ], "items": { "type": "string" }, "type": "array" } }, "required": [ "ikePolicy", "ipSecPolicy", "mode", "name", "networks", "peerGatewayAddress", "peerSubnets" ], "type": "object" }, "VPNConnectionCreateResponse": { "allOf": [ { "$ref": "#/components/schemas/VPNConnection" } ], "properties": { "jobRef": { "$ref": "#/components/schemas/JobReference" } } }, "VPNConnectionUpdate": { "additionalProperties": true, "description": "VPN Connection object to send during the update", "minProperties": 1, "properties": { "ikePolicy": { "description": "unique identifier of IKEPolicy selected for this VPNConnection", "example": "c36723ec-8593-11eb-8dcd-0242ac133853", "type": "string" }, "ipSecPolicy": { "description": "unique identifier of IPSecPolicy selected for this VPNConnection", "example": "c12345d-8593-11eb-8dcd-0242ac134573", "type": "string" }, "name": { "description": "VPN Connection name", "example": "VPN-Connection-1", "type": "string" }, "peerGatewayAddress": { "$ref": "#/components/schemas/PeerGatewayAddress" } }, "type": "object" }, "VPNConnections": { "properties": { "vpnConnections": { "description": "an array of VPN Connections", "example": [ { "deadPeerDetection": { "action": "restart", "interval": 10, "threshold": 5 }, "id": "123e4567-e89b-12d3-a456-42661475", "ikePolicy": { "id": "7654e321-e89b-12d3-a456-4566447", "name": "IKE Policy 3" }, "ipSecPolicy": { "id": "456f7890-e89b-12d3-a456-4569934", "name": "IPSec Policy 2" }, "localGatewayAddress": "192.168.1.1", "mode": "route", "name": "VPN Connection 2", "peerGatewayAddress": "192.168.44.1", "peerSubnets": [ "128.169.1.0/24", "128.168.1.0/27" ], "status": "Active", "vpnGatewayAddress": "192.168.24.1" } ], "items": { "$ref": "#/components/schemas/VPNConnection" }, "type": "array" } }, "type": "object" }, "VirtualCores": { "properties": { "assigned": { "description": "The active virtual Cores", "minimum": 1, "type": "integer" }, "max": { "description": "The maximum DLPAR range for virtual Cores (Display only support)", "type": "integer" }, "min": { "description": "The minimum DLPAR range for virtual Cores (Display only support)", "type": "integer" } }, "required": [ "assigned" ], "type": "object" }, "VirtualSerialNumber": { "properties": { "description": { "description": "Description of the Virtual Serial Number", "type": "string" }, "pvmInstanceID": { "description": "ID of the PVM Instance Virtual Serial Number is attached to.", "type": "string" }, "serial": { "description": "Virtual Serial Number assigned to the PVM Instance", "type": "string" } }, "required": [ "serial", "pvmInstanceID", "description" ] }, "VirtualSerialNumberList": { "description": "List of all Virtual Serial Numbers", "items": { "$ref": "#/components/schemas/VirtualSerialNumber" }, "type": "array" }, "Volume": { "properties": { "auxVolumeName": { "description": "Auxiliary volume name at storage host level", "type": "string" }, "auxiliary": { "description": "true if volume is auxiliary otherwise false", "type": "boolean", "x-isnullable": true }, "bootVolume": { "description": "Indicates if the volume is the server's boot volume. Only returned when querying a server's attached volumes", "type": "boolean", "x-isnullable": true }, "bootable": { "description": "Indicates if the volume is boot capable", "type": "boolean", "x-isnullable": true }, "consistencyGroupName": { "description": "Consistency Group Name if volume is a part of volume group", "type": "string" }, "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "diskType": { "description": "Type of Disk", "type": "string" }, "freezeTime": { "description": "Freeze time of remote copy relationship", "format": "date-time", "type": "string", "x-isnullable": true, "x-omitempty": true }, "groupID": { "description": "Volume Group ID", "type": "string" }, "ioThrottleRate": { "description": "Amount of iops assigned to the volume", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "masterVolumeName": { "description": "Master volume name at storage host level", "type": "string" }, "mirroringState": { "description": "Mirroring state for replication enabled volume", "type": "string" }, "name": { "description": "Volume Name", "type": "string" }, "outOfBandDeleted": { "description": "true if volume does not exist on storage controller, as volume has been deleted by deleting its paired volume from the mapped replication site.", "type": "boolean" }, "primaryRole": { "description": "indicates whether master/aux volume is playing the primary role", "enum": [ "master", "aux" ], "type": "string" }, "pvmInstanceIDs": { "description": "List of PCloud PVM Instance attached to the volume", "items": { "description": "PCloud PVM Instance ID", "type": "string" }, "type": "array" }, "replicationEnabled": { "description": "True if volume is replication enabled otherwise false", "type": "boolean", "x-isnullable": true }, "replicationStatus": { "description": "Replication status of a volume", "type": "string" }, "replicationType": { "description": "type of replication(metro,global)", "type": "string" }, "shareable": { "description": "Indicates if the volume is shareable between VMs", "type": "boolean", "x-isnullable": true }, "size": { "description": "Volume Size", "type": "number" }, "state": { "description": "Volume State", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumeID": { "description": "Volume ID", "type": "string" }, "volumePool": { "description": "Volume pool, name of storage pool where the volume is located", "type": "string" }, "volumeType": { "description": "Volume type, name of storage template used to create the volume", "type": "string" }, "wwn": { "description": "Volume world wide name", "type": "string" } }, "required": [ "volumeID", "name", "size", "creationDate", "lastUpdateDate" ], "type": "object" }, "VolumeAction": { "properties": { "replicationEnabled": { "description": "Indicates if the volume should be replication enabled or not", "type": "boolean", "x-isnullable": true }, "targetStorageTier": { "description": "Target storage tier; used to change a volume's storage tier", "type": "string", "x-isnullable": true } }, "type": "object" }, "VolumeGroup": { "properties": { "auxiliary": { "description": "Indicates whether the volume group is for auxiliary volumes or master volumes", "type": "boolean", "x-isnullable": true }, "consistencyGroupName": { "description": "The name of consistencyGroup at storage host level", "type": "string" }, "id": { "description": "The ID of the volume group", "type": "string" }, "name": { "description": "The name of the volume group", "type": "string" }, "replicationSites": { "description": "Indicates the replication site of the volume group", "items": { "description": "Replication site", "type": "string" }, "type": "array" }, "replicationStatus": { "description": "Replication status of volume group", "type": "string" }, "status": { "description": "Status of the volume group", "type": "string" }, "statusDescription": { "allOf": [ { "$ref": "#/components/schemas/StatusDescription" }, { "description": "Status details of the volume group" } ] }, "storagePool": { "description": "Indicates the storage pool of the volume group", "type": "string" } }, "required": [ "id", "name" ], "type": "object" }, "VolumeGroupAction": { "additionalProperties": true, "description": "Performs an action (start stop reset ) on a volume group(one at a time).", "maxProperties": 1, "minProperties": 1, "properties": { "reset": { "$ref": "#/components/schemas/VolumeGroupActionReset" }, "start": { "$ref": "#/components/schemas/VolumeGroupActionStart" }, "stop": { "$ref": "#/components/schemas/VolumeGroupActionStop" } }, "type": "object" }, "VolumeGroupActionReset": { "description": "Performs reset action on the volume group to update its status value", "properties": { "status": { "default": "available", "description": "New status to be set for a volume group", "enum": [ "available" ], "type": "string" } }, "required": [ "status" ], "type": "object" }, "VolumeGroupActionStart": { "description": "Performs start action on a volume group", "properties": { "source": { "default": "master", "description": "Indicates the source of the action", "enum": [ "master", "aux" ], "type": "string" } }, "required": [ "source" ], "type": "object" }, "VolumeGroupActionStop": { "description": "Performs stop action on a volume group", "properties": { "access": { "description": "Indicates the access mode of aux volumes", "type": "boolean" } }, "required": [ "access" ], "type": "object" }, "VolumeGroupCreate": { "properties": { "consistencyGroupName": { "description": "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.", "type": "string" }, "name": { "description": "The name of the volume group. This field is required for creation of new volume group; name and consistencyGroupName are mutually exclusive.", "maxLength": 120, "pattern": "^[\\s]*[A-Za-z0-9:_.\\-][A-Za-z0-9\\s:_.\\-]*$", "type": "string" }, "volumeIDs": { "description": "List of volume IDs,members of VolumeGroup", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "volumeIDs" ], "type": "object" }, "VolumeGroupCreateResponse": { "properties": { "id": { "description": "The ID of the volume group", "type": "string" }, "name": { "description": "The name of the volume group", "type": "string" }, "status": { "description": "Status of the volume group", "type": "string" }, "statusDetail": { "description": "Status details of the volume group", "type": "string" } }, "required": [ "id", "name", "status" ], "type": "object" }, "VolumeGroupDetails": { "properties": { "auxiliary": { "description": "Indicates whether the volume group is for auxiliary volumes or master volumes", "type": "boolean", "x-isnullable": true }, "consistencyGroupName": { "description": "The name of volume group at storage host level", "type": "string" }, "id": { "description": "The ID of the volume group", "type": "string" }, "name": { "description": "The name of the volume group", "type": "string" }, "replicationSites": { "description": "Indicates the replication site of the volume group", "items": { "description": "Replication site", "type": "string" }, "type": "array" }, "replicationStatus": { "description": "Replication status of volume group", "type": "string" }, "status": { "description": "Status of the volume group", "type": "string" }, "statusDescription": { "allOf": [ { "$ref": "#/components/schemas/StatusDescription" }, { "description": "Status details of the volume group" } ] }, "storagePool": { "description": "Indicates the storage pool of the volume group", "type": "string" }, "volumeIDs": { "description": "List of volume IDs,member of VolumeGroup", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "id", "name" ], "type": "object" }, "VolumeGroupRemoteCopyRelationships": { "properties": { "id": { "description": "The ID of the volume group", "type": "string" }, "remoteCopyRelationships": { "description": "List of remote copy relationships", "items": { "$ref": "#/components/schemas/RemoteCopyRelationship" }, "type": "array" } }, "type": "object" }, "VolumeGroupStorageDetails": { "properties": { "consistencyGroupName": { "description": "The name of consistency group at storage controller level", "type": "string" }, "cyclePeriodSeconds": { "description": "Indicates the minimum period in seconds between multiple cycles", "type": "integer" }, "cyclingMode": { "description": "Indicates the type of cycling mode used", "type": "string" }, "numOfvols": { "description": "Number of volumes in volume group", "type": "integer" }, "primaryRole": { "description": "Indicates whether master/aux volume is playing the primary role", "type": "string" }, "remoteCopyRelationshipNames": { "description": "List of remote-copy relationship names in a volume group", "items": { "description": "Indicates remote-copy relationship name", "type": "string" }, "type": "array" }, "replicationType": { "description": "Type of replication(metro,global)", "type": "string" }, "state": { "description": "Indicates the relationship state", "type": "string" }, "sync": { "description": "Indicates whether the relationship is synchronized", "type": "string" } }, "required": [ "consistencyGroupName" ], "type": "object" }, "VolumeGroupUpdate": { "properties": { "addVolumes": { "description": "List of volume IDs to add to the volume-group", "items": { "description": "Volume ID", "type": "string" }, "type": "array" }, "removeVolumes": { "description": "List of volume IDs to remove from the volume-group", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "type": "object" }, "VolumeGroups": { "properties": { "volumeGroups": { "description": "The list of volume groups", "items": { "$ref": "#/components/schemas/VolumeGroup" }, "type": "array" } }, "required": [ "volumeGroups" ], "type": "object" }, "VolumeGroupsDetails": { "properties": { "volumeGroups": { "description": "The list of volume groups with details", "items": { "$ref": "#/components/schemas/VolumeGroupDetails" }, "type": "array" } }, "required": [ "volumeGroups" ], "type": "object" }, "VolumeInfo": { "properties": { "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "name": { "description": "Name of the volume", "type": "string" }, "volumeID": { "description": "ID of the volume", "type": "string" } }, "type": "object" }, "VolumeOnboarding": { "allOf": [ { "$ref": "#/components/schemas/VolumeOnboardingCommon" } ], "properties": { "creationTimestamp": { "description": "Indicates the create-time of volume onboarding operation", "format": "date-time", "type": "string" }, "progress": { "description": "Indicates the progress of volume onboarding operation", "type": "number" }, "results": { "properties": { "onboardedVolumes": { "description": "List of volumes which are onboarded successfully", "items": { "type": "string" }, "type": "array" }, "volumeOnboardingFailures": { "items": { "allOf": [ { "$ref": "#/components/schemas/VolumeOnboardingFailure" }, { "type": "object" } ] }, "type": "array" } }, "type": "object" } }, "type": "object" }, "VolumeOnboardingCommon": { "properties": { "description": { "description": "Description of the volume onboarding operation", "type": "string" }, "id": { "description": "Indicates the volume onboarding operation id", "type": "string" }, "inputVolumes": { "description": "List of volumes requested to be onboarded", "items": { "type": "string" }, "type": "array" }, "status": { "description": "Indicates the status of volume onboarding operation", "type": "string" } }, "required": [ "id" ], "type": "object" }, "VolumeOnboardingCreate": { "properties": { "Volumes": { "items": { "allOf": [ { "$ref": "#/components/schemas/AuxiliaryVolumesForOnboarding" }, { "type": "object" } ] }, "type": "array" }, "description": { "description": "Description of the volume onboarding operation", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "Volumes" ], "type": "object" }, "VolumeOnboardingCreateResponse": { "properties": { "description": { "description": "Description of the volume onboarding operation", "type": "string" }, "id": { "description": "Indicates the volume onboarding operation id", "type": "string" } }, "type": "object" }, "VolumeOnboardingFailure": { "properties": { "failureMessage": { "description": "The failure reason for the volumes which have failed to be onboarded", "type": "string" }, "volumes": { "description": "List of volumes which have failed to be onboarded", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "VolumeOnboardings": { "properties": { "onboardings": { "description": "The list of volume onboardings", "items": { "$ref": "#/components/schemas/VolumeOnboardingCommon" }, "type": "array" } }, "required": [ "onboardings" ], "type": "object" }, "VolumeReference": { "properties": { "auxVolumeName": { "description": "Auxiliary volume name at storage host level", "type": "string" }, "auxiliary": { "description": "true if volume is auxiliary otherwise false", "type": "boolean", "x-isnullable": true }, "bootVolume": { "description": "Indicates if the volume is the server's boot volume. Only returned when querying a server's attached volumes", "type": "boolean", "x-isnullable": true }, "bootable": { "description": "Indicates if the volume is boot capable", "type": "boolean", "x-isnullable": true }, "consistencyGroupName": { "description": "Consistency Group Name if volume is a part of volume group", "type": "string" }, "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "crn": { "allOf": [ { "$ref": "#/components/schemas/CRN" }, { "x-omitempty": true } ] }, "deleteOnTermination": { "description": "Indicates if the volume should be deleted when the server terminates. Only returned when querying a server's attached volumes", "type": "boolean", "x-isnullable": true }, "diskType": { "description": "Type of Disk", "type": "string" }, "freezeTime": { "description": "Freeze time of remote copy relationship", "format": "date-time", "type": "string", "x-isnullable": true, "x-omitempty": true }, "groupID": { "description": "Volume Group ID", "type": "string" }, "href": { "description": "Link to Volume resource", "type": "string" }, "ioThrottleRate": { "description": "Amount of iops assigned to the volume", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "masterVolumeName": { "description": "Master volume name at storage host level", "type": "string" }, "mirroringState": { "description": "mirroring state for replication enabled volume", "type": "string" }, "name": { "description": "Volume Name", "type": "string" }, "outOfBandDeleted": { "description": "true if volume does not exist on storage controller, as volume has been deleted by deleting its paired volume from the mapped replication site.", "type": "boolean" }, "primaryRole": { "description": "indicates whether master/aux volume is playing the primary role", "enum": [ "master", "aux" ], "type": "string" }, "pvmInstanceIDs": { "description": "List of PCloud PVM Instance attached to the volume", "items": { "description": "PCloud PVM Instance ID", "type": "string" }, "type": "array" }, "replicationEnabled": { "description": "True if volume is replication enabled otherwise false", "type": "boolean", "x-isnullable": true }, "replicationStatus": { "description": "shows the replication status of a volume", "type": "string" }, "replicationType": { "description": "type of replication(metro, global)s", "type": "string" }, "shareable": { "description": "Indicates if the volume is shareable between VMs", "type": "boolean", "x-isnullable": true }, "size": { "description": "Volume Size", "type": "number" }, "state": { "description": "Volume State", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumeID": { "description": "Volume ID", "type": "string" }, "volumePool": { "description": "Volume pool, name of storage pool where the volume is located", "type": "string" }, "volumeType": { "description": "Volume type, name of storage template used to create the volume", "type": "string" }, "wwn": { "description": "Volume world wide name", "type": "string" } }, "required": [ "volumeID", "name", "state", "size", "shareable", "bootable", "wwn", "diskType", "href", "creationDate", "lastUpdateDate" ], "type": "object" }, "VolumeRemoteCopyRelationship": { "allOf": [ { "$ref": "#/components/schemas/RemoteCopyRelationship" } ], "properties": { "cyclePeriodSeconds": { "description": "Indicates the minimum period in seconds between multiple cycles", "type": "integer" }, "id": { "description": "Volume ID", "type": "string" } }, "type": "object" }, "VolumeSnapshotList": { "properties": { "volumeSnapshots": { "description": "The list of volume snapshots.", "items": { "$ref": "#/components/schemas/SnapshotV1" }, "type": "array" } } }, "Volumes": { "properties": { "volumes": { "description": "Volumes", "items": { "$ref": "#/components/schemas/VolumeReference" }, "type": "array" } }, "required": [ "volumes" ], "type": "object" }, "VolumesAttachmentResponse": { "properties": { "summary": { "description": "status summary for volume attachment to a PVM Instance", "type": "string" } }, "required": [ "summary" ], "type": "object" }, "VolumesClone": { "properties": { "action": { "description": "Current action performed for the volumes-clone request", "type": "string" }, "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "failureMessage": { "description": "Failure reason for a failed volumes-clone request", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "name": { "description": "Name assigned to a volumes-clone request", "type": "string" }, "percentComplete": { "description": "The percent completion for the current action", "type": "integer" }, "status": { "description": "Current status of the volumes-clone request", "type": "string" }, "volumesCloneID": { "description": "ID assigned to a volumes-clone request", "type": "string" } }, "required": [ "percentComplete" ], "type": "object" }, "VolumesCloneAsyncRequest": { "properties": { "name": { "description": "Base name of the new cloned volume(s).\nCloned Volume names will be prefixed with 'clone-'\n and suffixed with '-#####' (where ##### is a 5 digit random number)\nIf multiple volumes cloned they will be further suffixed with an incremental number starting with 1.\n Example volume names using name=\"volume-abcdef\"\n single volume clone will be named \"clone-volume-abcdef-83081\"\n multi volume clone will be named \"clone-volume-abcdef-73721-1\", \"clone-volume-abcdef-73721-2\", ...\nFor multiple volume clone, the provided name will be truncated to the first 20 characters.\n", "type": "string" }, "targetReplicationEnabled": { "description": "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.", "type": "boolean", "x-isnullable": true }, "targetStorageTier": { "description": "Target storage tier for the cloned volumes. Use to clone a set of volumes from one storage tier\nto a different storage tier. Cloned volumes must remain in the same storage pool as\nthe source volumes.\n", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] }, "volumeIDs": { "description": "List of volumes to be cloned", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "name", "volumeIDs" ], "type": "object" }, "VolumesCloneCancel": { "properties": { "force": { "description": "default False, Cancel will only be allowed if the status is 'prepared', or 'available'\nTrue, Cancel will be allowed when the status is NOT completed, cancelling, cancelled, or failed\n", "type": "boolean" } }, "type": "object" }, "VolumesCloneCreate": { "properties": { "name": { "description": "Unique name within a cloud instance used to identify a volumes-clone request\nname can be used in replace of a volumesCloneID when used as a URL path parameter\n", "type": "string" }, "volumeIDs": { "description": "List of volumes to be cloned", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "name", "volumeIDs" ], "type": "object" }, "VolumesCloneDetail": { "properties": { "action": { "description": "Current action performed for the volumes-clone request", "type": "string" }, "clonedVolumes": { "description": "List of cloned volumes created from the volumes-clone request", "items": { "$ref": "#/components/schemas/ClonedVolumeDetail" }, "type": "array" }, "creationDate": { "description": "Creation Date", "format": "date-time", "type": "string" }, "failureMessage": { "description": "Failure reason for a failed volumes-clone request", "type": "string" }, "lastUpdateDate": { "description": "Last Update Date", "format": "date-time", "type": "string" }, "name": { "description": "Name assigned to a volumes-clone request", "type": "string" }, "percentComplete": { "description": "The percent completion for the current action", "type": "integer" }, "status": { "description": "Current status of the volumes-clone request", "type": "string" }, "volumesCloneID": { "description": "ID assigned to a volumes-clone request", "type": "string" } }, "required": [ "percentComplete" ], "type": "object" }, "VolumesCloneExecute": { "properties": { "name": { "description": "Base name of the new cloned volume(s).\nCloned Volume names will be prefixed with 'clone-'\n and suffixed with '-#####' (where ##### is a 5 digit random number)\nIf multiple volumes cloned they will be further suffixed with an incremental number starting with 1.\n Example volume names using name=\"volume-abcdef\"\n single volume clone will be named \"clone-volume-abcdef-83081\"\n multi volume clone will be named \"clone-volume-abcdef-73721-1\", \"clone-volume-abcdef-73721-2\", ...\nFor multiple volume clone, the provided name will be truncated to the first 20 characters.\n", "type": "string" }, "rollbackPrepare": { "description": "default False, Execute failure rolls back clone activity but leaves prepared snapshot\nTrue, Execute failure rolls back clone activity and removes the prepared snapshot\n", "type": "boolean" }, "targetReplicationEnabled": { "description": "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.", "type": "boolean", "x-isnullable": true }, "targetStorageTier": { "description": "Target storage tier for the cloned volumes. Use to clone a set of volumes from one storage tier\nto a different storage tier. Cloned volumes must remain in the same storage pool as\nthe source volumes.\n", "type": "string" }, "userTags": { "allOf": [ { "$ref": "#/components/schemas/Tags" }, { "x-omitempty": true } ] } }, "required": [ "name" ], "type": "object" }, "VolumesCloneRequest": { "properties": { "displayName": { "description": "Display name for the new cloned volumes.\nCloned Volume names will be prefixed with 'clone-'.\nIf multiple volumes cloned they will be suffix with a '-' and an incremental number starting with 1.\n Example volume names using displayName=\"volume-abcdef\"\n single volume clone will be named \"clone-volume-abcdef\"\n multi volume clone will be named \"clone-volume-abcdef-1\", \"clone-volume-abcdef-2\", ...\nFor multiple volume clone, the provided name will be truncated to the first 20 characters.\n", "type": "string" }, "volumeIDs": { "description": "List of volumes to be cloned", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "displayName", "volumeIDs" ], "type": "object" }, "VolumesCloneResponse": { "properties": { "additionalProperties": { "description": "ID of the new cloned volume", "type": "string" }, "clonedVolumes": { "description": "A map of volume IDs to cloned volume IDs", "type": "object" } }, "type": "object" }, "VolumesClones": { "properties": { "volumesClone": { "description": "list of volumes-clone requests", "items": { "$ref": "#/components/schemas/VolumesClone" }, "type": "array" } }, "type": "object" }, "VolumesDelete": { "properties": { "volumeIDs": { "description": "List of volumes to be deleted", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "volumeIDs" ], "type": "object" }, "VolumesDeleteResponse": { "properties": { "summary": { "description": "status summary for volumes deletion request", "type": "string" } }, "type": "object" }, "VolumesDetachmentResponse": { "properties": { "summary": { "description": "status summary for volume detachment from a PVM Instance", "type": "string" } }, "required": [ "summary" ], "type": "object" }, "Workspace": { "properties": { "capabilities": { "additionalProperties": { "type": "boolean" }, "description": "Workspace Capabilities", "type": "object" }, "details": { "allOf": [ { "$ref": "#/components/schemas/WorkspaceDetails" }, { "description": "The Workspace information" } ] }, "id": { "description": "Workspace ID", "type": "string" }, "location": { "allOf": [ { "$ref": "#/components/schemas/WorkspaceLocation" }, { "description": "The Workspace location" } ] }, "name": { "description": "The Workspace name", "type": "string" }, "status": { "description": "The Workspace status", "type": "string" }, "type": { "description": "The Workspace type", "enum": [ "off-premises", "on-premises" ], "type": "string" } }, "required": [ "capabilities", "details", "id", "location", "name", "type", "status" ], "type": "object" }, "WorkspaceDetails": { "properties": { "creationDate": { "description": "Workspace creation date", "format": "date-time", "type": "string" }, "crn": { "description": "The Workspace crn", "type": "string" }, "href": { "description": "Link to Workspace Resource", "type": "string" }, "networkSecurityGroups": { "allOf": [ { "$ref": "#/components/schemas/WorkspaceNetworkSecurityGroupsDetails" }, { "description": "The Workspace Network Security Groups information", "x-omitempty": true } ] }, "powerEdgeRouter": { "allOf": [ { "$ref": "#/components/schemas/WorkspacePowerEdgeRouterDetails" }, { "description": "The Workspace Power Edge Router information", "x-omitempty": true } ] } }, "required": [ "creationDate", "crn" ], "type": "object" }, "WorkspaceLocation": { "properties": { "region": { "description": "The Workspace location region zone", "type": "string" }, "type": { "description": "The Workspace location region type", "type": "string" }, "url": { "description": "The Workspace location region url", "type": "string" } }, "required": [ "region" ], "type": "object" }, "WorkspaceNetworkSecurityGroupsDetails": { "properties": { "state": { "description": "The state of a Network Security Groups configuration", "enum": [ "active", "error", "configuring", "removing", "inactive", "inaccessible" ], "type": "string" } }, "required": [ "state" ], "type": "object" }, "WorkspacePowerEdgeRouterDetails": { "properties": { "migrationStatus": { "description": "The migration status of a Power Edge Router", "enum": [ "intializing", "migrating", "deleted", "completed" ], "type": "string", "x-omitempty": true }, "state": { "description": "The state of a Power Edge Router", "enum": [ "active", "error", "warning", "configuring", "removing", "inactive", "user-validation", "inaccessible" ], "type": "string" }, "type": { "description": "The Power Edge Router type", "enum": [ "automated", "manual" ], "type": "string" } }, "required": [ "state", "type" ], "type": "object" }, "Workspaces": { "properties": { "workspaces": { "description": "The list of available workspaces", "items": { "$ref": "#/components/schemas/Workspace" }, "type": "array" } }, "required": [ "workspaces" ], "type": "object" }, "volumesAttach": { "properties": { "volumeIDs": { "description": "List of volumes to be attached to a PVM instance", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "required": [ "volumeIDs" ], "type": "object" }, "volumesDetach": { "properties": { "detachAllVolumes": { "default": false, "description": "Indicates if all volumes, except primary boot volume, attached to the PVMInstance should be detached (default=false); required if volumeIDs is not provided", "type": "boolean" }, "detachPrimaryBootVolume": { "default": false, "description": "Indicates if primary boot volume attached to the PVMInstance should be detached (default=false)", "type": "boolean" }, "volumeIDs": { "description": "List of volumes to be detached from a PVM instance; required if detachAllVolumes is not provided", "items": { "description": "Volume ID", "type": "string" }, "type": "array" } }, "type": "object" } } } }