Skip to content

Latest commit

 

History

History
48 lines (35 loc) · 1.8 KB

Readme.md

File metadata and controls

48 lines (35 loc) · 1.8 KB
Raw

Create VDC with Edge Portal API Demo

This is a web-application to demonstrate using UKCloud Portal's APIs to provision a VDC with an Internet Edge Gateway.

Usage (Docker):

build_id="$(docker image build . | tee >(cat 1>&2) | tail -n1 | awk '{print $NF}')"

docker container run --rm -itp 127.0.0.1:3000:3000 "$build_id"
# Navigate to http://127.0.0.1:3000/ in a web browser.
# Open Developer Tools → Network Inspector to inspect the requests and responses.
# Fill in and submit the form.

APIs

From the Portal, the following routes were used:

  • POST /api/authenticate
  • POST /api/accounts/{account_id}/vorgs/{vorg_id}/vdcs
  • GET /api/vdc-builds/{build_id}
  • POST /api/accounts/{account_id}/vorgs/{vorg_id}/vdcs/{vdc_urn}/edge-gateways
  • GET /api/edge-gateway-builds/{build_id}

From vCloud Director, the following routes were used:

  • POST /api/sessions
  • GET /api/org
  • GET /api/org/{org_urn}

Please make use of the OpenAPI specifications. Note, that neither specification is currently complete. Both specifications should be complete enough for common tasks. OpenAPI specifications can be used in a variety of ways, such as generating clients, documentation or mock servers.

Portal OpenAPI Specification

vCloud Director OpenAPI Specification (Upstream project)

Please see the provided HAR (HTTP ARchive) example. It demonstrates usage of the APIs. It can be viewed directly, or through the developer tools of a browser such as Chrome or Firefox. Note, that the authentication and sessions contained are no longer valid.