القائمة
Use when a user, student or academy staff needs to request, list, view, or deprovision a VPS via the API (including staff requesting a VPS on behalf of a student); do NOT use for granting VPS credits via plans or payments.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Use when building or operating a staff frontend to list, schedule, sync, or recover academy GitHub organization memberships; do NOT use for Copilot seats, provisioning bills, or staff/student invites unrelated to GitHub org membership.
Load first for academy-scoped BreatheCode API work (/academy/, Academy header, staff capabilities). Maps requests to domain skills. Do NOT use for pure learner self-service without staff context — use breathecode-student-api-index instead.
Use when academy staff need to list or view certificate specialties, create or update academy-owned specialties, link a syllabus to a specialty, or assign a specialty to a student by issuing a certificate; do NOT use for listing a student's own certificates (use certificate me endpoint).
Use when an authenticated student needs to check LLM budget entitlement, list LiteLLM API keys and per-key spend, create a new LLM API key, or delete an existing key; do NOT use for academy staff configuring LiteLLM vendors or teams, VPS provisioning, or granting LLM budget through plans.
Load first for authenticated learner BreatheCode API work (user-scoped /me and user/me routes, public join/catalog where applicable). Maps requests to domain skills. Do NOT use for academy admin tasks requiring /academy/ or the Academy header — use breathecode-staff-api-index instead.
Use when academy staff need to set main currency and create, list, update, or deprecate checkout payment methods; do NOT use for Stripe credential setup when is_credit_card is true (use bc-payments-configure-academy-stripe first), student card save, or subscription cancel/refund.
| name | bc-provisioning-manage-vps-server |
| description | Use when a user, student or academy staff needs to request, list, view, or deprovision a VPS via the API (including staff requesting a VPS on behalf of a student); do NOT use for granting VPS credits via plans or payments. |
| requires | [] |
Use this skill when the user asks to request a VPS, list my VPSs, get VPS connection details (including root password), list academy VPSs, request a VPS for a student (staff), or deprovision a student's VPS — all via the API. Do not use when the user only asks how to configure vendor credentials or create/update provisioning profiles — use bc-provisioning-settings-and-credentials for that. Do not use for granting VPS credits through plans or subscriptions.
PENDING, PROVISIONING, ACTIVE, ERROR, DELETED. At most one active (or pending/provisioning) VPS per user per academy.vps_server with balance greater than zero. One request consumes one unit. The API does not grant credits; they are managed via plans/subscriptions or other APIs.vendor_settings (e.g. Hostinger: item_ids, template_ids, data_center_ids) using POST/PUT .../provisioningacademy — not top-level fields like allowed_template_ids.Student: list my VPSs. Call GET /v1/provisioning/me/vps. Use returned id values for details.
Academy staff: fetch vendor options (unfiltered universe) first (when the VPS vendor requires selection). Call GET /v1/provisioning/academy/provisioningacademy/<provisioning_academy_id>/vendor-options with Authorization and Academy: <academy_id>. Hostinger: use catalog_items, templates, data_centers. DigitalOcean: use regions, sizes, images. Save only the allowed slugs/IDs into the academy config (vendor_settings) per vendor via PUT /v1/provisioning/academy/provisioningacademy/<provisioning_academy_id> (see bc-provisioning-settings-and-credentials). VPS requests must use vendor_selection values that match those allowlists.
Student: request a new VPS. Call POST /v1/provisioning/me/vps with optional plan_slug and optional nested vendor_selection. Hostinger: item_id, template_id, data_center_id. DigitalOcean: region_slug, size_slug, image_slug. Values must come from the allowlists in academy vendor_settings.
Student: get one VPS (including root password). Call GET /v1/provisioning/me/vps/<vps_id>. Only the owner gets root_password.
Academy: list all VPSs. Call GET /v1/provisioning/academy/vps with headers Authorization and Academy: <academy_id>. Optional query: user_id=<user_id>.
Academy: request a VPS for a student (staff). Call POST /v1/provisioning/academy/vps with headers Authorization and Academy: <academy_id>. Body requires user_id; supports optional plan_slug and optional nested vendor_selection.
Academy: deprovision a VPS. Call DELETE /v1/provisioning/academy/vps/<vps_id> with headers Authorization and Academy: <academy_id>.
Prerequisite: Vendor, academy profile, and credentials must already be configured. If the user has no academy or the academy has no VPS configuration, the API returns errors; tell the user setup must be completed first. VPS credits are managed via plans/subscriptions or other APIs, not this one.
| Action | Method | Path | Headers | Body / Query | Response |
|---|---|---|---|---|---|
| List my VPSs | GET | /v1/provisioning/me/vps | Authorization | — | List of VPSs; see response sample. |
| Request a VPS | POST | /v1/provisioning/me/vps | Authorization | Optional; supports plan_slug and nested vendor_selection. | 202 Accepted, VPS object; see response sample. |
| Get one VPS (with password) | GET | /v1/provisioning/me/vps/<vps_id> | Authorization | — | VPS detail including root_password for owner; see response sample. |
| List academy VPSs | GET | /v1/provisioning/academy/vps | Authorization, Academy: <academy_id> | Optional: ?user_id=<user_id> | List of VPSs for academy (no root_password). |
| Request VPS for student | POST | /v1/provisioning/academy/vps | Authorization, Academy: <academy_id> | user_id required; optional plan_slug and nested vendor_selection. | 202 Accepted, VPS object (no root_password). |
| Deprovision VPS | DELETE | /v1/provisioning/academy/vps/<vps_id> | Authorization, Academy: <academy_id> | — | 204 No Content. |
| Get academy vendor options | GET | /v1/provisioning/academy/provisioningacademy/<provisioning_academy_id>/vendor-options | Authorization, Academy: <academy_id> | — | Hostinger: catalog_items, templates, data_centers (raw payloads). DigitalOcean: regions, sizes, images (raw payloads). Other vendors may return empty objects. |
Request a VPS — request Hostinger (POST /v1/provisioning/me/vps):
{
"plan_slug": "default",
"vendor_selection": {
"item_id": "12345",
"template_id": 101,
"data_center_id": 7
}
}
Request a VPS — request DigitalOcean (POST /v1/provisioning/me/vps):
{
"plan_slug": "default",
"vendor_selection": {
"region_slug": "nyc1",
"size_slug": "s-1vcpu-1gb",
"image_slug": "ubuntu-22-04-x64"
}
}
Body is optional; omit vendor_selection to let backend auto-pick when an allowlist has exactly one option (per dimension).
Request a VPS — response (202 Accepted):
{
"id": 100,
"status": "PENDING",
"hostname": "",
"ip_address": null,
"ssh_user": "",
"ssh_port": 22,
"plan_slug": "default",
"error_message": "",
"requested_at": "2026-03-26T15:20:00Z",
"provisioned_at": null,
"deleted_at": null,
"created_at": "2026-03-26T15:20:00Z",
"updated_at": "2026-03-26T15:20:00Z"
}
Later the VPS may move to ACTIVE or ERROR; use GET to fetch updated details and root_password when ACTIVE.
Request VPS for student — request Hostinger (POST /v1/provisioning/academy/vps):
{
"user_id": 50,
"plan_slug": "default",
"vendor_selection": {
"item_id": "12345",
"template_id": 101,
"data_center_id": 7
}
}
Request VPS for student — request DigitalOcean (POST /v1/provisioning/academy/vps):
{
"user_id": 50,
"plan_slug": "default",
"vendor_selection": {
"region_slug": "nyc1",
"size_slug": "s-1vcpu-1gb",
"image_slug": "ubuntu-22-04-x64"
}
}
Get academy vendor options — Hostinger example (GET /v1/provisioning/academy/provisioningacademy/<provisioning_academy_id>/vendor-options):
{
"catalog_items": [
{
"id": "hostingercom-vps-kvm1",
"name": "KVM 1",
"category": "VPS",
"metadata": {"cpus": "1", "memory": "4096", "bandwidth": "4096000", "disk_space": "51200", "network": "300"},
"prices": [
{"id": "hostingercom-vps-kvm1-usd-1m", "name": "KVM 1 (billed every month)", "currency": "USD", "price": 1949, "first_period_price": 999, "period": 1, "period_unit": "month"}
]
}
],
"templates": [
{
"id": 1007,
"name": "Ubuntu 22.04 LTS",
"description": "Ubuntu is a complete Linux operating system...",
"documentation": null
}
],
"data_centers": [
{
"id": 11,
"name": "bnk",
"location": "lt",
"city": "Vilnius",
"continent": "Europe"
}
]
}
Get academy vendor options — DigitalOcean example (same path; vendor is DigitalOcean):
{
"regions": [
{"slug": "nyc1", "name": "New York 1", "available": true}
],
"sizes": [
{"slug": "s-1vcpu-1gb", "memory": 1024, "vcpus": 1}
],
"images": [
{"slug": "ubuntu-22-04-x64", "distribution": "Ubuntu", "name": "22.04 x64"}
]
}
Get one VPS — response (GET /v1/provisioning/me/vps/<vps_id>, owner only):
{
"id": 100,
"status": "ACTIVE",
"hostname": "vps-100.example.com",
"ip_address": "192.168.1.10",
"ssh_user": "root",
"ssh_port": 22,
"root_password": "generated-secret-password",
"plan_slug": "default",
"error_message": "",
"requested_at": "2026-03-26T15:20:00Z",
"provisioned_at": "2026-03-26T15:25:00Z",
"deleted_at": null,
"created_at": "2026-03-26T15:20:00Z",
"updated_at": "2026-03-26T15:25:00Z"
}
Base path for all: /v1/provisioning/. Academy endpoints require capability crud_provisioning_activity.
vps_server consumable with balance > 0. Tell the user they need VPS credits (via plan/subscription or other API); this API does not grant credits.Academy header. Tell the staff user the student must have an active profile or cohort membership in that academy.user_id does not match any user.vendor-options and retry using only allowed IDs.vendor-options and retry.vendor_settings for DigitalOcean is missing region_slugs, size_slugs, or image_slugs. Tell staff to configure allowlists first.GET /v1/provisioning/me/vps or POST /v1/provisioning/me/vps with Authorization.GET /v1/provisioning/me/vps/<vps_id> as the owning user.GET /v1/provisioning/academy/provisioningacademy/<provisioning_academy_id>/vendor-options first, then send selected IDs in nested vendor_selection.GET /v1/provisioning/academy/vps with Authorization and Academy: <academy_id> (user must have crud_provisioning_activity).POST /v1/provisioning/academy/vps with Authorization, Academy: <academy_id>, and body user_id plus optional nested vendor_selection; consumes the student’s vps_server credit.DELETE /v1/provisioning/academy/vps/<vps_id> with Authorization and Academy: <academy_id>.