ReferenceApps

Install app

Install an app based on the blueprint ID

POST
/apps/install
AuthorizationBearer <token>

Bearer token authentication. Use your API key as the bearer token.

In: header

Install app input

artifactId?string

ArtifactID is the ID of the artifact containing the blueprint to install. If provided, BlueprintID must be nil. The artifact must be of kind "blueprint".

blueprintId?string

BlueprintID is the ID of the blueprint to install directly. If provided, ArtifactID must be nil.

spaceId?string

SpaceID is the ID of the space where the app should be installed. If not provided, the app will be installed in the current context space. The space must belong to the requesting organization.

Response Body

curl -X POST "https://eu1.api.bivariant.com/v1/apps/install" \  -H "Content-Type: application/json" \  -d '{}'
{
  "blueprintId": "string",
  "createdAt": "string",
  "description": "string",
  "id": "string",
  "organizationId": "string",
  "projectId": "string",
  "spaceId": "string",
  "title": "string",
  "uid": "string",
  "updatedAt": "string"
}
{
  "code": "string",
  "message": "string"
}
{
  "code": "string",
  "message": "string"
}
{
  "code": "string",
  "message": "string"
}
{
  "code": "string",
  "message": "string"
}