# Shipyard API

**Canonical:** https://apis.io/apis/shipyard/shipyard-api/  
**Provider:** Shipyard — https://apis.io/providers/shipyard/  
**Base URL:** https://shipyard.build  
**Documentation:** https://docs.stackgen.com/platform/1/settings/api/aiden-apis.md

Shipyard API is one of 2 APIs that [Shipyard](https://apis.io/providers/shipyard/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Shipyard API as documented publicly: 33 operations. Contract generated from the documentation by API Evangelist (2026-10-29); not the provider's own document.

## Operations (33)

| Method | Path | Summary |
|---|---|---|
| GET | `/Homebrew/install/HEAD/install.sh` | GET /Homebrew/install/HEAD/install.sh |
| GET | `/OpsVerseIO/installers/main/prometheus-exporters/{prometheusexporterid}` | GET /OpsVerseIO/installers/main/prometheus-exporters/install-exporter-amd64.sh |
| POST | `/api/v1/application-build/${app_build_uuid}/detached-app-build` | POST /api/v1/application-build/${app_build_uuid}/detached-app-build |
| POST | `/api/v1/ask` | POST /api/v1/ask |
| GET | `/api/v1/context` | GET /api/v1/context |
| POST | `/api/v1/context` | POST /api/v1/context |
| GET | `/api/v1/environment` | GET /api/v1/environment |
| POST | `/api/v1/environment/${YOUR_API_TOKEN}` | POST /api/v1/environment/${YOUR_API_TOKEN} |
| GET | `/api/v1/environment/${app_uuid}` | GET /api/v1/environment/${app_uuid} |
| GET | `/api/v1/environment/${app_uuid}/build-history` | GET /api/v1/environment/${app_uuid}/build-history |
| POST | `/api/v1/environment/${app_uuid}/cancel` | POST /api/v1/environment/${app_uuid}/cancel |
| GET | `/api/v1/environment/${app_uuid}/env-vars` | GET /api/v1/environment/${app_uuid}/env-vars |
| PUT | `/api/v1/environment/${app_uuid}/env-vars` | PUT /api/v1/environment/${app_uuid}/env-vars |
| DELETE | `/api/v1/environment/${app_uuid}/env-vars/{databaseurl}` | DELETE /api/v1/environment/${app_uuid}/env-vars/{databaseUrl} |
| POST | `/api/v1/environment/${app_uuid}/rebuild` | POST /api/v1/environment/${app_uuid}/rebuild |
| POST | `/api/v1/environment/${app_uuid}/restart` | POST /api/v1/environment/${app_uuid}/restart |
| POST | `/api/v1/environment/${app_uuid}/revive` | POST /api/v1/environment/${app_uuid}/revive |
| POST | `/api/v1/environment/${app_uuid}/snapshot-load` | POST /api/v1/environment/${app_uuid}/snapshot-load |
| POST | `/api/v1/environment/${app_uuid}/stop` | POST /api/v1/environment/${app_uuid}/stop |
| GET | `/api/v1/integrations` | GET /api/v1/integrations |
| POST | `/api/v1/integrations` | POST /api/v1/integrations |
| DELETE | `/api/v1/integrations/550e8400-e29b-41d4-a716-446655440000` | DELETE /api/v1/integrations/550e8400-e29b-41d4-a716-446655440000 |
| GET | `/api/v1/integrations/550e8400-e29b-41d4-a716-446655440000` | GET /api/v1/integrations/550e8400-e29b-41d4-a716-446655440000 |
| PATCH | `/api/v1/integrations/550e8400-e29b-41d4-a716-446655440000` | PATCH /api/v1/integrations/550e8400-e29b-41d4-a716-446655440000 |
| GET | `/api/v1/skills` | GET /api/v1/skills |
| POST | `/api/v1/skills` | POST /api/v1/skills |
| DELETE | `/api/v1/skills/550e8400-e29b-41d4-a716-446655440000` | DELETE /api/v1/skills/550e8400-e29b-41d4-a716-446655440000 |
| GET | `/api/v1/skills/550e8400-e29b-41d4-a716-446655440000` | GET /api/v1/skills/550e8400-e29b-41d4-a716-446655440000 |
| PATCH | `/api/v1/skills/550e8400-e29b-41d4-a716-446655440000` | PATCH /api/v1/skills/550e8400-e29b-41d4-a716-446655440000 |
| DELETE | `/appcd/api/v1/auth/pairedApiKey` | Remove the currently associated paired PAT token. |
| POST | `/appcd/api/v1/auth/pairedApiKey` | Create (or regenerate) a paired Personal Access Token (PAT) with a new TTL. |
| GET | `/install.sh` | GET /install.sh |
| GET | `/stackgenhq/stackgen-cli/main/scripts/download-stackgen.sh` | GET /stackgenhq/stackgen-cli/main/scripts/download-stackgen.sh |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/shipyard/openapi/_ae-authored/shipyard-openapi-generated.yml
- **JSONSchema** — https://artifacts.apis.io/shipyard/json-schema/shipyard-get-api-v1-environment-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/shipyard/json-schema/shipyard-post-appcd-api-v1-auth-pairedapikey-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/shipyard/json-schema/shipyard-get-api-v1-environment-app-uuid-env-vars-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/shipyard/json-schema/shipyard-post-api-v1-environment-app-uuid-cancel-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/shipyard/json-schema/shipyard-post-api-v1-environment-app-uuid-rebuild-response-schema.json
- **JSONSchema** — https://artifacts.apis.io/shipyard/json-schema/shipyard-post-api-v1-environment-app-uuid-revive-response-schema.json

## Other Shipyard APIs (1)

- [Shipyard API](https://apis.io/apis/shipyard/shipyard-api-2/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/shipyard/shipyard-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/shipyard/.