Tenant API (v1)

tenant

postTenant

Create tenant job (create, upgrade, delete)

Request Body schema: application/json

module_from	string Existing module ID. If omitted, the module is not enabled already
module_to	string Target module ID. If omitted, the existing module is disabled
purge	boolean Default: true On disable should data also be purged
parameters	object (parameters) List of key/value parameters

Responses

Request samples

Payload

Content type

application/json

Example

Upgrading module for tenant

{"module_to": "mod-sample-1.3.1",
"module_from": "mod-sample-1.0.2",
"parameters": [{"key": "loadReference",
"value": true
},
{"key": "loadSample",
"value": true
}
]
}

Response samples

400
422
500

Content type

application/json

"string"

getTenant

Does tenant id already exist

path Parameters

operationId

required

string

Operation ID