Trigger a runtime action belonging to an app installation

POST /v2/app-installations/{appInstallationId}/actions/{action}/

API version

v2

Request method

POST

Operation ID

app-execute-action

---

Request

• appInstallationIdstring

  required
• actionstring (one of: start, stop, restart)

  required

Responses

No response content specified.

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/app-installations/string/actions/start

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.app.executeAction({
  "appInstallationId": "string",
  "action": "start",
  "data": {}
});

assertStatus(response, 204);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\App\ExecuteAction\ExecuteActionRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\App\ExecuteAction\ExecuteActionRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

// TODO: Please consult the properties and constructor signature of
// ExecuteActionRequestBody to learn how to construct a valid instance
$body = new ExecuteActionRequestBody(/* TODO: ... */);

$request = (new ExecuteActionRequest(
  appInstallationId: "string",
  action: "start",
  body: $body
));
$response = $client->app()->executeAction($request);

var_dump($response->getBody();