134 lines
3.6 KiB
Markdown
134 lines
3.6 KiB
Markdown
---
|
|
name: app-routes
|
|
description: Handle 13 OpenAPI operation(s) under /app for the app route group.
|
|
---
|
|
|
|
# app API Routes
|
|
|
|
Handle 13 OpenAPI operation(s) under /app for the app route group.
|
|
|
|
Use the generated operation tools to make real API calls. Do not invent API responses.
|
|
If a tool reports missing setup, return the exact setup field name to the caller.
|
|
For write, update, or delete operations, state the intended action before calling the tool.
|
|
|
|
## Operations
|
|
|
|
### apps_get_authenticated
|
|
|
|
- Operation ID: `apps_get_authenticated`
|
|
- Route: `GET /app`
|
|
- Mode: READ
|
|
- Summary: Get the authenticated app
|
|
|
|
### apps_get_webhook_config_for_app
|
|
|
|
- Operation ID: `apps_get_webhook_config_for_app`
|
|
- Route: `GET /app/hook/config`
|
|
- Mode: READ
|
|
- Summary: Get a webhook configuration for an app
|
|
|
|
### apps_update_webhook_config_for_app
|
|
|
|
- Operation ID: `apps_update_webhook_config_for_app`
|
|
- Route: `PATCH /app/hook/config`
|
|
- Mode: WRITE
|
|
- Summary: Update a webhook configuration for an app
|
|
- Body: JSON request body accepted.
|
|
|
|
### apps_list_webhook_deliveries
|
|
|
|
- Operation ID: `apps_list_webhook_deliveries`
|
|
- Route: `GET /app/hook/deliveries`
|
|
- Mode: READ
|
|
- Summary: List deliveries for an app webhook
|
|
- Parameters:
|
|
- `per_page` in `query`
|
|
- `cursor` in `query`
|
|
- `status` in `query`
|
|
|
|
### apps_get_webhook_delivery
|
|
|
|
- Operation ID: `apps_get_webhook_delivery`
|
|
- Route: `GET /app/hook/deliveries/{delivery_id}`
|
|
- Mode: READ
|
|
- Summary: Get a delivery for an app webhook
|
|
- Parameters:
|
|
- `delivery_id` in `path` required
|
|
|
|
### apps_redeliver_webhook_delivery
|
|
|
|
- Operation ID: `apps_redeliver_webhook_delivery`
|
|
- Route: `POST /app/hook/deliveries/{delivery_id}/attempts`
|
|
- Mode: WRITE
|
|
- Summary: Redeliver a delivery for an app webhook
|
|
- Parameters:
|
|
- `delivery_id` in `path` required
|
|
|
|
### apps_list_installation_requests_for_authenticated_app
|
|
|
|
- Operation ID: `apps_list_installation_requests_for_authenticated_app`
|
|
- Route: `GET /app/installation-requests`
|
|
- Mode: READ
|
|
- Summary: List installation requests for the authenticated app
|
|
- Parameters:
|
|
- `per_page` in `query`
|
|
- `page` in `query`
|
|
|
|
### apps_list_installations
|
|
|
|
- Operation ID: `apps_list_installations`
|
|
- Route: `GET /app/installations`
|
|
- Mode: READ
|
|
- Summary: List installations for the authenticated app
|
|
- Parameters:
|
|
- `per_page` in `query`
|
|
- `page` in `query`
|
|
- `since` in `query`
|
|
- `outdated` in `query`
|
|
|
|
### apps_get_installation
|
|
|
|
- Operation ID: `apps_get_installation`
|
|
- Route: `GET /app/installations/{installation_id}`
|
|
- Mode: READ
|
|
- Summary: Get an installation for the authenticated app
|
|
- Parameters:
|
|
- `installation_id` in `path` required
|
|
|
|
### apps_delete_installation
|
|
|
|
- Operation ID: `apps_delete_installation`
|
|
- Route: `DELETE /app/installations/{installation_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete an installation for the authenticated app
|
|
- Parameters:
|
|
- `installation_id` in `path` required
|
|
|
|
### apps_create_installation_access_token
|
|
|
|
- Operation ID: `apps_create_installation_access_token`
|
|
- Route: `POST /app/installations/{installation_id}/access_tokens`
|
|
- Mode: WRITE
|
|
- Summary: Create an installation access token for an app
|
|
- Parameters:
|
|
- `installation_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### apps_suspend_installation
|
|
|
|
- Operation ID: `apps_suspend_installation`
|
|
- Route: `PUT /app/installations/{installation_id}/suspended`
|
|
- Mode: WRITE
|
|
- Summary: Suspend an app installation
|
|
- Parameters:
|
|
- `installation_id` in `path` required
|
|
|
|
### apps_unsuspend_installation
|
|
|
|
- Operation ID: `apps_unsuspend_installation`
|
|
- Route: `DELETE /app/installations/{installation_id}/suspended`
|
|
- Mode: WRITE
|
|
- Summary: Unsuspend an app installation
|
|
- Parameters:
|
|
- `installation_id` in `path` required
|