362 lines
10 KiB
Markdown
362 lines
10 KiB
Markdown
---
|
|
name: apps-routes
|
|
description: Handle 38 OpenAPI operation(s) under /v2/apps for the apps route group.
|
|
---
|
|
|
|
# apps API Routes
|
|
|
|
Handle 38 OpenAPI operation(s) under /v2/apps for the apps 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
|
|
|
|
### get_v2_apps
|
|
|
|
- Operation ID: `get_v2_apps`
|
|
- Route: `GET /v2/apps`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps
|
|
|
|
### post_v2_apps
|
|
|
|
- Operation ID: `post_v2_apps`
|
|
- Route: `POST /v2/apps`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps
|
|
|
|
### delete_v2_apps_id
|
|
|
|
- Operation ID: `delete_v2_apps_id`
|
|
- Route: `DELETE /v2/apps/{id}`
|
|
- Mode: WRITE
|
|
- Summary: delete_/v2/apps/{id}
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### get_v2_apps_id
|
|
|
|
- Operation ID: `get_v2_apps_id`
|
|
- Route: `GET /v2/apps/{id}`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{id}
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### put_v2_apps_id
|
|
|
|
- Operation ID: `put_v2_apps_id`
|
|
- Route: `PUT /v2/apps/{id}`
|
|
- Mode: WRITE
|
|
- Summary: put_/v2/apps/{id}
|
|
- Parameters:
|
|
- `id` in `path` required
|
|
|
|
### post_v2_apps_app_id_restart
|
|
|
|
- Operation ID: `post_v2_apps_app_id_restart`
|
|
- Route: `POST /v2/apps/{app_id}/restart`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/restart
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_components_component_name_logs
|
|
|
|
- Operation ID: `get_v2_apps_app_id_components_component_name_logs`
|
|
- Route: `GET /v2/apps/{app_id}/components/{component_name}/logs`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/components/{component_name}/logs
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `component_name` in `path` required
|
|
|
|
### get_v2_apps_app_id_components_component_name_exec
|
|
|
|
- Operation ID: `get_v2_apps_app_id_components_component_name_exec`
|
|
- Route: `GET /v2/apps/{app_id}/components/{component_name}/exec`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/components/{component_name}/exec
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `component_name` in `path` required
|
|
|
|
### get_v2_apps_app_id_instances
|
|
|
|
- Operation ID: `get_v2_apps_app_id_instances`
|
|
- Route: `GET /v2/apps/{app_id}/instances`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/instances
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_deployments
|
|
|
|
- Operation ID: `get_v2_apps_app_id_deployments`
|
|
- Route: `GET /v2/apps/{app_id}/deployments`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/deployments
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_deployments
|
|
|
|
- Operation ID: `post_v2_apps_app_id_deployments`
|
|
- Route: `POST /v2/apps/{app_id}/deployments`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/deployments
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_deployments_deployment_id
|
|
|
|
- Operation ID: `get_v2_apps_app_id_deployments_deployment_id`
|
|
- Route: `GET /v2/apps/{app_id}/deployments/{deployment_id}`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/deployments/{deployment_id}
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `deployment_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_deployments_deployment_id_cancel
|
|
|
|
- Operation ID: `post_v2_apps_app_id_deployments_deployment_id_cancel`
|
|
- Route: `POST /v2/apps/{app_id}/deployments/{deployment_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/deployments/{deployment_id}/cancel
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `deployment_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_deployments_deployment_id_components_component_name_logs
|
|
|
|
- Operation ID: `get_v2_apps_app_id_deployments_deployment_id_components_component_name_logs`
|
|
- Route: `GET /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/logs
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `deployment_id` in `path` required
|
|
- `component_name` in `path` required
|
|
|
|
### get_v2_apps_app_id_deployments_deployment_id_logs
|
|
|
|
- Operation ID: `get_v2_apps_app_id_deployments_deployment_id_logs`
|
|
- Route: `GET /v2/apps/{app_id}/deployments/{deployment_id}/logs`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/deployments/{deployment_id}/logs
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `deployment_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_deployments_deployment_id_components_component_name_exec
|
|
|
|
- Operation ID: `get_v2_apps_app_id_deployments_deployment_id_components_component_name_exec`
|
|
- Route: `GET /v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/deployments/{deployment_id}/components/{component_name}/exec
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `deployment_id` in `path` required
|
|
- `component_name` in `path` required
|
|
|
|
### get_v2_apps_app_id_logs
|
|
|
|
- Operation ID: `get_v2_apps_app_id_logs`
|
|
- Route: `GET /v2/apps/{app_id}/logs`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/logs
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_job_invocations
|
|
|
|
- Operation ID: `get_v2_apps_app_id_job_invocations`
|
|
- Route: `GET /v2/apps/{app_id}/job-invocations`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/job-invocations
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_job_invocations_job_invocation_id
|
|
|
|
- Operation ID: `get_v2_apps_app_id_job_invocations_job_invocation_id`
|
|
- Route: `GET /v2/apps/{app_id}/job-invocations/{job_invocation_id}`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/job-invocations/{job_invocation_id}
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `job_invocation_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_job_invocations_job_invocation_id_cancel
|
|
|
|
- Operation ID: `post_v2_apps_app_id_job_invocations_job_invocation_id_cancel`
|
|
- Route: `POST /v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/job-invocations/{job_invocation_id}/cancel
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `job_invocation_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_jobs_job_name_invocations_job_invocation_id_logs
|
|
|
|
- Operation ID: `get_v2_apps_app_id_jobs_job_name_invocations_job_invocation_id_logs`
|
|
- Route: `GET /v2/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/jobs/{job_name}/invocations/{job_invocation_id}/logs
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `job_name` in `path` required
|
|
- `job_invocation_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_events
|
|
|
|
- Operation ID: `get_v2_apps_app_id_events`
|
|
- Route: `GET /v2/apps/{app_id}/events`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/events
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_events_event_id
|
|
|
|
- Operation ID: `get_v2_apps_app_id_events_event_id`
|
|
- Route: `GET /v2/apps/{app_id}/events/{event_id}`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/events/{event_id}
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `event_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_events_event_id_cancel
|
|
|
|
- Operation ID: `post_v2_apps_app_id_events_event_id_cancel`
|
|
- Route: `POST /v2/apps/{app_id}/events/{event_id}/cancel`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/events/{event_id}/cancel
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `event_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_events_event_id_logs
|
|
|
|
- Operation ID: `get_v2_apps_app_id_events_event_id_logs`
|
|
- Route: `GET /v2/apps/{app_id}/events/{event_id}/logs`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/events/{event_id}/logs
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `event_id` in `path` required
|
|
|
|
### get_v2_apps_tiers_instance_sizes
|
|
|
|
- Operation ID: `get_v2_apps_tiers_instance_sizes`
|
|
- Route: `GET /v2/apps/tiers/instance_sizes`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/tiers/instance_sizes
|
|
|
|
### get_v2_apps_tiers_instance_sizes_slug
|
|
|
|
- Operation ID: `get_v2_apps_tiers_instance_sizes_slug`
|
|
- Route: `GET /v2/apps/tiers/instance_sizes/{slug}`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/tiers/instance_sizes/{slug}
|
|
- Parameters:
|
|
- `slug` in `path` required
|
|
|
|
### get_v2_apps_regions
|
|
|
|
- Operation ID: `get_v2_apps_regions`
|
|
- Route: `GET /v2/apps/regions`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/regions
|
|
|
|
### post_v2_apps_propose
|
|
|
|
- Operation ID: `post_v2_apps_propose`
|
|
- Route: `POST /v2/apps/propose`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/propose
|
|
|
|
### get_v2_apps_app_id_alerts
|
|
|
|
- Operation ID: `get_v2_apps_app_id_alerts`
|
|
- Route: `GET /v2/apps/{app_id}/alerts`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/alerts
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_alerts_alert_id_destinations
|
|
|
|
- Operation ID: `post_v2_apps_app_id_alerts_alert_id_destinations`
|
|
- Route: `POST /v2/apps/{app_id}/alerts/{alert_id}/destinations`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/alerts/{alert_id}/destinations
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
- `alert_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_rollback
|
|
|
|
- Operation ID: `post_v2_apps_app_id_rollback`
|
|
- Route: `POST /v2/apps/{app_id}/rollback`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/rollback
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_rollback_validate
|
|
|
|
- Operation ID: `post_v2_apps_app_id_rollback_validate`
|
|
- Route: `POST /v2/apps/{app_id}/rollback/validate`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/rollback/validate
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_rollback_commit
|
|
|
|
- Operation ID: `post_v2_apps_app_id_rollback_commit`
|
|
- Route: `POST /v2/apps/{app_id}/rollback/commit`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/rollback/commit
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### post_v2_apps_app_id_rollback_revert
|
|
|
|
- Operation ID: `post_v2_apps_app_id_rollback_revert`
|
|
- Route: `POST /v2/apps/{app_id}/rollback/revert`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/{app_id}/rollback/revert
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### get_v2_apps_app_id_metrics_bandwidth_daily
|
|
|
|
- Operation ID: `get_v2_apps_app_id_metrics_bandwidth_daily`
|
|
- Route: `GET /v2/apps/{app_id}/metrics/bandwidth_daily`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/metrics/bandwidth_daily
|
|
- Parameters:
|
|
- `app_id` in `path` required
|
|
|
|
### post_v2_apps_metrics_bandwidth_daily
|
|
|
|
- Operation ID: `post_v2_apps_metrics_bandwidth_daily`
|
|
- Route: `POST /v2/apps/metrics/bandwidth_daily`
|
|
- Mode: WRITE
|
|
- Summary: post_/v2/apps/metrics/bandwidth_daily
|
|
|
|
### get_v2_apps_app_id_health
|
|
|
|
- Operation ID: `get_v2_apps_app_id_health`
|
|
- Route: `GET /v2/apps/{app_id}/health`
|
|
- Mode: READ
|
|
- Summary: get_/v2/apps/{app_id}/health
|
|
- Parameters:
|
|
- `app_id` in `path` required
|