174 lines
5.3 KiB
Markdown
174 lines
5.3 KiB
Markdown
---
|
|
name: organizations-routes
|
|
description: Handle 14 OpenAPI operation(s) under /organizations for the organizations route group.
|
|
---
|
|
|
|
# organizations API Routes
|
|
|
|
Handle 14 OpenAPI operation(s) under /organizations for the organizations 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
|
|
|
|
### orgs_list
|
|
|
|
- Operation ID: `orgs_list`
|
|
- Route: `GET /organizations`
|
|
- Mode: READ
|
|
- Summary: List organizations
|
|
- Parameters:
|
|
- `since` in `query`
|
|
- `per_page` in `query`
|
|
|
|
### actions_get_actions_cache_retention_limit_for_organization
|
|
|
|
- Operation ID: `actions_get_actions_cache_retention_limit_for_organization`
|
|
- Route: `GET /organizations/{org}/actions/cache/retention-limit`
|
|
- Mode: READ
|
|
- Summary: Get GitHub Actions cache retention limit for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
|
|
### actions_set_actions_cache_retention_limit_for_organization
|
|
|
|
- Operation ID: `actions_set_actions_cache_retention_limit_for_organization`
|
|
- Route: `PUT /organizations/{org}/actions/cache/retention-limit`
|
|
- Mode: WRITE
|
|
- Summary: Set GitHub Actions cache retention limit for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### actions_get_actions_cache_storage_limit_for_organization
|
|
|
|
- Operation ID: `actions_get_actions_cache_storage_limit_for_organization`
|
|
- Route: `GET /organizations/{org}/actions/cache/storage-limit`
|
|
- Mode: READ
|
|
- Summary: Get GitHub Actions cache storage limit for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
|
|
### actions_set_actions_cache_storage_limit_for_organization
|
|
|
|
- Operation ID: `actions_set_actions_cache_storage_limit_for_organization`
|
|
- Route: `PUT /organizations/{org}/actions/cache/storage-limit`
|
|
- Mode: WRITE
|
|
- Summary: Set GitHub Actions cache storage limit for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### billing_get_github_billing_ai_credit_usage_report_org
|
|
|
|
- Operation ID: `billing_get_github_billing_ai_credit_usage_report_org`
|
|
- Route: `GET /organizations/{org}/settings/billing/ai_credit/usage`
|
|
- Mode: READ
|
|
- Summary: Get billing AI credit usage report for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `year` in `query`
|
|
- `month` in `query`
|
|
- `day` in `query`
|
|
- `user` in `query`
|
|
- `model` in `query`
|
|
- `product` in `query`
|
|
|
|
### billing_get_all_budgets_org
|
|
|
|
- Operation ID: `billing_get_all_budgets_org`
|
|
- Route: `GET /organizations/{org}/settings/billing/budgets`
|
|
- Mode: READ
|
|
- Summary: Get all budgets for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `page` in `query`
|
|
- `per_page` in `query`
|
|
- `scope` in `query`
|
|
- `user` in `query`
|
|
|
|
### billing_create_organization_budget
|
|
|
|
- Operation ID: `billing_create_organization_budget`
|
|
- Route: `POST /organizations/{org}/settings/billing/budgets`
|
|
- Mode: WRITE
|
|
- Summary: Create a budget for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### billing_get_budget_org
|
|
|
|
- Operation ID: `billing_get_budget_org`
|
|
- Route: `GET /organizations/{org}/settings/billing/budgets/{budget_id}`
|
|
- Mode: READ
|
|
- Summary: Get a budget by ID for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `budget_id` in `path` required
|
|
|
|
### billing_update_budget_org
|
|
|
|
- Operation ID: `billing_update_budget_org`
|
|
- Route: `PATCH /organizations/{org}/settings/billing/budgets/{budget_id}`
|
|
- Mode: WRITE
|
|
- Summary: Update a budget for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `budget_id` in `path` required
|
|
- Body: JSON request body accepted.
|
|
|
|
### billing_delete_budget_org
|
|
|
|
- Operation ID: `billing_delete_budget_org`
|
|
- Route: `DELETE /organizations/{org}/settings/billing/budgets/{budget_id}`
|
|
- Mode: WRITE
|
|
- Summary: Delete a budget for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `budget_id` in `path` required
|
|
|
|
### billing_get_github_billing_premium_request_usage_report_org
|
|
|
|
- Operation ID: `billing_get_github_billing_premium_request_usage_report_org`
|
|
- Route: `GET /organizations/{org}/settings/billing/premium_request/usage`
|
|
- Mode: READ
|
|
- Summary: Get billing premium request usage report for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `year` in `query`
|
|
- `month` in `query`
|
|
- `day` in `query`
|
|
- `user` in `query`
|
|
- `model` in `query`
|
|
- `product` in `query`
|
|
|
|
### billing_get_github_billing_usage_report_org
|
|
|
|
- Operation ID: `billing_get_github_billing_usage_report_org`
|
|
- Route: `GET /organizations/{org}/settings/billing/usage`
|
|
- Mode: READ
|
|
- Summary: Get billing usage report for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `year` in `query`
|
|
- `month` in `query`
|
|
- `day` in `query`
|
|
|
|
### billing_get_github_billing_usage_summary_report_org
|
|
|
|
- Operation ID: `billing_get_github_billing_usage_summary_report_org`
|
|
- Route: `GET /organizations/{org}/settings/billing/usage/summary`
|
|
- Mode: READ
|
|
- Summary: Get billing usage summary for an organization
|
|
- Parameters:
|
|
- `org` in `path` required
|
|
- `year` in `query`
|
|
- `month` in `query`
|
|
- `day` in `query`
|
|
- `repository` in `query`
|
|
- `product` in `query`
|
|
- `sku` in `query`
|