API docs by Redocly

rApp Manager (1.0)

Download OpenAPI specification:Download

License: Copyright (C) 2023 OpenInfra Foundation Europe. Licensed under the Apache License.

The rApp Manager is a lifecycle management service for rApps. It gets the rApp as ASD formatted package and lifecycle manages it based on it instance configuration.

rApp

API for rApps

Get specific rApp details

path Parameters
rapp_id
required
string

Responses

Prime/Deprime rApp

path Parameters
rapp_id
required
string
Request Body schema: application/json
primeOrder
string
Enum: "PRIME" "DEPRIME"

Responses

Request samples

Content type
application/json
{
  • "primeOrder": "PRIME"
}

Create rApp

path Parameters
rapp_id
required
string
Request Body schema: multipart/form-data
file
string <binary>

Responses

Delete rApp

path Parameters
rapp_id
required
string

Responses

Get All rApps

Responses

rApp Instance

API for rApp Instances

Get specific rApp instance details

path Parameters
rapp_id
required
string
rapp_instance_id
required
string <uuid>

Responses

Deploy/Undeploy rApp instance

path Parameters
rapp_id
required
string
rapp_instance_id
required
string <uuid>
Request Body schema: application/json
deployOrder
string
Enum: "DEPLOY" "UNDEPLOY"

Responses

Request samples

Content type
application/json
{
  • "deployOrder": "DEPLOY"
}

Delete rApp instance

path Parameters
rapp_id
required
string
rapp_instance_id
required
string <uuid>

Responses

Get all instances of rApp

path Parameters
rapp_id
required
string

Responses

Create rApp instance

path Parameters
rapp_id
required
string
Request Body schema: application/json
rappInstanceId
string <uuid>
state
string
Enum: "DEPLOYED" "DEPLOYING" "UNDEPLOYED" "UNDEPLOYING"
reason
string
object (RappACMInstance)
object (RappSMEInstance)
object (RappDMEInstance)

Responses

Request samples

Content type
application/json
{
  • "rappInstanceId": "fa410192-bcfe-406c-8981-2193ea094480",
  • "state": "DEPLOYED",
  • "reason": "string",
  • "acm": {
    },
  • "sme": {
    },
  • "dme": {
    }
}