Skip to content
Docs

Update Resource

PATCH/__remote/api.vercel.com/v1/installations/{integrationConfigurationId}/resources/{resourceId}
This endpoint updates an existing resource in the installation. All parameters are optional, allowing partial updates.
/__remote/api.vercel.com/v1/installations/{integrationConfigurationId}/resources/{resourceId}
const response = await fetch('/__remote/api.vercel.com/v1/installations/integrationConfigurationId/resources/resourceId', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "ownership": "owned",
    "name": "Example Name",
    "status": "ready",
    "metadata": "value",
    "billingPlan": {
      "id": "icfg_1234567890",
      "type": "prepayment",
      "name": "Example Name",
      "description": "string",
      "paymentMethodRequired": "true",
      "cost": "string",
      "details": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "highlightedDetails": [
        {
          "label": "string",
          "value": "string"
        }
      ],
      "effectiveDate": "string"
    },
    "notification": {
      "level": "info",
      "title": "string",
      "message": "string",
      "href": "https://example.com"
    },
    "extras": "value",
    "secrets": [
      {
        "name": "Example Name",
        "value": "string",
        "prefix": "string",
        "environmentOverrides": {
          "development": "string",
          "preview": "string",
          "production": "string"
        }
      }
    ],
    "customClaims": {
      "roles": [],
      "defaultRole": "string",
      "claimRules": [
        {
          "when": {
            "role": [],
            "environment": []
          },
          "claims": "value"
        }
      ]
    },
    "credentialTypes": []
  }),
});


const data = await response.json();
console.log(data);
Response
{
  "name": "Example Name"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

integrationConfigurationIdstringRequired
resourceIdstringRequired

Request

This endpoint expects an object.

ownershipstringOptional
namestringOptional
statusstringOptional
metadataobjectOptional
billingPlanobjectOptional
notificationobjectOptional
extrasobjectOptional
secretsobjectOptional
customClaimsobjectOptional
Custom claims embedded in the resource tokens Edgenivo mints for this resource.
credentialTypesarrayOptional
The credential types the resource accepts: static for long-lived secrets, oidc for Edgenivo resource OIDC tokens. Can be set freely while the resource has none. After that, only to confirm a change Edgenivo requested with a secrets rotation, once it is complete. Without static, all long-lived secrets must be expired and removed, and no new ones minted or injected.

Response

200Success
namestringRequired

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
404Error
409Error
410Error