startPrivateAppRollout
Requires permission settings:apps:manage.
Start rolling out a version of a private app to one installation. A version that asks for more access waits for an admin's approval.
Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.
Example:
- GraphQL
- cURL
mutation StartPrivateAppRollout($input: StartPrivateAppRolloutInputGql!) {
startPrivateAppRollout(input: $input) {
canaryInstallationId
failed
fromVersionId
heldForReview
moved
percent
}
}
curl -X POST "https://<api-host>/graphql" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $ACCESS_TOKEN" \
--data @- <<'EOF'
{
"query": "mutation StartPrivateAppRollout($input: StartPrivateAppRolloutInputGql!) {\n startPrivateAppRollout(input: $input) {\n canaryInstallationId\n failed\n fromVersionId\n heldForReview\n moved\n percent\n }\n}",
"variables": {
"input": {
"appId": "id",
"versionId": "id"
}
}
}
EOF
Variables:
{
"input": {
"appId": "id",
"versionId": "id"
}
}
Response:
{
"data": {
"startPrivateAppRollout": {
"canaryInstallationId": "id",
"failed": 0,
"fromVersionId": "id",
"heldForReview": 0,
"moved": 0,
"percent": 0
}
}
}
startPrivateAppRollout(
input: StartPrivateAppRolloutInputGql!
): AppRolloutResult!
Arguments
startPrivateAppRollout.input ● StartPrivateAppRolloutInputGql! non-null input
The app, the version and the first installation.
Type
AppRolloutResult object
A staged rollout of an app version: one installation, then a percentage, then all.