ViCE Image Registry

API endpoint of the ViCE Image Registry: search, deploy, and import virtual environments from supported execution environments like OpenStack, Docker, or bwLehrpool.
More information:
Contact Info: hello@helloreverb.com
Version: 0.1
BasePath:/v1
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. HTTP Basic Authentication

Methods

[ Jump to Models ]

Table of Contents

Default

Default

Up 
post /environments
Create a new execution environment for authenticated user (createEnvironment)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Environment (optional)
Body Parameter —

Return type

Environment

Example data

Content-Type: application/json
{
  "credentials" : {
    "password" : "aeiou",
    "location" : "aeiou",
    "username" : "aeiou",
    "specifics" : "{}"
  },
  "managementlayer" : {
    "software" : "aeiou",
    "type" : "basic",
    "version" : "aeiou"
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "runtimetechnology" : {
    "software" : "aeiou",
    "type" : "virtualmachine",
    "version" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Environment

401

Authentication information is missing or invalid

405

Invalid input

500

Internal Server Error
Up 
post /images
Create a new image (createImage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Image (required)
Body Parameter —

Return type

Image

Example data

Content-Type: application/json
{
  "imagetype" : "implicit",
  "imported" : true,
  "originEnvironment" : {
    "credentials" : {
      "password" : "aeiou",
      "location" : "aeiou",
      "username" : "aeiou",
      "specifics" : "{}"
    },
    "managementlayer" : {
      "software" : "aeiou",
      "type" : "basic",
      "version" : "aeiou"
    },
    "id" : "aeiou",
    "title" : "aeiou",
    "userid" : "aeiou",
    "runtimetechnology" : {
      "software" : "aeiou",
      "type" : "virtualmachine",
      "version" : "aeiou"
    }
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "contenttype" : "disk-raw",
  "environmentReference" : "aeiou",
  "specifics" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Image

401

Authentication information is missing or invalid

405

Invalid input

500

Internal Server Error
Up 
post /user
Create a new user in the system (createUser)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body User (required)
Body Parameter —

Return type

User

Example data

Content-Type: application/json
{
  "password" : "aeiou",
  "id" : "aeiou",
  "fullname" : "aeiou",
  "email" : "aeiou",
  "username" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation User

401

Authentication information is missing or invalid

500

Internal Server Error
Up 
delete /deployment/{deploymentId}
Removes an image deployment from the environment (deleteDeployment)

Path parameters

deploymentId (required)
Path Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error
Up 
delete /environment/{environmentId}
Deletes an execution environment (deleteEnvironment)

Path parameters

environmentId (required)
Path Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error
Up 
delete /image/{imageId}
Deletes an image (deleteImage)

Path parameters

imageId (required)
Path Parameter —

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error
Up 
post /deploy
Create an image into an environment (deployImage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Deployment (required)
Body Parameter —

Return type

Deployment

Example data

Content-Type: application/json
{
  "imageid" : "aeiou",
  "environmentId" : "aeiou",
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "environmentReference" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created Deployment

401

Authentication information is missing or invalid

405

Invalid input

500

Internal Server Error
Up 
get /image/{imageId}/file
Download a file as image (downloadImage)

Path parameters

imageId (required)
Path Parameter —

Return type

File

Example data

Content-Type:

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation File

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error
Up 
get /deployments
List all deployments of authenticated user (findDeployments)

Return type

array[Deployment]

Example data

Content-Type: application/json
[ {
  "imageid" : "aeiou",
  "environmentId" : "aeiou",
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "environmentReference" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of deployments.

401

Authentication information is missing or invalid

500

Internal Server Error
Up 
get /environments
List by user accessible execution environments (findEnvironment)

Query parameters

filterManagementlayer (optional)
Query Parameter —
filterRuntimetechnology (optional)
Query Parameter —

Return type

array[Environment]

Example data

Content-Type: application/json
[ {
  "credentials" : {
    "password" : "aeiou",
    "location" : "aeiou",
    "username" : "aeiou",
    "specifics" : "{}"
  },
  "managementlayer" : {
    "software" : "aeiou",
    "type" : "basic",
    "version" : "aeiou"
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "runtimetechnology" : {
    "software" : "aeiou",
    "type" : "virtualmachine",
    "version" : "aeiou"
  }
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of accessible execution environments.

401

Authentication information is missing or invalid

500

Internal Server Error
Up 
get /images
List available images (findImages)

Return type

array[Image]

Example data

Content-Type: application/json
[ {
  "imagetype" : "implicit",
  "imported" : true,
  "originEnvironment" : {
    "credentials" : {
      "password" : "aeiou",
      "location" : "aeiou",
      "username" : "aeiou",
      "specifics" : "{}"
    },
    "managementlayer" : {
      "software" : "aeiou",
      "type" : "basic",
      "version" : "aeiou"
    },
    "id" : "aeiou",
    "title" : "aeiou",
    "userid" : "aeiou",
    "runtimetechnology" : {
      "software" : "aeiou",
      "type" : "virtualmachine",
      "version" : "aeiou"
    }
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "contenttype" : "disk-raw",
  "environmentReference" : "aeiou",
  "specifics" : "{}"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An array of images.

500

Internal Server Error
Up 
get /deployment/{deploymentId}
Get a deployment (getDeployment)

Path parameters

deploymentId (required)
Path Parameter —

Return type

Deployment

Example data

Content-Type: application/json
{
  "imageid" : "aeiou",
  "environmentId" : "aeiou",
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "environmentReference" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation Deployment

401

Authentication information is missing or invalid

404

Deployment not found

500

Internal Server Error
Up 
get /environment/{environmentId}
Get execution environment by id (getEnvironment)

Path parameters

environmentId (required)
Path Parameter —

Return type

Environment

Example data

Content-Type: application/json
{
  "credentials" : {
    "password" : "aeiou",
    "location" : "aeiou",
    "username" : "aeiou",
    "specifics" : "{}"
  },
  "managementlayer" : {
    "software" : "aeiou",
    "type" : "basic",
    "version" : "aeiou"
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "runtimetechnology" : {
    "software" : "aeiou",
    "type" : "virtualmachine",
    "version" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation Environment

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error
Up 
get /image/{imageId}
Get an image by id (getImage)

Path parameters

imageId (required)
Path Parameter —

Return type

Image

Example data

Content-Type: application/json
{
  "imagetype" : "implicit",
  "imported" : true,
  "originEnvironment" : {
    "credentials" : {
      "password" : "aeiou",
      "location" : "aeiou",
      "username" : "aeiou",
      "specifics" : "{}"
    },
    "managementlayer" : {
      "software" : "aeiou",
      "type" : "basic",
      "version" : "aeiou"
    },
    "id" : "aeiou",
    "title" : "aeiou",
    "userid" : "aeiou",
    "runtimetechnology" : {
      "software" : "aeiou",
      "type" : "virtualmachine",
      "version" : "aeiou"
    }
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "contenttype" : "disk-raw",
  "environmentReference" : "aeiou",
  "specifics" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation Image

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error
Up 
get /runtimestats
Provide internal statistics about import/export queue length and workers (getRuntimeStats)

Return type

RuntimeStats

Example data

Content-Type: application/json
{
  "importsPending" : 0,
  "exportWorker" : 5,
  "importWorker" : 6,
  "storePending" : 5,
  "exportsPending" : 1,
  "storeWorker" : 2
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation RuntimeStats

401

Authentication information is missing or invalid

500

Internal Server Error
Up 
get /user
Provide user information about logged in user (getUser)

Return type

User

Example data

Content-Type: application/json
{
  "password" : "aeiou",
  "id" : "aeiou",
  "fullname" : "aeiou",
  "email" : "aeiou",
  "username" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation User

401

Authentication information is missing or invalid

500

Internal Server Error
Up 
put /environments
Update an existing execution environment (updateEnvironment)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Environment (optional)
Body Parameter —

Return type

Environment

Example data

Content-Type: application/json
{
  "credentials" : {
    "password" : "aeiou",
    "location" : "aeiou",
    "username" : "aeiou",
    "specifics" : "{}"
  },
  "managementlayer" : {
    "software" : "aeiou",
    "type" : "basic",
    "version" : "aeiou"
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "runtimetechnology" : {
    "software" : "aeiou",
    "type" : "virtualmachine",
    "version" : "aeiou"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Updated Environment

401

Authentication information is missing or invalid

404

Element not found

405

Invalid input

500

Internal Server Error
Up 
put /images
Update an existing image (updateImage)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Image (required)
Body Parameter —

Return type

Image

Example data

Content-Type: application/json
{
  "imagetype" : "implicit",
  "imported" : true,
  "originEnvironment" : {
    "credentials" : {
      "password" : "aeiou",
      "location" : "aeiou",
      "username" : "aeiou",
      "specifics" : "{}"
    },
    "managementlayer" : {
      "software" : "aeiou",
      "type" : "basic",
      "version" : "aeiou"
    },
    "id" : "aeiou",
    "title" : "aeiou",
    "userid" : "aeiou",
    "runtimetechnology" : {
      "software" : "aeiou",
      "type" : "virtualmachine",
      "version" : "aeiou"
    }
  },
  "id" : "aeiou",
  "title" : "aeiou",
  "userid" : "aeiou",
  "contenttype" : "disk-raw",
  "environmentReference" : "aeiou",
  "specifics" : "{}"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Updated Image

401

Authentication information is missing or invalid

404

Element not found

405

Invalid input

500

Internal Server Error
Up 
post /image/{imageId}/file
Upload a file as image (uploadImage)

Path parameters

imageId (required)
Path Parameter —

Consumes

This API call consumes the following media types via the Content-Type request header:

Form parameters

upfile (optional)
Form Parameter — The file to upload.

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

successful operation

400

Bad request

401

Authentication information is missing or invalid

404

Element not found

500

Internal Server Error

Models

[ Jump to Methods ]

Table of Contents

  1. Credentials -
  2. Deployment -
  3. Environment -
  4. Image -
  5. ManagementLayer -
  6. RuntimeStats -
  7. RuntimeTechnology -
  8. User -

Credentials - Up

location (optional)
String
username (optional)
String
password (optional)
String
specifics (optional)
Object

Deployment - Up

id (optional)
String
title (optional)
String
userid (optional)
String
imageid (optional)
String
environmentId (optional)
String
environmentReference (optional)
String

Environment - Up

id (optional)
String
title (optional)
String
userid (optional)
String
credentials (optional)
Credentials
runtimetechnology (optional)
RuntimeTechnology
managementlayer (optional)
ManagementLayer

Image - Up

id (optional)
String
title (optional)
String
userid (optional)
String
imagetype (optional)
String
Enum:
implicit
declarative
contenttype (optional)
String
Enum:
disk-raw
disk-qcow2
disk-vmdk
docker-file
docker-image
packerfile
imported (optional)
Boolean
originEnvironment (optional)
Environment
environmentReference (optional)
String
specifics (optional)
Object

ManagementLayer - Up

type (optional)
String
Enum:
basic
cloudcomputing
containercluster
jobscheduler
software (optional)
String
version (optional)
String

RuntimeStats - Up

importsPending (optional)
Integer
importWorker (optional)
Integer
exportsPending (optional)
Integer
exportWorker (optional)
Integer
storePending (optional)
Integer
storeWorker (optional)
Integer

RuntimeTechnology - Up

type (optional)
String
Enum:
virtualmachine
container
application
software (optional)
String
version (optional)
String

User - Up

id (optional)
String
username (optional)
String
password (optional)
String
email (optional)
String
fullname (optional)
String