Skip to content
Docs

Resource REPL

Optional
POST/v1/installations/{installationId}/resources/{resourceId}/repl
The REPL is a command-line interface on the Store Details page that allows customers to directly interact with their resource. This endpoint is used to run commands on a specific resource.
Needed if your integration provides an interactive console or REPL experience. Vercel calls this endpoint to run commands or queries against a resource from the dashboard.
/v1/installations/{installationId}/resources/{resourceId}/repl
const response = await fetch('/v1/installations/installationId/resources/resourceId/repl', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "input": "string",
    "readOnly": "true"
  }),
});


const data = await response.json();
console.log(data);
Response
[
  {
    "type": "paragraph",
    "children": [
      {
        "type": "text",
        "text": "string",
        "color": "string",
        "bold": "true",
        "italic": "true",
        "href": "string"
      }
    ]
  }
]
Errors
{
  "error": {
    "code": "forbidden",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    }
  }
}

Authentication

AuthorizationUser Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired
resourceIdstringRequired

Header parameters

X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)
Idempotency-KeystringOptional
A unique key to identify a request across multiple retries

Request

This endpoint expects an object.

inputstringRequired
readOnlybooleanOptional

Response

200Return result of running REPL command

Errors

403Operation failed because the authentication is not allowed to perform this operation
errorobjectRequired
Resource REPL | Partner API