Loading...
REST API

General

Login

Example Request:

POST https://cloud.ravellosystems.com/api/v1/login

Example Response:

{
    "activated": true,
    "email": "ravello@ravello.com",
    "enabled": true,
    "id": 8,
    "invitationTime": 1398755048359,
    "name": "Ravello admin",
    "organization": 8,
    "roles": ["ADMIN", "USER"],
    "surname": "Ravello admin",
    "uuid": "Admin_b74f4d59-c743-4792-8da5-9bc858921eb6"
}
 Show full example

Login with username and password (basic authorization) to access the Ravello API.

HTTP Request

POST /login

Parameters

An Oracle Ravello account may belong to an identity domain. When using Basic Authentication, the identity domain, if exists, should be added to the username, seperated by “/”: <identity domain>/<username>

Response

Status Code Description
200 OK The logged-in user details
401 Unauthorized When the password/username is not correct

Logout

Example Request:

POST https://cloud.ravellosystems.com/api/v1/logout

Logs out of the system.

HTTP Request

POST /logout

Parameters

No parameters required.

Response

Status Code Description
204 No Content Successfully logged out.

Applications

Get Applications List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications

Example Response:

[
    {  
        "id":1310724,
        "name":"ExampleApp",
        "owner":"Ravello admin Ravello admin",
        "ownerDetails":{  
            "userId":32775,
            "name":"Ravello admin Ravello admin",
            "deleted":false
        },
        },res
        "creationTime":1482680702049,
        "usingNewNetwork":true,
        "design":{},
        "costBucket":{  
            "id":8,
            "creationTime":1482423197782,
            "name":"Organization",
            "deleted":false
        },
        "designDiffersFromDeployment":false,
        "published":false,
        "version":12
    },
    {
        "creationTime": 1398774926540,
        "deployment": {
            "expirationTime": 1398782139110,
            "publishOptimization": "COST_OPTIMIZED",
            "publishStartTime": 1398774938893,
            "totalActiveVms": 2,
            "cloudRegion": {
                "name": "us-central-1",
                "displayName": "US Central 1",
                "deprecated": false
            }
        },
        "design": {},
        "designDiffersFromDeployment": false,
        "id": 360452,
        "name": "App2",
        "owner": "Ravello admin Ravello admin",
        "published": true,
        "version": 3
    },
    {
        "creationTime": 1398774942067,
        "deployment": {
            "expirationTime": 1398782149537,
            "publishOptimization": "PERFORMANCE_OPTIMIZED",
            "publishStartTime": 1398774949307,
            "totalActiveVms": 1,
            "cloudRegion": {
                "name": "us-east-1",
                "displayName": "US East 1",
                "deprecated": false
            }
        },
        "design": {},
        "designDiffersFromDeployment": false,
        "id": 360453,
        "name": "App3",
        "owner": "Ravello admin Ravello admin",
        "published": true,
        "version": 3
    }
]
 Show full example

Returns a list of all the application under the authenticated user’s organization. The returned list doesn’t contain the full application, but only a general description of their properties. Use GET /applications/:id to get the full data for a specific application.

HTTP Request

GET /applications

Parameters

No parameters needed.

Response

Status Code Description
200 OK List of application descriptions

Get Application

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Returns the full application data, including the application properties, list of VMs, the application network, and so on. The application has two aspects: the design and the deployment. The design describes the saved application and all the user’s changes. The deployment describes the application on the cloud, exactly as it was when it was last published. You can see the difference between the design and deployment by comparing, for example, two VMs with the same ID. There could be more changes in the network and other properties.

Note: If the application has not been published, there is not deployment information.

There are additional ways to execute this call:

GET /applications/:id;design - returns the application with only the design aspect

GET /applications/:id;deployment - returns the application with only the deployment aspect

GET /applications/:id;properties - returns the application with only the properties aspect

HTTP Request

GET /applications/:id [;deployment or ;design or ;properties]

Parameters

Parameter Required Description
id yes The ID of the application

Response

Status Code Description
200 OK Full application
404 Not Found When the specified ID does not exist

Create Application

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/
{
    "name": "MyApp",
    "description" : "My Application Description",
    "baseBlueprintId": 51904660,
    "costBucket": {
        "id": 32772
    }
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name": "MyApp",
    "description" : "My Application Description",
    "baseBlueprintId": 51904660,
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new application, using the given template from the user. It is possible to create empty applications, meant for adding more VMs later, using PUT /applications/:id. Alternatively, users can create a new application from blueprint, by specifying blueprintId in the request. See more information about building an application in the Building an Application section.

HTTP Request

POST /applications

Parameters

Parameter Required Description
name yes The name of the new application
description no A description of the new application
baseBlueprintId no Specify this parameter to create a new application from an existing blueprint.
design yes The wrapping object for all the design properties of the application, including the virtual machines, network and more.
vms no A list of the virtual machines in the application design. See Building an Application to read more about application VMs.
network no The application designed network - includes the subnet, routers, and more. Generally the user does not need to construct this object as it being built automatically after every change. See Building an Application to read more about the application network.
vmOrderGroups no Contains application groups to sequence the starting/stopping of VMs. See Building an Application to read more about this feature.
costBucket no A structure containing the cost bucket ID for this application. If no ID is specified, the organization cost bucket is used, provided the user has EXECUTE permissions on this bucket.

Response

Status Code Description
201 Created The full application created
400 Bad Request When there is an error with the creation parameters or when the application name is not unique.
403 Forbidden When the user has no EXECUTE permission on the cost bucket, or if the cost bucket doesn’t exist
404 Not Found When the given blueprint id (if given) does not exist.

Update Application

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/34045955
{  
    "id":1310724,
    "name":"MyUpdatedApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"MyUpdatedApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates the application data and properties. The update here is full update, meaning the application will be replaced (elegantly) according to the given application object, i.e., one cannot handle a request as a partial application, because that would simply delete the missing part from the actual application. Example: if the method gets an empty list of VMs, it will delete all the VMs from the application.

HTTP Request

PUT /applications/:id

Parameters

Parameter Required Description
id yes The ID of the application.
name yes The name of the application.
description no A description of the application.
blueprintId no Specify this parameter to create a new application from an existing blueprint.
design yes The wrapping object for all the design properties of the application, including the virtual machines, network and more.
vms no A list of the virtual machines in the application design. See Building an Application to read more about application VMs.
network no The application designed network - includes the subnet, routers, and more. Generally the user does not need to construct this object as it being built automatically after every change. See Building an Application to read more about the application network.
vmOrderGroups no Contains application groups to sequence the starting/stopping of VMs. See Building an Application to read more about this feature.

Response

Status Code Description
200 OK Full application
400 Bad Request When there is some error with the request parameters.
404 Not Found When the specified ID does not exist.

Delete Application

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/34045955

Deletes the application and releases all the resources associated with it. The application cannot be restored, the deletion is permanent - all data on the machines is lost.

HTTP Request

DELETE /applications/:id

Parameters

Parameter Required Description
id yes The ID of the application.

Response

Status Code Description
204 No Content The application was deleted successfully.
404 Not Found When the specified ID does not exist.

Publish Application

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/34045955/publish
{
    "preferredRegion": "us-central-1",
    "optimizationLevel": "PERFORMANCE_OPTIMIZED",
    "startAllVms": "true"
}
 Show full example

Publish the design to the cloud.

HTTP Request

POST /applications/:id/publish

Parameters

Parameter Required Description
id yes The ID of the application.
optimizationLevel yes Specify this property to control the optimization of the application deployment. Must be: COST_OPTIMIZED or PERFORMANCE_OPTIMIZED.
preferredRegion * The preferred region on the cloud in which the application will be deployed.
startAllVms no Set this property to False to publish VMs without starting them. The default value is True.

Response

Status Code Description
202 Accepted The server is processing the request.
400 Bad Request When the application is already published, Invalid design, or invalid preferred region.
403 Forbidden When the quota or time-lease have exceeded
404 Not Found When the specified ID does not exist.

Execute Application Action

Example Request - Starting all VMs in the application:

POST https://cloud.ravellosystems.com/api/v1/applications/34045955/start

Example Request - Publish updates for the application, do not start VMs:

https://cloud.ravellosystems.com/api/v1/applications/34045955/publishUpdates?startAllDraftVms=false

Example Response:

{
    "completedSuccessfuly": "true",
    "operationMessages": [{
        "vmId": "2",
        "errorLevel": "INFO/ERROR/WARN",
        "message": "Vm is in the middle of another action"
    } ]
}
 Show full example

Performs an action on a published application.

HTTP Request

POST /applications/:id/:action

Possible Actions

Action Description
» publishUpdates Updates the cloud according to the current application data.
When the application is changed and saved, its cloud status remains the same as it was at the last publish. For the changes to take effect, you must publish the updates. The correct flow is to first update the application using PUT /applications/:id, and then use publishUpdates to update the application on the cloud.
» start Starts all the application VMs. VMs that are already started arel not affected.
» stop Stops all the application VMs. Stops only the published VMs (does not affect the stopped ones).
» restart Restarts all the application VMs.
» resetDisks Resets each of the VM disks to its most recent applicable state: its state in the library, its state when it was last stopped, or its state when it was saved to the library. Note: this action may result in data loss.

Parameters

Parameter Required Description
id yes The ID of the application.
action yes Refer to one of the possible actions. Must be: start, stop, restart, or publishUpdates.
startAllDraftVms no This is a query parameter. When set to False, newly added draft VMs will not start after publish updates action. The default value is true. This parameter is relevant only for the publishUpdates action. See usage example.

Response

Status Code Description
202 Accepted An operation result summary
Note: This call will return 202 even if no VM was actually handled, since you can view the failed VMs in the operation messages list.
400 Bad Request Depending on the action:

Start: When the application is already started or not published.

Stop: When the application is not published.

Restart: When the application is not published.

Publish Changes: When the application is not published or has validation errors.
403 Forbidden When the quota or time-lease have been exceeded.
404 Not Found When the specified ID does not exist.

Get VMs List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/34045955/vms

Returns a list of all the VMs in the application. These are full VM objects, including all the properties and components of the VMs.

There are additional ways to execute this call:

GET /applications/:id;design/vms - returns the application design VMs list.

GET /applications/:id;deployment/vms - returns the deployed VMs list on the cloud.

HTTP Request

GET /applications/:id/vms [;deployment or ;design] *

Parameters

Parameter Required Description
id yes The ID of the application.

Response

Status Code Description
200 OK The list of VMs.
404 Not Found When the specified ID does not exist.

Get VM

Example Request with request body:

GET https://cloud.ravellosystems.com/api/v1/applications/34045955/vms/12

Example Response:

{
    "id": 12,
    "name": "example-vm",
    "description": "ubuntu-14.04.1-20150302",
    "creationTime": 1459690696154,
    "memorySize": {
        "value": 4,
        "unit": "GB"
    },
    "numCpus": 1,
    "platform": "default",
    "os": "default",
    "rcu": 1,
    "supportsCloudInit": true,
    "requiresKeypair": true,
    "useCdn": false,
    "privateCloudImage": false,
    "applicationId": 34045955,
    "legacyMode": false,
    "loadingStatus": "DONE",
    "loadingPercentage": 100,
    "keypairId": 98305,
    "keypairName": "a",
    "baseVmId": 32777,
    "suppliedServices": [
        {
            "id": 165805422513624,
            "name": "ssh",
            "portRange": "22",
            "protocol": "TCP",
            "external": true,
            "ipConfigLuid": 4518047032598382,
            "useLuidForIpConfig": true
        }
    ],
    "networkConnections": [
        {
            "id": 1036588782647566,
            "device": {
                "useAutomaticMac": true,
                "index": 0,
                "deviceType": "e1000",
                "generatedMac": "2c:c2:60:22:6e:19"
            },
            "ipConfig": {
                "id": 4518047032598382,
                "fqdn": "my-fqdn.provider.com",
                "autoIpConfig": {
                    "allocatedIp": "10.0.0.3"
                },
                "hasPublicIp": false,
                "externalAccessState": "ALWAYS_PORT_FORWARDING",
                "needElasticIp": false
            },
            "name": "eth0",
            "accessPort": true,
            "vlanTag": "1",
            "mirror": false
        }
    ],
    "hardDrives": [
        {
            "id": 7580139133615168,
            "name": "ubuntu-14.04.1-20150302.qcow2",
            "boot": true,
            "size": {
                "value": 15,
                "unit": "GB"
            },
            "index": 0,
            "type": "DISK",
            "imageFetchMode": "LAZY",
            "controller": "virtio",
            "controllerIndex": 0,
            "loadingStatus": "DONE",
            "loadingPercentage": 100
        }
    ],
    "configurationManagement": {
        "configNetworkUsingCloudInit": false
    },
    "bootOrder": [
        "CDROM",
        "DISK"
    ],
    "powerOffOnStopTimeOut": true,
    "configNetworkUsingCloudInit": false,
    "requiresHvm": false
}
 Show full example

Returns a specific VM in the application.

There are additional ways to execute this call:

GET /applications/:appId;design/vms/:vmId - returns the designed VM.

GET /applications/:appId;deployment/vms/:vmId - returns the deployed VM on the cloud.

HTTP Request

GET /applications/:appId/vms/:vmId [;deployment or ;design] *

Parameters

Parameter Required Description
appId yes The ID of the application.
vmId yes The ID of the virtual machine.

Response

Status Code Description
200 OK The requested VM.
404 Not Found When the specified ID does not exist.

Update VM

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/vms/8542874167672832
{  
    "id":8542874167672832,
    "name":"MyUpdatedVm",
    "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
    "creationTime":1482680710672,
    "memorySize":{  
        "value":4,
        "unit":"GB"
    },
    "numCpus":1,
    "platform":"default",
    "os":"default",
    "rcu":1,
    "supportsCloudInit":false,
    "requiresKeypair":false,
    "useCdn":false,
    "privateCloudImage":false,
    "hostnames":[  
        "host1"
    ],
    "applicationId":1310724,
    "legacyMode":false,
    "loadingStatus":"DONE",
    "loadingPercentage":100,
    "baseVmId":32775,
    "allowNested":false,
    "suppliedServices":[  
        {  
            "id":1176656391700480,
            "name":"ssh",
            "portRange":"22",
            "protocol":"TCP",
            "external":true,
            "ipConfigLuid":7652275512147968,
            "useLuidForIpConfig":true
        },
        {  
            "id":8763490613329920,
            "name":"http",
            "portRange":"80",
            "protocol":"TCP",
            "external":true,
            "ipConfigLuid":7652275512147968,
            "useLuidForIpConfig":true
        }
    ],
    "requiredServices":[  
        {  
            "id":3874186231545856,
            "name":"sql",
            "protocol":"TCP",
            "external":false
        }
    ],
    "networkConnections":[  
        {  
            "id":4402621414637568,
            "device":{  
                "mac":"00:0c:29:82:5f:6f",
                "useAutomaticMac":false,
                "index":0,
                "deviceType":"e1000",
                "generatedMac":"2c:c2:60:23:bb:4b"
            },
            "ipConfig":{  
                "id":7652275512147968,
                "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                "autoIpConfig":{  

                },
                "hasPublicIp":false,
                "externalAccessState":"ALWAYS_PORT_FORWARDING",
                "needElasticIp":false
            },
            "name":"eth0"
        }
    ],
    "hardDrives":[  
        {  
            "id":401957445435392,
            "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
            "boot":true,
            "size":{  
                "value":15,
                "unit":"GB"
            },
            "index":0,
            "type":"DISK",
            "imageFetchMode":"LAZY",
            "controller":"pvscsi",
            "controllerIndex":0,
            "loadingStatus":"DONE",
            "loadingPercentage":100
        }
    ],
    "bootOrder":[  
        "CDROM",
        "DISK"
    ],
    "powerOffOnStopTimeOut":true,
    "usingNewNetwork":true,
    "requiresHvm":false
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"MyUpdatedVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific VM in the application.

HTTP Request

PUT /applications/:appId/vms/:vmId

VM Properties

Name Description
name The name of the image.
description The description of the VM.
creationTime The creation time of the VM (when it was first saved).
memorySize The memory size defined for the VM. It’s composed of unit and value. Unit can be one of “GB”,“MB”, “KB”, “BYTE” and the value is long. Example:
"memorySize" : { "unit": "GB", "value": 10 }
numCpus The number of CPUs in the VM.
platform The original virtualization platform, possible values: “DEFAULT”, “V2-ESX”
os The operating system.
supportsCloudInit Set this to true if the VM has cloud-init installed. Currently we support vanilla cloud-init v0.7.5 and up (Ubuntu 14.04 and later, Fedora Cloud images, etc). See here for more details.
userData Cloud-init’s behaviour can be configured using this field. See available formats here.
requiresKeypair Specifies whether or not the system should enforce setting a public key for SSH connectivity.(If false, a pre-configured authentication mechanism is used.)
keypairId When requiresKeypair set to true, set this field to the chosen key pair.
hostnames List of hostnames for the VM.
applicationId The ID of the application that this VM belongs to.
legacyMode Enables legacy mode for higher virtual hardware compatibility. Important: legacy mode is much slower than the default mode. We strongly advise to use it only after a discussion with us.
loadingStatus This field has two different meanings. On a design VM, this holds the loading status of the image that the VM is based on, since one can add a new VM to the design even if it’s not fully loaded yet.

Possible upload values: UPLOADING, PARSING, PENDING, PAUSED, SAVING, DONE, DELETING, DELETED, ERROR_UPLOADING, ERROR, UNKNOWN.

On a published VM, if a snapshot process is running (happens also automatically on stop), this field returns the status of that process.

Possible snapshot values: POST_SNAPSHOTTING, PRE_SNAPSHOTTING, SNAPSHOTTING, DONE.
loadingPercentage When the loading status of the VM is UPLOADING or SNAPSHOTTING, this indicates the percentage of data already uploaded or saved as snapshot.
baseVmId The ID of the library VM that this VM is based on.
biosUuid The BIOS unique identifier used for licensing or checking vendor hardware platform.
cpuIds Supported CPU features exposed to guest VMs.
bootOrder Specifies the boot order for the VM, for example: [‘CDROM’, 'DISK’]
rtc Real Time Clock - Sets the timezone for the VM. This is an object containing a String mode and a long number seconds. The possible modes are ABSOLUTE or RELATIVE and the seconds should set the timezone.

Example:
"rtc" : { "mode": "RELATIVE", "seconds": 7200 }


Default:
{ "mode": "RELATIVE", "seconds": 0 }
displayDevice The display device for this VM. Make sure your VM has the required driver for the selected device. Possible values are: “default”, “vmware-svga”, “VGA” (upper case).
vmOrderGroupId Links the VM with the group for setting VMs start/stop order. See more details under Setting the VM Start/Stop Order section.
stopTimeOut Time to wait for VM to stop successfully, default is 20 minutes.

VM Inner Objects

Name Description
hardDrives List of hard drives used in the VM.
networkConnections List of network interfaces.
suppliedServices List of supplied services. For simplicity, define a single external SSH service.
requiredServices List of required services.

Response

Status Code Description
200 OK The updated VM.
404 Not Found When the specified application ID or VM ID does not exist.

Execute Single VM Action

Example Request - Publish updates for the application, do not start VMs:

POST https://cloud.ravellosystems.com/api/v1/applications/340955/vms/548/stop

Performs an action on a specific VM in a published application.

HTTP Request

POST /applications/:appId/vms/:vmId/:action

Possible Actions

Action Description
» start Starts the VM.
» stop Shuts down the VM gracefully, following the configured timeout. Timeout can be set via the VM stopTimeOut parameter. The default setting is 20 minutes.
» shutdown An operating system that recognizes this signal shuts down gracefully, without timeout.
» poweroff The VM is abruptly powered off, with no consideration for work in progress.
» restart Restart the VM.
» repair Makes an attempt to repair the VM without destroying the data.
» resetDisks Resets each of the VM disks to its most recent applicable state: its state in the library, its state when it was last stopped, or its state when it was saved to the library. Note: this action may result in data loss.
» redeploy Resets each of the VM disks to its most recent applicable state (similar to resetDisks), shuts the VM down and publishes it again. Note: this action may result in data loss.

Parameters

Parameter Required Description
appId yes The ID of the application.
vmId yes The ID of the virtual machine.
action yes Refer to one of the possible actions. Must be: start, stop, restart, redeploy or repair.

Response

Status Code Description
202 Accepted The server is processing the request.
400 Bad Request When the VM is in the middle of another action (busy).
403 Forbidden When the quota or time-lease is exceeded.
404 Not Found When the specified ID does not exist.

Execute Multiple VMs Action

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/340955/vms/stop

JSON:

{
   "ids": ["id_1", "id_2", "id_N"]
}
 Show full example

XML:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<idsList >
   <ids>ID_1</ids>
   <ids>ID_2</ids>
   ...
   <ids>ID_N</ids>
</idsList>

Performs an action on a list of VMs in a published application.

HTTP Request

POST /applications/:appId/vms/:action

Possible Actions

Action Description
» start Starts the VM.
» stop Stops the VM.
» restart Restart the VM.
» repair Makes an attempt to repair the VM without destroying the data.
» shutdown Stops the VM gracefully, no server timeout.
» poweroff Stops the VM immediately, non-graceful way.
» resetDisks Resets each of the VM disks to its most recent applicable state: its state in the library, its state when it was last stopped, or its state when it was saved to the library. Note: this action may result in data loss.
» redeploy Resets each of the VM disks to its most recent applicable state (similar to resetDisks), shuts the VM down and publishes it again. Note: this action may result in data loss.

Parameters

Parameter Required Description
appId yes The ID of the application.
action yes Refer to one of the possible actions. Must be: start, stop, restart, redeploy and repair.
vmIds yes A list containing the VMs IDs to execute the action on.

Response

Status Code Description
202 Accepted The server is processing the request.
400 Bad Request When the given VMs list is empty, or when one of the VMs is in the middle of another action (busy).
403 Forbidden When the quota or time-lease is exceeded.
404 Not Found When one of the specified IDs does not exist.

Get All Publish Locations

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/34045/publishLocations

Example Response:

[
    {
        "regionName": "us-central-1",
        "regionDisplayName": "US Central 1",
        "deprecated": false
    },
    {
        "regionName": "us-east-1",
        "regionDisplayName": "US East 1",
        "deprecated": false
    },
    {
        "regionName": "Virginia",
        "regionDisplayName": "Virginia",
        "deprecated": true
    }
]
 Show full example

Finds all the possible publish location for the given application, considering the storage and CPU needs. The list is sorted by costs – low to high.

HTTP Request

GET /applications/:id/publishLocations

Parameters

Parameter Required Description
id yes The ID of the application.

Response

Status Code Description
200 OK Sorted list of all the possible publish locations
404 Not Found When the specified ID does not exist.

Set Application Expiration Time

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/3404595/setExpiration
{
    "expirationFromNowSeconds": 7200
}
 Show full example

In order to minimize costs, it is possible to set applications with auto-stop timeout, which determines when the application will be automatically stopped. It is important to ensure that applications are not forgotten alive without any usage. The auto-stop time can be updated to control the scheduling of this feature.

HTTP Request

POST applications/:id/setExpiration

Parameters

Parameter Required Description
id yes The ID of the application.
expirationFromNowSeconds yes The time in seconds (from now) when the application will be stopped. Set it to -1 to mark unlimited time.

Response

Status Code Description
200 OK Returns the application expiration time.
400 Bad Request When the time given is not valid.
404 Not Found When the specified ID does not exist.

Get VM VNC URL

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/3405/vms/2524/vncUrl
GET https://cloud.ravellosystems.com/api/v1/applications/3405/vms/2524/vncUrl?readOnly=true

Returns the URL for connecting to the VM remotely using VNC. Includes the authentication token needed to connect. This is useful to create an independent applet/form to connect remotely to the user’s VMs.

HTTP Request

GET applications/:appId/vms/:vmId/vncUrl

Parameters

Parameter Required Description
appId yes The ID of the application.
vmId yes The ID of the VM.
readOnly no This is a query parameter - when set to true the VNC session will be read only.

Response

Status Code Description
200 OK Returns the VNC URL.
404 Not Found When the specified ID does not exist.

Detailed Charges for Application

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/3404595/calcPrice;design
{
    "optimizationLevel" : "PERFORMANCE_OPTIMIZED"
}
 Show full example

Example Request (No body is needed):

POST https://cloud.ravellosystems.com/api/v1/applications/3404595/calcPrice;deployment

Example Response:

{
    "appTier": "ADVANCED",
    "optimizationLevel": "PERFORMANCE_OPTIMIZED",
    "productsSummary": [
        {
            "productCount": 0,
            "productType": "NETWORKING_MB",
            "productUname": "NETWORKING_MB",
            "summaryPrice": 0
        },
        {
            "productCount": 1,
            "productType": "R1",
            "productUname": "R1.ADVANCED.PERFORMANCE_OPTIMIZED",
            "summaryPrice": 0
        },
        {
            "productCount": 15360,
            "productType": "DISKSPACE_MB",
            "productUname": "DISKSPACE_MB",
            "summaryPrice": 0.005178082191780864
        },
        {
            "productCount": 1,
            "productType": "MINIMUM",
            "productUname": "MINIMUM.ADVANCED.PERFORMANCE_OPTIMIZED",
            "summaryPrice": 0.5
        }
    ],
    "totalActiveVms": 1,
    "totalAppCpuCount": 1,
    "totalAppMemoryInGb": 2.0,
    "totalDiskspaceInGb": 15.0,
    "totalIpAddressCount": 0,
    "totalPrice": 0.5051780821917808
}
 Show full example

Returns the detailed charges for the application. The prices are given in USD. For more details about the pricing, refer to Ravello’s pricing explained.

POST /applications/:id;design/calcPrice - returns the pricing according to the application design. All parameters are required.

POST /applications/:id;deployment/calcPrice - returns the pricing according to the deployed VMs list on the cloud, no parameters are needed.

HTTP Request

POST application/:id/calcPrice [;deployment or ;design]

Parameters - only when using the ;design parameter.

Parameter Required Description
id yes The ID of the application.
optimizationLevel yes The level of optimization which affects the price. Possible values: PERFORMANCE_OPTIMIZED, COST_OPTIMIZED

Response

Status Code Description
200 OK Successfully returns the application pricing details.
400 Bad Request When the parameter optimization level is not valid or missing.
404 Not Found When the specified ID does not exist.

Get billing details for an application

Returns a list of charges for the application according to the given date range.

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/786436/billing?year=2017&month=3

GET https://cloud.ravellosystems.com/api/v1/applications/786436/billing?from=1489788000000&to=1490047200000

Example Response:

{  
   "charges":[  
      {  
         "productRate":0.12,
         "summaryPrice":0.0016935484,
         "productCount":0.0141129032,
         "productType":"DISKSPACE_MB",
         "productUname":"DISKSPACE_MB",
         "productName":"Disk Space, GB",
         "unitName":"GB/Month"
      },
      {  
         "productRate":0.3,
         "summaryPrice":0.3,
         "productCount":1,
         "productType":"MINIMUM",
         "productUname":"MINIMUM.ADVANCED.COST_OPTIMIZED",
         "productName":"Minimum Cost Optimized Advanced Tier",
         "unitName":"Units/Hour"
      },
      {  
         "productRate":0.15,
         "summaryPrice":30007483.9123008591,
         "productCount":200049892.7486723941,
         "productType":"NETWORKING_MB",
         "productUname":"NETWORKING_MB",
         "productName":"External TX Networking",
         "unitName":"GB"
      }
   ],
   "applicationId":786436,
   "appName":"forthTestApp",
   "owner":"Ravello admin Ravello admin",
   "ownerId":8,
   "ownerDetails":{  
      "userId":8,
      "name":"Ravello admin Ravello admin",
      "deleted":false
   },
   "creationTime":1489929911043,
   "upTime":1,
   "activeVms":1,
   "errorVms":0,
   "stoppedVms":0,
   "cloud":"Oracle Ravello Cloud",
   "region":"US Central 1",
   "deleted":false
}

 Show full example
Parameter Required Description
year no Format: yyyy, for example: 2016. If the year value is not null, the month value must not be null, and the from and to values must be null.
month no An integer between 1 and 12, inclusive. If the month value is not null, the year value must not be null, and the from and to values must be null.
from no Time period in UTC. If the from value is not null, the to value must not be null, and the year and month values must be null.
to no Time period in UTC. If the to value is not null, the from value must not be null, and year and month values must be null.
Status Code Description
200 OK
400 Bad Request When parameters don’t match (from with to, year with month).
403 Forbidden When the user has no access to billing information, or if the application doesn’t exist

Get FQDN String of Deployed VM

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/168/vms/13/fqdn;deployment

Example Response:

{
    "value" :  "automationshelfvmc-webdriverinstance0-fgv4g6jf.dev.agineo.com"
}
 Show full example

Returns the FQDN string of a deployed VM.

HTTP Request

GET applications/:appId/vms/:vmId/fqdn;deployment

Parameters

Parameter Required Description
appId yes The ID of the application.
vmId yes The ID of the published VM.

Response

Status Code Description
200 OK The VM FQDN string
404 Not Found When the specified application ID or VM ID does not exist.

Get Cloud State of Deployed VM

Example Request with request body:

GET https://cloud.ravellosystems.com/api/v1/applications/168/vms/13/state;deployment

Returns the state of a deployed VM. Possible values are: PUBLISHING, WAITING_TO_START, STARTING, STARTED, RESTARTING, RESETTING_DISKS, WAITING_TO_STOP, STOPPING, STOPPED, TERMINATING, TERMINATED, ERROR, UNKNOWN, UPDATING, REPAIRING, ERROR_DEPLOY, ERROR_TERMINATE.

HTTP Request

GET applications/:appId/vms/:vmId/state;deployment

Parameters

Parameter Required Description
appId yes The ID of the application.
vmId yes The ID of the published VM.

Response

Status Code Description
200 OK The deployed VM state.
404 Not Found When the specified application ID or VM ID does not exist.

Get List of Public IPs of Deployed VM

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/168/vms/13/publicIps;deployment

Example Response:

{
    "ips": [
        "153.92.34.232"
    ]
}
 Show full example

Returns a list of the VM public IPs.

HTTP Request

GET applications/:appId/vms/:vmId/publicIps;deployment

Parameters

Parameter Required Description
appId yes The ID of the application.
vmId yes The ID of the published VM.

Response

Status Code Description
200 OK A list of the VM public IP addresses.
404 Not Found When the specified application ID or VM ID does not exist.

Check If Application is Published or Not

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/168/isPublished

Example Response:

{
    "value": true
}
 Show full example

Returns a boolean value specifying whether the application is published on the cloud.

HTTP Request

GET applications/:appId/isPublished

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK A boolean value.
404 Not Found When the specified application ID does not exist.

Add VM to Application (Design)

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/340955/vms
{
    "baseVmId" : 10
}
 Show full example

Adds a new VM to the application. Currently, the only supported option is to add a VM based on an image from the library. The request body should include the field baseVmId with the desired image ID (see list of available library images using GET /images). The new VM will be added to the application design.

HTTP Request

POST /applications/:appId/vms

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK The full application object after the update (including the new VM in the design).
400 Bad Request When the baseVmId field is missing from the request body.
404 Not Found When the application ID or the given image ID does not exist.

Delete VM from Application (Design)

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/340955/vms/245293

Removes an existing VM from the application design according to its ID. This call does not update the cloud; application changes still need to be updated on the cloud using the publishUpdates call.

HTTP Request

DELETE /applications/:appId/vms/:vmId

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK When the full application object is updated (without VM is removed).
404 Not Found When the application ID or the given VM ID does not exist.

Get Subnets List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/subnets;design

Example Response:

[
    {
        "id": 8299541106645283676,
        "networkSegmentId": 1245739912688515071,
        "ipVersion": "IPV4",
        "net": "10.0.0.0",
        "mask": "255.255.0.0"
    }
]
 Show full example

Returns a list of all the subnets.

There are two ways to execute this call:

GET applications/:appId/network/subnets;design - returns the application network subnets in the design.

GET applications/:appId/network/subnets;deployment - returns the deployed application network subnets.

HTTP Request

GET applications/:appId/network/subnets [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK The list of subnets.
404 Not Found When the specified application ID does not exist.

Get Subnet

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/subnets/8299541106645283676;design

Example Response:

{
    "id": 8299541106645283676,
    "networkSegmentId": 1245739912688515071,
    "ipVersion": "IPV4",
    "net": "10.0.0.0",
    "mask": "255.255.0.0"
}
 Show full example

Returns a specific subnet.

There are two ways to execute this call:

GET applications/:appId/network/subnets/:subnetId;design - returns the subnet from application design’s network.

GET applications/:appId/network/subnets/:subnetId;deployment - returns the subnet from application deployment’s network.

HTTP Request

GET applications/:appId/network/subnets/:subnetId [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
subnetId yes The ID of the subnet.

Response

Status Code Description
200 OK The requested subnet.
404 Not Found When the specified ID does not exist.

Create Subnet

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/1310724/network/subnets;design
{
    "networkSegmentId": "1245739912688515071",
    "name":"subnetName",
    "ipVersion": "IPV4",
    "net": "10.0.0.0",
    "mask": "255.255.0.0"
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "name":"subnetName",
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new subnet.

HTTP Request

POST /applications/:appId/network/subnets;design

Parameters

Parameter Required Description
appId yes The ID of the application.
name no The name of the subnet.
networkSegmentId yes The ID of the network segment the subnet is connected to.
ipVersion yes Specifies the IP version. Possible values: IPV4, IPV6.
net yes The subnet IP.
mask yes The subnet mask.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Update Subnet

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/network/subnets/4908532162120606002;design
{
    "id": 8299541106645283676,
    "networkSegmentId": 1245739912688515071,
    "ipVersion": "IPV4",
    "net": "10.0.0.0",
    "mask": "255.255.255.0"
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific subnet.

HTTP Request

PUT /applications/:appId/network/subnets/:subnetId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
subnetId yes The ID of the subnet.
name no The name of the subnet.
net yes The subnet IP.
mask yes The subnet mask.
ipVersion yes Specifies the IP version. Possible values: IPV4, IPV6.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Delete Subnet

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/1310724/network/subnets/4908532162120606002;design

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Deletes a specific subnet from the application design.

HTTP Request

DELETE applications/:appId/network/subnets/:subnetId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
subnetId yes The ID of the subnet.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Get Switches List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches;design

Example Response:

[  
    {  
        "id":5698518871933186972,
        "ports":[  
            {  
                "id":6239169582691308096,
                "index":1,
                "deviceType":"SERVICES",
                "deviceId":3573512059536565897,
                "networkSegmentReferences":[  
                    {  
                        "id":5261139603207924850,
                        "networkSegmentId":1245739912688515071,
                        "anyNetworkSegment":false,
                        "egressPolicy":"UNTAGGED"
                    }
                ]
            },
            {  
                "id":5666518502501684865,
                "index":2,
                "deviceType":"VM",
                "deviceId":4402621414637568,
                "networkSegmentReferences":[  
                    {  
                        "id":419973098119333636,
                        "networkSegmentId":1245739912688515071,
                        "anyNetworkSegment":false,
                        "egressPolicy":"UNTAGGED"
                    }
                ]
            }
        ],
        "networkSegments":[  
            {  
                "id":1245739912688515071,
                "vlanId":1
            }
        ]
    }
]
 Show full example

Returns a list of all the switches.

There are two ways to execute this call:

GET applications/:appId/network/switches;design - returns the application network switches in the design.

GET applications/:appId/network/switches;deployment - returns the deployed application network switches.

HTTP Request

GET applications/:appId/network/switches [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK The list of switches.
404 Not Found When the specified application ID does not exist.

Get Switch

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/5698518871933186972;design

Example Response:

{  
    "id":5698518871933186972,
    "ports":[  
        {  
            "id":6239169582691308096,
            "index":1,
            "deviceType":"SERVICES",
            "deviceId":3573512059536565897,
            "networkSegmentReferences":[  
                {  
                    "id":5261139603207924850,
                    "networkSegmentId":1245739912688515071,
                    "anyNetworkSegment":false,
                    "egressPolicy":"UNTAGGED"
                }
            ]
        },
        {  
            "id":5666518502501684865,
            "index":2,
            "deviceType":"VM",
            "deviceId":4402621414637568,
            "networkSegmentReferences":[  
                {  
                    "id":419973098119333636,
                    "networkSegmentId":1245739912688515071,
                    "anyNetworkSegment":false,
                    "egressPolicy":"UNTAGGED"
                }
            ]
        }
    ],
    "networkSegments":[  
        {  
            "id":1245739912688515071,
            "vlanId":1
        }
    ]
}
 Show full example

Returns a specific switch.

There are two ways to execute this call:

GET applications/:appId/network/switches/:switchId;design - returns the switch from application design’s network.

GET applications/:appId/network/switches/:switchId;deployment - returns the switch from application deployment’s network.

HTTP Request

GET applications/:appId/network/switches/:switchId [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.

Response

Status Code Description
200 OK The requested subnet.
404 Not Found When the specified ID does not exist.

Create Switch

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches;design
{  
    "id":5698518871933186972,
    "name":"switchName",
    "ports":[  
        {  
            "id":6239169582691308096,
            "index":1,
            "deviceType":"SERVICES",
            "deviceId":3573512059536565897,
            "networkSegmentReferences":[  
                {  
                    "id":5261139603207924850,
                    "networkSegmentId":1245739912688515071,
                    "anyNetworkSegment":false,
                    "egressPolicy":"UNTAGGED"
                }
            ]
        },
        {  
            "id":5666518502501684865,
            "index":2,
            "deviceType":"VM",
            "deviceId":4402621414637568,
            "networkSegmentReferences":[  
                {  
                    "id":419973098119333636,
                    "networkSegmentId":1245739912688515071,
                    "anyNetworkSegment":false,
                    "egressPolicy":"UNTAGGED"
                }
            ]
        }
    ],
    "networkSegments":[  
        {  
            "id":1245739912688515071,
            "vlanId":1
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"switchName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new switch.

HTTP Request

POST /applications/:appId/network/switches;design

Parameters

Parameter Required Description
appId yes The ID of the application.
name no The name of the switch.
ports no List of ports.
networkSegments no List of network segments.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Update Switch

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/5698518871933186972;design
{  
    "id":5698518871933186972,
    "name":"newName",
    "ports":[  
        {  
            "id":6239169582691308096,
            "index":1,
            "deviceType":"SERVICES",
            "deviceId":3573512059536565897,
            "networkSegmentReferences":[  
                {  
                    "id":5261139603207924850,
                    "networkSegmentId":1245739912688515071,
                    "anyNetworkSegment":false,
                    "egressPolicy":"UNTAGGED"
                }
            ]
        },
        {  
            "id":5666518502501684865,
            "index":2,
            "deviceType":"VM",
            "deviceId":4402621414637568,
            "networkSegmentReferences":[  
                {  
                    "id":419973098119333636,
                    "networkSegmentId":1245739912688515071,
                    "anyNetworkSegment":false,
                    "egressPolicy":"UNTAGGED"
                }
            ]
        }
    ],
    "networkSegments":[  
        {  
            "id":1245739912688515071,
            "vlanId":1
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"newName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific switch.

HTTP Request

PUT /applications/:appId/network/switches/:switchId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.
name no The name of the switch.
ports no List of ports.
networkSegments no List of network segments.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Delete Switch

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/7893463830402001926;design

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Deletes a specific switch from the application design.

HTTP Request

DELETE applications/:appId/network/switches/:switchId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Get Ports List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/5698518871933186972/ports;design

Example Response:

[  
    {  
        "id":6239169582691308096,
        "index":1,
        "deviceType":"SERVICES",
        "deviceId":3573512059536565897,
        "networkSegmentReferences":[  
            {  
                "id":5261139603207924850,
                "networkSegmentId":1245739912688515071,
                "anyNetworkSegment":false,
                "egressPolicy":"UNTAGGED"
            }
        ]
    },
    {  
        "id":5666518502501684865,
        "index":2,
        "deviceType":"VM",
        "deviceId":4402621414637568,
        "networkSegmentReferences":[  
            {  
                "id":419973098119333636,
                "networkSegmentId":1245739912688515071,
                "anyNetworkSegment":false,
                "egressPolicy":"UNTAGGED"
            }
        ]
    }
]
 Show full example

Returns a list of all the ports within a certain switch.

There are two ways to execute this call:

GET applications/:appId/network/switches/:switchId/ports;design - returns the application network ports within a specific switch in the design.

GET applications/:appId/network/switches/:switchId/ports;deployment - returns the deployed application network ports within a specific switch.

HTTP Request

GET applications/:appId/network/switches/:switchId/ports [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.

Response

Status Code Description
200 OK The list of ports.
404 Not Found When the specified application ID does not exist.

Get Port

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/5698518871933186972/ports/6239169582691308096;design

Example Response:

{  
    "id":6239169582691308096,
    "index":1,
    "deviceType":"SERVICES",
    "deviceId":3573512059536565897,
    "networkSegmentReferences":[  
        {  
            "id":5261139603207924850,
            "networkSegmentId":1245739912688515071,
            "anyNetworkSegment":false,
            "egressPolicy":"UNTAGGED"
        }
    ]
}
 Show full example

Returns a specific port within a specific switch.

There are two ways to execute this call:

GET applications/:appId/network/switches/:switchId/ports/:portId;design - returns the switch’s port from application design’s network.

GET applications/:appId/network/switches/:switchId/ports/:portId;deployment - returns the switch’s port from application deployment’s network.

HTTP Request

GET applications/:appId/network/switches/:switchId/ports/:portId [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.
portId yes The ID of the port.

Response

Status Code Description
200 OK The requested port.
404 Not Found When the specified ID does not exist.

Create Port

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/5698518871933186972/ports;design
{  
    "index":2,
    "deviceType":"VM",
    "deviceId":4402621414637568,
    "networkSegmentReferences":[  
        {  
            "id":419973098119333636,
            "networkSegmentId":1245739912688515071,
            "anyNetworkSegment":false,
            "egressPolicy":"UNTAGGED"
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"switchName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new port within a specific switch.

HTTP Request

POST /applications/:appId/network/switches/:switchId/ports;design

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.
index yes The index of the port within the switch ports list.
deviceType yes The device type. Possible values are: VM, SERVICES.
deviceId yes The ID of the connected device.
networkSegmentReferences no List of network segments references.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Update Port

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/5698518871933186972/ports/5666518502501684865;design
{  
    "id": 5666518502501684865,
    "index":2,
    "deviceType":"VM",
    "deviceId":4402621414637568,
    "networkSegmentReferences":[  
        {  
            "id":419973098119333636,
            "networkSegmentId":1245739912688515071,
            "anyNetworkSegment":false,
            "egressPolicy":"UNTAGGED"
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"newName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific port within the switch.

HTTP Request

PUT /applications/:appId/network/switches/:switchId/ports/:portId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.
portId yes The ID of the port.
index yes The index of the port within the switch ports list.
deviceType yes The device type. Possible values are: VM, SERVICES.
deviceId yes The ID of the connected device.
networkSegmentReferences no List of network segments references.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Delete Port

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/1310724/network/switches/7893463830402001926/ports/1748397656678903711;design

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Deletes a specific port from a specific switch from the application design.

HTTP Request

DELETE applications/:appId/network/switches/:switchId/ports/:portId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
switchId yes The ID of the switch.
portId yes The ID of the port.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Get Routers List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/routers;design

Example Response:

[  
    {  
        "id":3670150550160618265,
        "ipConfigurationIds":[  
            6245746631803480237
        ],
        "wan":true
    }
]
 Show full example

Returns a list of all the routers.

There are two ways to execute this call:

GET applications/:appId/network/services/routers;design - returns the application network routers in the design.

GET applications/:appId/network/services/routers;deployment - returns the deployed application network routers.

HTTP Request

GET applications/:appId/network/services/routers [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK The list of routers.
404 Not Found When the specified application ID does not exist.

Get Router

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/routers/3670150550160618265;design

Example Response:

{  
    "id":3670150550160618265,
    "ipConfigurationIds":[  
        6245746631803480237
    ],
    "wan":true
}
 Show full example

Returns a specific router.

There are two ways to execute this call:

GET applications/:appId/network/services/routers/:routerId;design - returns the router from application design’s network.

GET applications/:appId/network/services/routers/:routerId;deployment - returns the router from application deployment’s network.

HTTP Request

GET applications/:appId/network/services/routers/:routerId [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
routerId yes The ID of the router.

Response

Status Code Description
200 OK The requested router.
404 Not Found When the specified ID does not exist.

Create Router

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/routers;design
{  
    "ipConfigurationIds":[  
        6245746631803480237
    ],
    "wan":true
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"switchName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new router.

HTTP Request

POST /applications/:appId/network/services/routers;design

Parameters

Parameter Required Description
appId yes The ID of the application.
name no The name of the router.
ipConfigurationIds no List of IP configuration IDs.
wan yes A boolean flag to indicate whether the router is WAN.
snatRules no List of SNAT rules.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Update Router

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/routers/3670150550160618265;design
{  
    "id":3670150550160618265,
    "name":"routerName",
    "ipConfigurationIds":[  
        6245746631803480237
    ],
    "wan":true,
    "snatRules":[  
        {  
            "serviceId":1176656391700480,
            "sourceIpId":6245746631803480237
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"newName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "name":"routerName",
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true,
                        "snatRules":[  
                            {  
                                "id":7805982113529856,
                                "serviceId":1176656391700480,
                                "sourceIpId":6245746631803480237
                            }
                        ]
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific router.

HTTP Request

PUT /applications/:appId/network/services/routers/:routerId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
routerId yes The ID of the router.
name no The name of the router.
ipConfigurationIds no List of IP configuration IDs.
wan yes A boolean flag to indicate whether the router is WAN.
snatRules no List of SNAT rules.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Delete Router

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/routers/1038938392848595432;design

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Deletes a specific router from the application design.

HTTP Request

DELETE applications/:appId/network/services/routers/:routerId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
routerId yes The ID of the router.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Get DNS Servers List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dnsServers;design

Example Response:

[
    {  
        "id":5871797985881330216,
        "ipConfigurationIds":[  
            7243041682483866814
        ],
        "entries":[  
            {  
                "id":2990120240683050785,
                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                "ipConfigurationId":7652275512147968,
                "type":"A",
                "index":0
            },
            {  
                "id":3109681679603842921,
                "name":"host1",
                "ipConfigurationId":7652275512147968,
                "type":"A",
                "index":1
            },
            {  
                "id":3597421832811984217,
                "name":"host1",
                "ipConfigurationId":7652275512147968,
                "type":"PTR",
                "index":2
            }
        ]
    }
]
 Show full example

Returns a list of all the DNS servers.

There are two ways to execute this call:

GET applications/:appId/network/services/dnsServers;design - returns the application network DNS servers in the design.

GET applications/:appId/network/services/dnsServers;deployment - returns the deployed application network DNS servers.

HTTP Request

GET applications/:appId/network/services/dnsServers [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK The list of DNS servers.
404 Not Found When the specified application ID does not exist.

Get DNS Server

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dnsServers/3670150550160618265;design

Example Response:

{  
    "id":5871797985881330216,
    "ipConfigurationIds":[  
        7243041682483866814
    ],
    "entries":[  
        {  
            "id":2990120240683050785,
            "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":0
        },
        {  
            "id":3109681679603842921,
            "name":"host1",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":1
        },
        {  
            "id":3597421832811984217,
            "name":"host1",
            "ipConfigurationId":7652275512147968,
            "type":"PTR",
            "index":2
        }
    ]
}
 Show full example

Returns a specific DNS server.

There are two ways to execute this call:

GET applications/:appId/network/services/dnsServers/:dnsServerId;design - returns the DNS server from application design’s network.

GET applications/:appId/network/services/dnsServers/:dnsServerId;deployment - returns the DNS server from application deployment’s network.

HTTP Request

GET applications/:appId/network/services/dnsServers/:dnsServerId [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
dnsServerId yes The ID of the DNS server.

Response

Status Code Description
200 OK The requested DNS server.
404 Not Found When the specified ID does not exist.

Create DNS Server

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dnsServers;design
{  
    "name":"dnsServerName",
    "ipConfigurationIds":[  
        7243041682483866814
    ],
    "entries":[  
        {  
            "id":2990120240683050785,
            "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":0
        },
        {  
            "id":3109681679603842921,
            "name":"host1",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":1
        },
        {  
            "id":3597421832811984217,
            "name":"host1",
            "ipConfigurationId":7652275512147968,
            "type":"PTR",
            "index":2
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"switchName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "name":"dnsServerName",
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new DNS server.

HTTP Request

POST /applications/:appId/network/services/dnsServers;design

Parameters

Parameter Required Description
appId yes The ID of the application.
name no The name of the DNS server.
ipConfigurationIds no List of IP configuration IDs.
entries no List of DNS entries.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Update DNS Server

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dnsServers/5871797985881330216;design
{  
    "id":5871797985881330216,
    "ipConfigurationIds":[  
        7243041682483866814
    ],
    "entries":[  
        {  
            "id":2990120240683050785,
            "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":0
        },
        {  
            "id":3109681679603842921,
            "name":"host1",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":1
        },
        {  
            "id":3597421832811984217,
            "name":"host1",
            "ipConfigurationId":7652275512147968,
            "type":"PTR",
            "index":2
        },
        {  
            "name":"newName",
            "ipConfigurationId":7652275512147968,
            "type":"A",
            "index":3
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"newName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            },
                            {  
                                "id":7897365594867224211,
                                "name":"newName",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":3
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "name":"routerName",
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true,
                        "snatRules":[  
                            {  
                                "id":7805982113529856,
                                "serviceId":1176656391700480,
                                "sourceIpId":6245746631803480237
                            }
                        ]
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific DNS server.

HTTP Request

PUT /applications/:appId/network/services/dnsServers/:dnsServerId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
dnsServerId yes The ID of the DNS server.
name no The name of the DNS server.
ipConfigurationIds no List of IP configuration IDs.
entries no List of DNS entries.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Delete DNS Server

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dnsServers/7678985563208789321;design

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Deletes a specific DNS server from the application design.

HTTP Request

DELETE applications/:appId/network/services/dnsServers/:dnsServerId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
dnsServerId yes The ID of the DNS server.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Get DHCP Servers List

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dhcpServers;design

Example Response:

[  
    {  
        "id":8292541848286133055,
        "ipConfigurationId":7243041682483866814,
        "gatewayIpConfigurationId":6245746631803480237,
        "dnsIpConfigurationId":7243041682483866814,
        "poolStart":"10.0.0.0",
        "poolEnd":"10.0.0.255",
        "mask":"255.255.255.0",
        "excludedIpEntries":[  
            {  
                "id":631327180369992908,
                "ip":"10.0.0.0"
            },
            {  
                "id":9217558603330405540,
                "ip":"10.0.0.2"
            },
            {  
                "id":8647291755448752959,
                "ip":"10.0.0.1"
            },
            {  
                "id":3024587047399380851,
                "ip":"10.0.0.255"
            }
        ]
    }
]
 Show full example

Returns a list of all the DHCP servers.

There are two ways to execute this call:

GET applications/:appId/network/services/dhcpServers;design - returns the application network DHCP servers in the design.

GET applications/:appId/network/services/dhcpServers;deployment - returns the deployed application network DHCP servers.

HTTP Request

GET applications/:appId/network/services/dhcpServers [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.

Response

Status Code Description
200 OK The list of DHCP servers.
404 Not Found When the specified application ID does not exist.

Get DHCP Server

Example Request:

GET https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dhcpServers/8292541848286133055;design

Example Response:

{  
    "id":8292541848286133055,
    "ipConfigurationId":7243041682483866814,
    "gatewayIpConfigurationId":6245746631803480237,
    "dnsIpConfigurationId":7243041682483866814,
    "poolStart":"10.0.0.0",
    "poolEnd":"10.0.0.255",
    "mask":"255.255.255.0",
    "excludedIpEntries":[  
        {  
            "id":631327180369992908,
            "ip":"10.0.0.0"
        },
        {  
            "id":9217558603330405540,
            "ip":"10.0.0.2"
        },
        {  
            "id":8647291755448752959,
            "ip":"10.0.0.1"
        },
        {  
            "id":3024587047399380851,
            "ip":"10.0.0.255"
        }
    ]
}
 Show full example

Returns a specific DHCP server.

There are two ways to execute this call:

GET applications/:appId/network/services/dhcpServers/:dhcpServerId;design - returns the DHCP server from application design’s network.

GET applications/:appId/network/services/dhcpServers/:dhcpServerId;deployment - returns the DHCP server from application deployment’s network.

HTTP Request

GET applications/:appId/network/services/dhcpServers/:dhcpServerId [;deployment or ;design]

Parameters

Parameter Required Description
appId yes The ID of the application.
dhcpServerId yes The ID of the DHCP server.

Response

Status Code Description
200 OK The requested DHCP server.
404 Not Found When the specified ID does not exist.

Create DHCP Server

Example Request with request body:

POST https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dhcpServers;design
{  
    "id":8292541848286133055,
    "ipConfigurationId":7243041682483866814,
    "gatewayIpConfigurationId":6245746631803480237,
    "dnsIpConfigurationId":7243041682483866814,
    "poolStart":"10.0.0.0",
    "poolEnd":"10.0.0.255",
    "mask":"255.255.255.0",
    "excludedIpEntries":[  
        {  
            "id":631327180369992908,
            "ip":"10.0.0.0"
        },
        {  
            "id":9217558603330405540,
            "ip":"10.0.0.2"
        },
        {  
            "id":8647291755448752959,
            "ip":"10.0.0.1"
        },
        {  
            "id":3024587047399380851,
            "ip":"10.0.0.255"
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"switchName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "name":"dnsServerName",
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Creates a new DHCP server.

HTTP Request

POST /applications/:appId/network/services/dhcpServers;design

Parameters

Parameter Required Description
appId yes The ID of the application.
name no The name of the DHCP server.
ipConfigurationId yes The ID of the IP configuration.
gatewayIpConfigurationId no The ID of the DHCP Server’s gateway IP.
dnsIpConfigurationId no The ID of the DHCP Server’s DNS server IP.
mask yes The mask of the DHCP server generated IPs.
poolStart yes The IP address that defines the start of the subnet’s IP pool.
poolEnd yes The IP address that defines the end of the subnet’s IP pool.
excludedIpEntries no List of excluded IP entries.
reservedIpEntries no List of reserved IP entries.
assignedIpEntries no List of assigned IP entries.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Update DHCP Server

Example Request with request body:

PUT https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dhcpServers/8292541848286133055;design
{  
    "id":8292541848286133055,
    "ipConfigurationId":7243041682483866814,
    "gatewayIpConfigurationId":6245746631803480237,
    "dnsIpConfigurationId":7243041682483866814,
    "poolStart":"10.0.0.0",
    "poolEnd":"10.0.0.255",
    "mask":"255.255.255.0",
    "excludedIpEntries":[  
        {  
            "id":631327180369992908,
            "ip":"10.0.0.0"
        },
        {  
            "id":9217558603330405540,
            "ip":"10.0.0.2"
        },
        {  
            "id":8647291755448752959,
            "ip":"10.0.0.1"
        },
        {  
            "id":3024587047399380851,
            "ip":"10.0.0.255"
        }
    ],
    "reservedIpEntries":[  
        {  
            "id":631327180369992908,
            "ip":"10.0.0.6"
        }
    ]
}
 Show full example

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "name":"newName",
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ],
                        "reservedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.6"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            },
                            {  
                                "id":7897365594867224211,
                                "name":"newName",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":3
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "name":"routerName",
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true,
                        "snatRules":[  
                            {  
                                "id":7805982113529856,
                                "serviceId":1176656391700480,
                                "sourceIpId":6245746631803480237
                            }
                        ]
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":1482423197782,
        "name":"Organization",
        "deleted":false
    },
    "designDiffersFromDeployment":false,
    "published":false,
    "version":12
}
 Show full example

Updates a specific DHCP server.

HTTP Request

PUT /applications/:appId/network/services/dhcpServers/:dhcpServerId;design

Parameters

Parameter Required Description
appId yes The ID of the application.
dhcpServerId yes The ID of the DHCP server.
name no The name of the DHCP server.
ipConfigurationId yes The ID of the IP configuration.
gatewayIpConfigurationId no The ID of the DHCP Server’s gateway IP.
dnsIpConfigurationId no The ID of the DHCP Server’s DNS server IP.
mask yes The mask of the DHCP server generated IPs.
poolStart yes The IP address that defines the start of the subnet’s IP pool.
poolEnd yes The IP address that defines the end of the subnet’s IP pool.
excludedIpEntries no List of excluded IP entries.
reservedIpEntries no List of reserved IP entries.
assignedIpEntries no List of assigned IP entries.

Response

Status Code Description
200 OK The full application.
404 Not Found When the specified ID does not exist.

Delete DHCP Server

Example Request:

DELETE https://cloud.ravellosystems.com/api/v1/applications/1310724/network/services/dhcpServers/5363839490593838722;design

Example Response:

{  
    "id":1310724,
    "name":"ExampleApp",
    "owner":"Ravello admin Ravello admin",
    "ownerDetails":{  
        "userId":32775,
        "name":"Ravello admin Ravello admin",
        "deleted":false
    },
    "creationTime":1482680702049,
    "usingNewNetwork":true,
    "design":{  
        "vms":[  
            {  
                "id":8542874167672832,
                "name":"ExampleVm",
                "description":"A web server for the guided installation sample application. Running Apache and Wordpress on top of Centos 6.2. To SSH into the machine use ravello/ravelloCloud.",
                "creationTime":1482680710672,
                "memorySize":{  
                    "value":4,
                    "unit":"GB"
                },
                "numCpus":1,
                "platform":"default",
                "os":"default",
                "rcu":1,
                "supportsCloudInit":false,
                "requiresKeypair":false,
                "useCdn":false,
                "privateCloudImage":false,
                "hostnames":[  
                    "host1"
                ],
                "applicationId":1310724,
                "legacyMode":false,
                "loadingStatus":"DONE",
                "loadingPercentage":100,
                "baseVmId":32775,
                "allowNested":false,
                "suppliedServices":[  
                    {  
                        "id":1176656391700480,
                        "name":"ssh",
                        "portRange":"22",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    },
                    {  
                        "id":8763490613329920,
                        "name":"http",
                        "portRange":"80",
                        "protocol":"TCP",
                        "external":true,
                        "ipConfigLuid":7652275512147968,
                        "useLuidForIpConfig":true
                    }
                ],
                "requiredServices":[  
                    {  
                        "id":3874186231545856,
                        "name":"sql",
                        "protocol":"TCP",
                        "external":false
                    }
                ],
                "networkConnections":[  
                    {  
                        "id":4402621414637568,
                        "device":{  
                            "mac":"00:0c:29:82:5f:6f",
                            "useAutomaticMac":false,
                            "index":0,
                            "deviceType":"e1000",
                            "generatedMac":"2c:c2:60:23:bb:4b"
                        },
                        "ipConfig":{  
                            "id":7652275512147968,
                            "fqdn":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                            "autoIpConfig":{  

                            },
                            "hasPublicIp":false,
                            "externalAccessState":"ALWAYS_PORT_FORWARDING",
                            "needElasticIp":false
                        },
                        "name":"eth0"
                    }
                ],
                "hardDrives":[  
                    {  
                        "id":401957445435392,
                        "name":"storefile_0e44148f-c04d-427f-a86e-d2525dce2d8c",
                        "boot":true,
                        "size":{  
                            "value":15,
                            "unit":"GB"
                        },
                        "index":0,
                        "type":"DISK",
                        "imageFetchMode":"LAZY",
                        "controller":"pvscsi",
                        "controllerIndex":0,
                        "loadingStatus":"DONE",
                        "loadingPercentage":100
                    }
                ],
                "bootOrder":[  
                    "CDROM",
                    "DISK"
                ],
                "powerOffOnStopTimeOut":true,
                "usingNewNetwork":true,
                "requiresHvm":false
            }
        ],
        "network":{  
            "switches":[  
                {  
                    "id":5698518871933186972,
                    "ports":[  
                        {  
                            "id":6239169582691308096,
                            "index":1,
                            "deviceType":"SERVICES",
                            "deviceId":3573512059536565897,
                            "networkSegmentReferences":[  
                                {  
                                    "id":5261139603207924850,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        },
                        {  
                            "id":5666518502501684865,
                            "index":2,
                            "deviceType":"VM",
                            "deviceId":4402621414637568,
                            "networkSegmentReferences":[  
                                {  
                                    "id":419973098119333636,
                                    "networkSegmentId":1245739912688515071,
                                    "anyNetworkSegment":false,
                                    "egressPolicy":"UNTAGGED"
                                }
                            ]
                        }
                    ],
                    "networkSegments":[  
                        {  
                            "id":1245739912688515071,
                            "vlanId":1
                        }
                    ]
                }
            ],
            "subnets":[  
                {  
                    "id":8299541106645283676,
                    "networkSegmentId":1245739912688515071,
                    "ipVersion":"IPV4",
                    "net":"10.0.0.0",
                    "mask":"255.255.255.0"
                }
            ],
            "services":{  
                "dhcpServers":[  
                    {  
                        "id":8292541848286133055,
                        "ipConfigurationId":7243041682483866814,
                        "gatewayIpConfigurationId":6245746631803480237,
                        "dnsIpConfigurationId":7243041682483866814,
                        "poolStart":"10.0.0.0",
                        "poolEnd":"10.0.0.255",
                        "mask":"255.255.255.0",
                        "excludedIpEntries":[  
                            {  
                                "id":631327180369992908,
                                "ip":"10.0.0.0"
                            },
                            {  
                                "id":9217558603330405540,
                                "ip":"10.0.0.2"
                            },
                            {  
                                "id":8647291755448752959,
                                "ip":"10.0.0.1"
                            },
                            {  
                                "id":3161771754261200188,
                                "ip":"10.0.0.255"
                            }
                        ]
                    }
                ],
                "dnsServers":[  
                    {  
                        "id":5871797985881330216,
                        "ipConfigurationIds":[  
                            7243041682483866814
                        ],
                        "entries":[  
                            {  
                                "id":2990120240683050785,
                                "name":"examplevm-exampleapp-yquefgyl.dev.agineo.com",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":0
                            },
                            {  
                                "id":3109681679603842921,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"A",
                                "index":1
                            },
                            {  
                                "id":3597421832811984217,
                                "name":"host1",
                                "ipConfigurationId":7652275512147968,
                                "type":"PTR",
                                "index":2
                            }
                        ]
                    }
                ],
                "routers":[  
                    {  
                        "id":3670150550160618265,
                        "ipConfigurationIds":[  
                            6245746631803480237
                        ],
                        "wan":true
                    }
                ],
                "externalGateway":{  
                    "customRulesEnabled":false,
                    "natRules":[  
                        {  
                            "serviceId":1176656391700480
                        },
                        {  
                            "serviceId":8763490613329920
                        }
                    ],
                    "securityRules":[  
                        {  
                            "id":9036897609659163774,
                            "anySource":true,
                            "accessPolicy":"DENY"
                        }
                    ]
                },
                "networkInterfaces":[  
                    {  
                        "id":3573512059536565897,
                        "ipConfigurations":[  
                            {  
                                "id":7243041682483866814,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.1"
                                }
                            },
                            {  
                                "id":6245746631803480237,
                                "staticIpConfig":{  
                                    "ip":"10.0.0.2"
                                }
                            }
                        ]
                    }
                ]
            }
        },
        "layout":{  
            "vmLayoutItem":[  
                {  
                    "location":{  
                        "x":25,
                        "y":47
                    },
                    "vmId":8542874167672832
                }
            ]
        },
        "stopVmsByOrder":false
    },
    "costBucket":{  
        "id":8,
        "creationTime":148242319778