Suspend an app installation

PUT

/app/installations/{installation_id}/suspended

Suspends a GitHub App on a user, organization, or enterprise account, which blocks the app from accessing the account’s resources. When a GitHub App is suspended, the app’s access to the GitHub API or webhook events is blocked for that account.

You must use a JWT to access this endpoint.

API method documentation

Parameters

Path Parameters

installation_id

required

integer

The unique identifier of the installation.

Examples

Example default

1

Responses

204

Response

404

Resource not found

Media type application/json

Basic Error

Basic Error

object

message

string

documentation_url

string

url

string

status

string

Example ^generated

{
  "message": "example",
  "documentation_url": "example",
  "url": "example",
  "status": "example"
}