Update App Install

Change the version a workspace runs (an upgrade or a roll back to another published version), who sees the app on their rail, its monthly budget, or whether it is on. Requires workspace admin access. Workspace API keys return 403; use a personal API key or scoped OAuth token.

OAuth scope: api:write.

PATCH/api/v2/apps/installs/{installId}
X-API-Key<token>

Your Agent Serve API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Path Parameters

installId*string

Install identifier.

Length1 <= length <= 64

Request Body

application/json

Settings to change.

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://agentserve.valnoraelric.com/api/v2/apps/installs/string" \  -H "X-API-Key: YOUR_API_KEY" \  -H "Content-Type: application/json" \  -d '{    "workspaceId": "string"  }'
{
  "data": {
    "install": {
      "id": "string",
      "workspaceId": "string",
      "appId": "string",
      "slug": "string",
      "title": "string",
      "versionId": "string",
      "version": "string",
      "status": "active",
      "pages": [
        {
          "id": "string",
          "title": "string"
        }
      ],
      "permissions": {
        "tables": [
          "string"
        ],
        "model": "read",
        "workflows": [
          "string"
        ],
        "relays": [
          "string"
        ],
        "chat": "ask",
        "files": "read",
        "ai": {
          "models": [
            "string"
          ],
          "media": [
            "image"
          ]
        },
        "knowledge": [
          "string"
        ],
        "integrations": [
          "string"
        ]
      },
      "pinnedFor": {
        "roles": [
          "read"
        ],
        "groupIds": [
          "string"
        ]
      },
      "budgetMonthlyUsd": 0,
      "budgetSource": "install",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z"
    },
    "previousVersion": "string",
    "rolledBack": true
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "CONFLICT",
    "message": "The request conflicts with the current state of the resource"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Request body must be sent as application/json"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}