Activate an app version

POST

/v1/apps/:id/activate

POST

/v1/apps/:id/activate

$ curl -X POST https://api.runtype.com/v1/apps/id/activate \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "versionId": "v123e4567-e89b-12d3-a456-426614174000"
> }'

1 {
2   "app": {
3     "activeVersionId": "v123e4567-e89b-12d3-a456-426614174000",
4     "clientTokenId": "ctk789e0123-f45b-67d8-a901-234567890abc",
5     "createdAt": "2024-05-20T10:15:30Z",
6     "description": "Customer-facing web application for product catalog",
7     "hostname": "app-prod.runtype.com",
8     "id": "app123e4567-e89b-12d3-a456-426614174000",
9     "name": "ProductCatalogApp",
10     "shortId": "pcapp01",
11     "slug": "product-catalog-app",
12     "status": "active",
13     "updatedAt": "2024-06-01T08:45:00Z",
14     "url": "https://product-catalog.runtype.com",
15     "visibility": "public"
16   },
17   "version": {
18     "appId": "app123e4567-e89b-12d3-a456-426614174000",
19     "bundleHash": "a1b2c3d4e5f67890123456789abcdef0",
20     "createdAt": "2024-05-19T09:00:00Z",
21     "createdBy": "user789e4567-e89b-12d3-a456-426614174000",
22     "fileCount": 42,
23     "id": "v123e4567-e89b-12d3-a456-426614174000",
24     "manifest": {
25       "auth": "required",
26       "capabilities": {
27         "agents": [
28           "email-notifier",
29           "data-sync-agent"
30         ],
31         "flows": [
32           "user-registration",
33           "order-processing"
34         ]
35       },
36       "data": [
37         {
38           "access": "read-write",
39           "namespace": "user_profiles"
40         },
41         {
42           "access": "read",
43           "namespace": "product_inventory"
44         }
45       ],
46       "name": "v1.0.0",
47       "description": "Initial release with user registration and order processing flows"
48     },
49     "sizeBytes": 10485760,
50     "status": "active",
51     "versionNumber": 1
52   }
53 }

Flip the active-version pointer to the given version (deploy or rollback). Syncs the app client token to the manifest capabilities and updates edge routing.

Authentication

AuthorizationBearer

API key or Clerk session token

Path parameters

idstringRequired

Request

This endpoint expects an object.

versionIdstringRequired

Response

Activated

appobject

versionobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error