Skip to content
Docs

Get Resource

Required
GET/v1/installations/{installationId}/resources/{resourceId}
Get a Resource
Vercel calls this endpoint to fetch the current state, secrets, and billing plan of a resource during dashboard rendering and resource sync.
/v1/installations/{installationId}/resources/{resourceId}
const response = await fetch('/v1/installations/installationId/resources/resourceId', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});


const data = await response.json();
console.log(data);
Response
{
  "id": "icfg_1234567890",
  "productId": "example_id",
  "protocolSettings": {
    "experimentation": {
      "edgeConfigSyncingEnabled": "true",
      "edgeConfigId": "example_id",
      "globalConfigId": "example_id",
      "globalConfigSyncingEnabled": "true",
      "edgeConfigTokenId": "example_id"
    },
    "authentication": {
      "appUrls": [
        {
          "url": "https://example.com",
          "target": "development"
        }
      ]
    }
  },
  "billingPlan": {
    "id": "icfg_1234567890",
    "type": "prepayment",
    "name": "Example Name",
    "scope": "installation",
    "description": "string",
    "paymentMethodRequired": "true",
    "preauthorizationAmount": "123",
    "initialCharge": "string",
    "minimumAmount": "100.00",
    "maximumAmount": "100.00",
    "maximumAmountAutoPurchasePerPeriod": "100.00",
    "cost": "string",
    "details": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "highlightedDetails": [
      {
        "label": "string",
        "value": "string"
      }
    ],
    "quote": [
      {
        "line": "string",
        "amount": "100.00"
      }
    ],
    "effectiveDate": "2024-01-01T00:00:00Z",
    "disabled": "true"
  },
  "name": "Example Name",
  "metadata": "value",
  "status": "ready",
  "notification": {
    "level": "info",
    "title": "string",
    "message": "string",
    "href": "https://example.com"
  }
}
Errors
{
  "error": {
    "code": "forbidden",
    "message": "string",
    "user": {
      "message": "string",
      "url": "https://example.com"
    }
  }
}

Authentication

AuthorizationSystem Authentication

Default authentication mechanism

Path parameters

installationIdstringRequired
resourceIdstringRequired

Header parameters

X-Vercel-AuthstringOptional
The auth style used in the request (system, user, etc)

Response

200Return the resource
idstringRequired
The partner-specific ID of the resource
productIdstringRequired
The partner-specific ID/slug of the product. Example: "redis"
protocolSettingsobjectOptional
billingPlanobjectOptional
The billing plan for the resource. If not set, the resource is billed on installation level.
namestringRequired
User-inputted name for the resource.
metadataobjectRequired
User-inputted metadata based on the registered metadata schema.
statusstringRequired
notificationobjectOptional
Resource's active notification. Example: { "level": "warn", "title": "Database is nearing maximum planned size" }

Errors

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