rollbackPrivateAppRollout

Requires permission settings:apps:manage.

Roll back a rollout: every installation on the new version returns to the earlier one.

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

mutation RollbackPrivateAppRollout($appId: ID!) {
  rollbackPrivateAppRollout(appId: $appId) {
    canaryInstallationId
    failed
    fromVersionId
    moved
    percent
    stage
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation RollbackPrivateAppRollout($appId: ID!) {\n  rollbackPrivateAppRollout(appId: $appId) {\n    canaryInstallationId\n    failed\n    fromVersionId\n    moved\n    percent\n    stage\n  }\n}",
  "variables": {
    "appId": "id"
  }
}
EOF

Variables:

{
  "appId": "id"
}

Response:

{
  "data": {
    "rollbackPrivateAppRollout": {
      "canaryInstallationId": "id",
      "failed": 0,
      "fromVersionId": "id",
      "moved": 0,
      "percent": 0,
      "stage": "string"
    }
  }
}

rollbackPrivateAppRollout(
  appId: ID!
): AppRolloutResult!

Arguments

rollbackPrivateAppRollout.appId ● ID! non-null scalar

The private app.

Type

AppRolloutResult object

A staged rollout of an app version: one installation, then a percentage, then all.