Request a staging for an app installation

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

API version

v2

Request method

POST

Operation ID

app-request-appinstallation-staging

---

Request

• appInstallationIdstring (uuid)

  required

Responses

Format

application/json

Description

The AppInstallation staging has been requested.

Schema documentation

• idstring (uuid)

  required

Example

Content-Type: application/json

{
  "id": "f0f86186-0a5a-45b2-aa33-502777496347"
}

JSON Schema

{
  "properties": {
    "id": {
      "format": "uuid",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"description":"string","domain":"string","installationPath":"string"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/app-installations/f0f86186-0a5a-45b2-aa33-502777496347/actions/staging

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.requestAppinstallationStaging({
  "appInstallationId": "f0f86186-0a5a-45b2-aa33-502777496347",
  "data": {
    "description": "string",
    "domain": "string",
    "installationPath": "string"
  }
});

assertStatus(response, 201);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\App\RequestAppinstallationStaging\RequestAppinstallationStagingRequest;
use \Mittwald\ApiClient\Generated\V2\Clients\App\RequestAppinstallationStaging\RequestAppinstallationStagingRequestBody;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

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

$request = (new RequestAppinstallationStagingRequest(
  appInstallationId: "f0f86186-0a5a-45b2-aa33-502777496347",
  body: $body
));
$response = $client->app()->requestAppinstallationStaging($request);

var_dump($response->getBody();