REST API

Openapi Specification

Current API status:

GET /actuator

links

Status Codes:
GET /actuator/configprops

handle

Status Codes:
GET /actuator/health

handle

Status Codes:
GET /actuator/health/{component}

handle

Status Codes:
GET /actuator/health/{component}/{instance}

handle

Status Codes:
GET /actuator/info

handle

Status Codes:
GET /actuator/loggers

handle

Status Codes:
GET /actuator/loggers/{name}

handle

Status Codes:
POST /actuator/loggers/{name}

handle

Status Codes:
GET /actuator/metrics

handle

Status Codes:
GET /actuator/metrics/{requiredMetricName}

handle

Status Codes:
GET /applications

getAllApplications

Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • _embedded[].description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].name (string) – Human readable name of the application. (required)
  • _embedded[].owner (string) – Human readable information for the application owner, who is responsible for this application.
  • _embedded[].services[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].services[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].services[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].services[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].services[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].services[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].services[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].services[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].services[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].services[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _embedded[].shortName (string) – Unique short name of the application. (required)
  • _embedded[].version (string) – The version of this application. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
POST /applications

createApplication

Request JSON Object:
 
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • name (string) – Human readable name of the application. (required)
  • owner (string) – Human readable information for the application owner, who is responsible for this application.
  • shortName (string) – Unique short name of the application. (required)
  • version (string) – The version of this application. (required)
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • name (string) – Human readable name of the application. (required)
  • owner (string) – Human readable information for the application owner, who is responsible for this application.
  • services[].contact (string) – Human readable contact information for support purposes.
  • services[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • services[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • services[].dockerfilePath (string) – The relative path to the Dockerfile.
  • services[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • services[].name (string) – A human readable name of the MicoService. (required)
  • services[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • services[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • services[].shortName (string) – A unique name of the MicoService. (required)
  • services[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • shortName (string) – Unique short name of the application. (required)
  • version (string) – The version of this application. (required)
GET /applications/{shortName}

getApplicationsByShortName

Parameters:
  • shortName (string) – shortName
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • _embedded[].description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].name (string) – Human readable name of the application. (required)
  • _embedded[].owner (string) – Human readable information for the application owner, who is responsible for this application.
  • _embedded[].services[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].services[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].services[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].services[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].services[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].services[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].services[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].services[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].services[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].services[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _embedded[].shortName (string) – Unique short name of the application. (required)
  • _embedded[].version (string) – The version of this application. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
DELETE /applications/{shortName}

deleteAllVersionsOfAnApplication

Parameters:
  • shortName (string) – shortName
Status Codes:
GET /applications/{shortName}/{version}

getApplicationByShortNameAndVersion

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • name (string) – Human readable name of the application. (required)
  • owner (string) – Human readable information for the application owner, who is responsible for this application.
  • services[].contact (string) – Human readable contact information for support purposes.
  • services[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • services[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • services[].dockerfilePath (string) – The relative path to the Dockerfile.
  • services[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • services[].name (string) – A human readable name of the MicoService. (required)
  • services[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • services[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • services[].shortName (string) – A unique name of the MicoService. (required)
  • services[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • shortName (string) – Unique short name of the application. (required)
  • version (string) – The version of this application. (required)
PUT /applications/{shortName}/{version}

updateApplication

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • name (string) – Human readable name of the application. (required)
  • owner (string) – Human readable information for the application owner, who is responsible for this application.
  • shortName (string) – Unique short name of the application. (required)
  • version (string) – The version of this application. (required)
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • name (string) – Human readable name of the application. (required)
  • owner (string) – Human readable information for the application owner, who is responsible for this application.
  • services[].contact (string) – Human readable contact information for support purposes.
  • services[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • services[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • services[].dockerfilePath (string) – The relative path to the Dockerfile.
  • services[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • services[].name (string) – A human readable name of the MicoService. (required)
  • services[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • services[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • services[].shortName (string) – A unique name of the MicoService. (required)
  • services[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • shortName (string) – Unique short name of the application. (required)
  • version (string) – The version of this application. (required)
DELETE /applications/{shortName}/{version}

deleteApplication

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
POST /applications/{shortName}/{version}/deploy

deploy

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • jobs[].errorMessage (string) – An error message in case the job has failed (read only)
  • jobs[].id (string) – The generated job id. (read only)
  • jobs[].serviceShortName (string) – The name of the corresponding service. (read only)
  • jobs[].serviceVersion (string) – The version of the corresponding service. (read only)
  • jobs[].status (string) – The current status of the job. (read only)
  • jobs[].type (string) – The type of job. (read only)
  • status (string) – The aggregated status of jobs for an application. (read only)
GET /applications/{shortName}/{version}/deploymentInformation/{serviceShortName}

getServiceDeploymentInformation

Parameters:
  • serviceShortName (string) – serviceShortName
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • environmentVariables[].name (string) – Name of the environment variable. (required)
  • environmentVariables[].value (string) – Value of the environment variable.
  • imagePullPolicy (string) – Indicates whether and when to pull the image. Null is ignored.
  • labels[].key (string) – Key of the label. (required)
  • labels[].value (string) – Value of the label.
  • replicas (integer) – Number of desired instances. Defaults to 1.
  • restartPolicy (string) – Restart policy for all containers. Null is ignored.
PUT /applications/{shortName}/{version}/deploymentInformation/{serviceShortName}

updateServiceDeploymentInformation

Parameters:
  • serviceShortName (string) – serviceShortName
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • environmentVariables[].name (string) – Name of the environment variable. (required)
  • environmentVariables[].value (string) – Value of the environment variable.
  • imagePullPolicy (string) – Indicates whether and when to pull the image. Null is ignored.
  • labels[].key (string) – Key of the label. (required)
  • labels[].value (string) – Value of the label.
  • replicas (integer) – Number of desired instances. Defaults to 1.
  • restartPolicy (string) – Restart policy for all containers. Null is ignored.
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • environmentVariables[].name (string) – Name of the environment variable. (required)
  • environmentVariables[].value (string) – Value of the environment variable.
  • imagePullPolicy (string) – Indicates whether and when to pull the image. Null is ignored.
  • labels[].key (string) – Key of the label. (required)
  • labels[].value (string) – Value of the label.
  • replicas (integer) – Number of desired instances. Defaults to 1.
  • restartPolicy (string) – Restart policy for all containers. Null is ignored.
POST /applications/{shortName}/{version}/promote

promoteApplication

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • version (string) – The version (in semantic version format). (required)
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • name (string) – Human readable name of the application. (required)
  • owner (string) – Human readable information for the application owner, who is responsible for this application.
  • services[].contact (string) – Human readable contact information for support purposes.
  • services[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • services[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • services[].dockerfilePath (string) – The relative path to the Dockerfile.
  • services[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • services[].name (string) – A human readable name of the MicoService. (required)
  • services[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • services[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • services[].shortName (string) – A unique name of the MicoService. (required)
  • services[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • shortName (string) – Unique short name of the application. (required)
  • version (string) – The version of this application. (required)
GET /applications/{shortName}/{version}/services

getServicesFromApplication

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
DELETE /applications/{shortName}/{version}/services/{serviceShortName}

deleteServiceFromApplication

Parameters:
  • serviceShortName (string) – serviceShortName
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
POST /applications/{shortName}/{version}/services/{serviceShortName}/{serviceVersion}

addServiceToApplication

Parameters:
  • serviceShortName (string) – serviceShortName
  • serviceVersion (string) – serviceVersion
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
GET /applications/{shortName}/{version}/status

getStatusOfApplication

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • serviceStatuses[].applicationsUsingThisService[].contact (string) – Human readable contact information for support purposes.
  • serviceStatuses[].applicationsUsingThisService[].deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • serviceStatuses[].applicationsUsingThisService[].description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • serviceStatuses[].applicationsUsingThisService[].name (string) – Human readable name of the application. (required)
  • serviceStatuses[].applicationsUsingThisService[].owner (string) – Human readable information for the application owner, who is responsible for this application.
  • serviceStatuses[].applicationsUsingThisService[].shortName (string) – Unique short name of the application. (required)
  • serviceStatuses[].applicationsUsingThisService[].version (string) – The version of this application. (required)
  • serviceStatuses[].availableReplicas (integer) – Counter for the number of replicas of the corresponding MicoService that are actually available.
  • serviceStatuses[].errorMessages[] (string) –
  • serviceStatuses[].interfacesInformation[].externalIps[] (string) –
  • serviceStatuses[].interfacesInformation[].name (string) – Name of the MicoServiceInterface.
  • serviceStatuses[].name (string) – Name of the MicoService.
  • serviceStatuses[].nodeMetrics[].averageCpuLoad (integer) – The average CPU load of all pods of one MicoService running on this Node.
  • serviceStatuses[].nodeMetrics[].averageMemoryUsage (integer) – The average memory usage of all pods of one MicoService running on this Node.
  • serviceStatuses[].nodeMetrics[].nodeName (string) – Name of the Kubernetes Node.
  • serviceStatuses[].podsInformation[].hostIp (string) – IP address of the host to which the pod is assigned.
  • serviceStatuses[].podsInformation[].metrics.available (boolean) – Indicates if a pod is available.
  • serviceStatuses[].podsInformation[].metrics.cpuLoad (integer) – CPU load of a pod.
  • serviceStatuses[].podsInformation[].metrics.memoryUsage (integer) – Memory usage of a pod.
  • serviceStatuses[].podsInformation[].nodeName (string) – Name of the node the pod is running on.
  • serviceStatuses[].podsInformation[].phase (string) – States the lifecycle of a pod: Pending, Running, Succeeded, Failed, Unknown, Completed, CrashLoopBackOff
  • serviceStatuses[].podsInformation[].podName (string) – Name of the Pod.
  • serviceStatuses[].podsInformation[].restarts (integer) – Counter for restarts of all containers of a pod.
  • serviceStatuses[].podsInformation[].startTime (string) – The point in time the pod has been started.
  • serviceStatuses[].requestedReplicas (integer) – Counter for the number of replicas of the corresponding MicoService that should be available.
  • serviceStatuses[].shortName (string) – Short name of the MicoService.
  • serviceStatuses[].version (string) – Version of the MicoService.
  • totalNumberOfAvailableReplicas (integer) – Number of replicas of all services that are available in a MicoApplication.
  • totalNumberOfMicoServices (integer) – Number of MicoServices of a MicoApplication.
  • totalNumberOfPods (integer) – Number of pods created by all MicoServices in a MicoApplication.
  • totalNumberOfRequestedReplicas (integer) – Number of replicas of all services that should be available in a MicoApplication.
GET /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
HEAD /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
POST /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
PUT /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
DELETE /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
OPTIONS /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
PATCH /error

errorHtml

Status Codes:
Response JSON Object:
 
  • empty (boolean) –
  • reference (boolean) –
  • status (string) –
  • view.contentType (string) –
  • viewName (string) –
GET /jobs

getAllJobs

Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].errorMessage (string) – An error message in case the job has failed (read only)
  • _embedded[].id (string) – The generated job id. (read only)
  • _embedded[].serviceShortName (string) – The name of the corresponding service. (read only)
  • _embedded[].serviceVersion (string) – The version of the corresponding service. (read only)
  • _embedded[].status (string) – The current status of the job. (read only)
  • _embedded[].type (string) – The type of job. (read only)
  • _links[].href (string) –
  • _links[].templated (boolean) –
GET /jobs/{id}

getJobById

Parameters:
  • id (string) – id
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • errorMessage (string) – An error message in case the job has failed (read only)
  • id (string) – The generated job id. (read only)
  • serviceShortName (string) – The name of the corresponding service. (read only)
  • serviceVersion (string) – The version of the corresponding service. (read only)
  • status (string) – The current status of the job. (read only)
  • type (string) – The type of job. (read only)
DELETE /jobs/{id}

deleteJob

Parameters:
  • id (string) – id
Status Codes:
GET /jobs/{shortName}/{version}/status

getJobStatusByApplicationShortNameAndVersion

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • jobs[].errorMessage (string) – An error message in case the job has failed (read only)
  • jobs[].id (string) – The generated job id. (read only)
  • jobs[].serviceShortName (string) – The name of the corresponding service. (read only)
  • jobs[].serviceVersion (string) – The version of the corresponding service. (read only)
  • jobs[].status (string) – The current status of the job. (read only)
  • jobs[].type (string) – The type of job. (read only)
  • status (string) – The aggregated status of jobs for an application. (read only)
GET /services

getServiceList

Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
POST /services

createService

Request JSON Object:
 
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
GET /services/import/github

getVersionsFromGitHub

Query Parameters:
 
  • url (string) – url
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].version (string) – The version (in semantic version format). (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
POST /services/import/github

importMicoServiceFromGitHub

Request JSON Object:
 
  • url (string) – The url to the remote repository to crawl from. (required)
  • version (string) – The remote release tag. Defaults to ‘latest’.
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
GET /services/{shortName}

getVersionsOfService

Parameters:
  • shortName (string) – shortName
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
DELETE /services/{shortName}

deleteAllVersionsOfService

Parameters:
  • shortName (string) – shortName
Status Codes:
GET /services/{shortName}/{version}

getServiceByShortNameAndVersion

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
PUT /services/{shortName}/{version}

updateService

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
DELETE /services/{shortName}/{version}

deleteService

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
GET /services/{shortName}/{version}/dependees

getDependees

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
DELETE /services/{shortName}/{version}/dependees

deleteAllDependees

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
POST /services/{shortName}/{version}/dependees/{dependeeShortName}/{dependeeVersion}

createNewDependee

Parameters:
  • dependeeShortName (string) – dependeeShortName
  • dependeeVersion (string) – dependeeVersion
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
DELETE /services/{shortName}/{version}/dependees/{dependeeShortName}/{dependeeVersion}

deleteDependee

Parameters:
  • dependeeShortName (string) – dependeeShortName
  • dependeeVersion (string) – dependeeVersion
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
GET /services/{shortName}/{version}/dependencyGraph

getDependencyGraph

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • micoServiceDependencyGraphEdgeList[].sourceShortName (string) – The short name of the source MicoService.
  • micoServiceDependencyGraphEdgeList[].sourceVersion (string) – The version of the source MicoService.
  • micoServiceDependencyGraphEdgeList[].targetShortName (string) – The short name of the target MicoService.
  • micoServiceDependencyGraphEdgeList[].targetVersion (string) – The version of the target MicoService.
  • micoServices[].contact (string) – Human readable contact information for support purposes.
  • micoServices[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • micoServices[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • micoServices[].dockerfilePath (string) – The relative path to the Dockerfile.
  • micoServices[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • micoServices[].name (string) – A human readable name of the MicoService. (required)
  • micoServices[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • micoServices[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • micoServices[].shortName (string) – A unique name of the MicoService. (required)
  • micoServices[].version (string) – The version of this service. Refers to GitHub release tag. (required)
GET /services/{shortName}/{version}/dependers

getDependers

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].contact (string) – Human readable contact information for support purposes.
  • _embedded[].description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • _embedded[].dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • _embedded[].dockerfilePath (string) – The relative path to the Dockerfile.
  • _embedded[].gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • _embedded[].name (string) – A human readable name of the MicoService. (required)
  • _embedded[].owner (string) – Human readable information for the services owner, who is responsible for this service.
  • _embedded[].serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • _embedded[].shortName (string) – A unique name of the MicoService. (required)
  • _embedded[].version (string) – The version of this service. Refers to GitHub release tag. (required)
  • _links[].href (string) –
  • _links[].templated (boolean) –
GET /services/{shortName}/{version}/interfaces

getInterfacesOfService

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _embedded[]._links[].href (string) –
  • _embedded[]._links[].templated (boolean) –
  • _embedded[].description (string) – Human readable description of this service interface. Null values are skipped.
  • _embedded[].ports[].port (integer) – The port number of the externally exposed port. (required)
  • _embedded[].ports[].targetPort (integer) – The port inside the container. (required)
  • _embedded[].ports[].type (string) – The type (protocol) of the port. TCP or UDP. (required)
  • _embedded[].protocol (string) – The protocol of this interface.
  • _embedded[].publicDns (string) – The public DNS.
  • _embedded[].serviceInterfaceName (string) – The name of this MicoServiceInterface (required)
  • _embedded[].transportProtocol (string) – The transport protocol of this interface.
  • _links[].href (string) –
  • _links[].templated (boolean) –
POST /services/{shortName}/{version}/interfaces

createServiceInterface

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • description (string) – Human readable description of this service interface. Null values are skipped.
  • ports[].port (integer) – The port number of the externally exposed port. (required)
  • ports[].targetPort (integer) – The port inside the container. (required)
  • ports[].type (string) – The type (protocol) of the port. TCP or UDP. (required)
  • protocol (string) – The protocol of this interface.
  • publicDns (string) – The public DNS.
  • serviceInterfaceName (string) – The name of this MicoServiceInterface (required)
  • transportProtocol (string) – The transport protocol of this interface.
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • description (string) – Human readable description of this service interface. Null values are skipped.
  • ports[].port (integer) – The port number of the externally exposed port. (required)
  • ports[].targetPort (integer) – The port inside the container. (required)
  • ports[].type (string) – The type (protocol) of the port. TCP or UDP. (required)
  • protocol (string) – The protocol of this interface.
  • publicDns (string) – The public DNS.
  • serviceInterfaceName (string) – The name of this MicoServiceInterface (required)
  • transportProtocol (string) – The transport protocol of this interface.
GET /services/{shortName}/{version}/interfaces/{serviceInterfaceName}

getInterfaceByName

Parameters:
  • serviceInterfaceName (string) – serviceInterfaceName
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • description (string) – Human readable description of this service interface. Null values are skipped.
  • ports[].port (integer) – The port number of the externally exposed port. (required)
  • ports[].targetPort (integer) – The port inside the container. (required)
  • ports[].type (string) – The type (protocol) of the port. TCP or UDP. (required)
  • protocol (string) – The protocol of this interface.
  • publicDns (string) – The public DNS.
  • serviceInterfaceName (string) – The name of this MicoServiceInterface (required)
  • transportProtocol (string) – The transport protocol of this interface.
PUT /services/{shortName}/{version}/interfaces/{serviceInterfaceName}

updateServiceInterface

Parameters:
  • serviceInterfaceName (string) – serviceInterfaceName
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • description (string) – Human readable description of this service interface. Null values are skipped.
  • ports[].port (integer) – The port number of the externally exposed port. (required)
  • ports[].targetPort (integer) – The port inside the container. (required)
  • ports[].type (string) – The type (protocol) of the port. TCP or UDP. (required)
  • protocol (string) – The protocol of this interface.
  • publicDns (string) – The public DNS.
  • serviceInterfaceName (string) – The name of this MicoServiceInterface (required)
  • transportProtocol (string) – The transport protocol of this interface.
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • description (string) – Human readable description of this service interface. Null values are skipped.
  • ports[].port (integer) – The port number of the externally exposed port. (required)
  • ports[].targetPort (integer) – The port inside the container. (required)
  • ports[].type (string) – The type (protocol) of the port. TCP or UDP. (required)
  • protocol (string) – The protocol of this interface.
  • publicDns (string) – The public DNS.
  • serviceInterfaceName (string) – The name of this MicoServiceInterface (required)
  • transportProtocol (string) – The transport protocol of this interface.
DELETE /services/{shortName}/{version}/interfaces/{serviceInterfaceName}

deleteServiceInterface

Parameters:
  • serviceInterfaceName (string) – serviceInterfaceName
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
GET /services/{shortName}/{version}/interfaces/{serviceInterfaceName}/publicIP

getInterfacePublicIpByName

Parameters:
  • serviceInterfaceName (string) – serviceInterfaceName
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • [] (string) –
POST /services/{shortName}/{version}/promote

promoteService

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Request JSON Object:
 
  • version (string) – The version (in semantic version format). (required)
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • contact (string) – Human readable contact information for support purposes.
  • description (string) – Human readable description of this service. Is allowed to be empty (default). Null values are skipped. (required)
  • dockerImageUri (string) – The fully qualified URI to the image on DockerHub.
  • dockerfilePath (string) – The relative path to the Dockerfile.
  • gitCloneUrl (string) – The URL used for a git clone of a GitHub repository, to clone the current master branch.
  • name (string) – A human readable name of the MicoService. (required)
  • owner (string) – Human readable information for the services owner, who is responsible for this service.
  • serviceCrawlingOrigin (string) – Indicates where this service originates from. (read only)
  • shortName (string) – A unique name of the MicoService. (required)
  • version (string) – The version of this service. Refers to GitHub release tag. (required)
GET /services/{shortName}/{version}/status

getStatusOfService

Parameters:
  • shortName (string) – shortName
  • version (string) – version
Status Codes:
Response JSON Object:
 
  • _links[].href (string) –
  • _links[].templated (boolean) –
  • applicationsUsingThisService[].contact (string) – Human readable contact information for support purposes.
  • applicationsUsingThisService[].deploymentStatus (string) – Holds the current deployment status of this application. (read only)
  • applicationsUsingThisService[].description (string) – Human readable description of this application. Is allowed to be empty (default). Null values are skipped. (required)
  • applicationsUsingThisService[].name (string) – Human readable name of the application. (required)
  • applicationsUsingThisService[].owner (string) – Human readable information for the application owner, who is responsible for this application.
  • applicationsUsingThisService[].shortName (string) – Unique short name of the application. (required)
  • applicationsUsingThisService[].version (string) – The version of this application. (required)
  • availableReplicas (integer) – Counter for the number of replicas of the corresponding MicoService that are actually available.
  • errorMessages[] (string) –
  • interfacesInformation[].externalIps[] (string) –
  • interfacesInformation[].name (string) – Name of the MicoServiceInterface.
  • name (string) – Name of the MicoService.
  • nodeMetrics[].averageCpuLoad (integer) – The average CPU load of all pods of one MicoService running on this Node.
  • nodeMetrics[].averageMemoryUsage (integer) – The average memory usage of all pods of one MicoService running on this Node.
  • nodeMetrics[].nodeName (string) – Name of the Kubernetes Node.
  • podsInformation[].hostIp (string) – IP address of the host to which the pod is assigned.
  • podsInformation[].metrics.available (boolean) – Indicates if a pod is available.
  • podsInformation[].metrics.cpuLoad (integer) – CPU load of a pod.
  • podsInformation[].metrics.memoryUsage (integer) – Memory usage of a pod.
  • podsInformation[].nodeName (string) – Name of the node the pod is running on.
  • podsInformation[].phase (string) – States the lifecycle of a pod: Pending, Running, Succeeded, Failed, Unknown, Completed, CrashLoopBackOff
  • podsInformation[].podName (string) – Name of the Pod.
  • podsInformation[].restarts (integer) – Counter for restarts of all containers of a pod.
  • podsInformation[].startTime (string) – The point in time the pod has been started.
  • requestedReplicas (integer) – Counter for the number of replicas of the corresponding MicoService that should be available.
  • shortName (string) – Short name of the MicoService.
  • version (string) – Version of the MicoService.

Method Details (specification)

Specification for how the api should look like.

GET /services/

Example Response:

[
    {
        "id": "...",
        "shortName": "hello-world",
        "version": "0.0.1",
        "name": "Hello World",
        "description": "...",
    },
    {
        "id": "...",
        "shortName": "foo-bar",
        "version": "0.0.14a",
        "name": "FooBar",
        "description": "...",
    }
]
POST /services/

Example Request:

{
    "name": "Hello World",
    "shortName": "hello-world",
    "version": "0.0.1",
    "description": "...",
}

Example Response:

{
    "id": "...",
    "name": "Hello World",
    "shortName": "hello-world",
    "version": "0.0.1",
    "description": "...",
    "...": "...",
}
GET /services/(str: shortName)/
GET /services/(str: shortName)/(str: version)/

Example Response:

{
    "id": "...",
    "name": "Hello World",
    "shortName": "hello-world",
    "version": "0.0.1",
    "description": "...",
    "...": "...",
    "interfaces": [],
    "dependees": [ "// services this service depends on" ],
    "dependers": [ "// services that depend on this service" ],
}
PUT /services/(str: shortName)/(str: version)/
GET /services/(str: shortName)/(str: version)/interfaces/
POST /services/(str: shortName)/(str: version)/interfaces/
GET /services/(str: shortName)/(str: version)/interfaces/(str: shortName)
PUT /services/(str: shortName)/(str: version)/interfaces/(str: shortName)
DELETE /services/(str: shortName)/(str: version)/interfaces/(str: shortName)
GET /services/(str: shortName)/(str: version)/dependees/
POST /services/(str: shortName)/(str: version)/dependees/
DELETE /services/(str: shortName)/(str: version)/dependees/(str: shortName)
GET /services/(str: shortName)/(str: version)/dependers/
POST /services/(str: shortName)/(str: version)/dependers/
DELETE /services/(str: shortName)/(str: version)/dependers/(str: shortName)
GET /services/(str: shortName)/(str: version)/status/
GET /services/import/
POST /services/import/(str: type)/

Example Response

HTTP/1.1 202 Accepted
Location: /jobs/12345
GET /jobs/(str: id)/

Example Response

GET /jobs/12345
HTTP/1.1 200 Ok
{
    "type": "IMPORT",
    "status": "PENDING",
    ...
    "_links": {
        "self": { "href": "/jobs/12345" },
        "cancel": { "method": "DELETE", "href": "/jobs/12345" },
    },
}

Example Response (Finished Job)

HTTP/1.1 303 See Other
Location: /services/{shortName}/{version} // depends on "type"

Note

/applications/ has all service endpoints as well…

GET /applications/(str: shortName)/(str: version)/
{
    "name": "...",
    "description": "...",
    "...": "...",
    "endpoint": {
        // just one "interface description"
    },
    // no dependers, dependees
    "services": [{
        // Service Object
    }]
}
POST /applications/(str: shortName)/(str: version)/deploy/
GET /cluster/*