List Resources (Deprecated)

APIs & SDKs

Deprecated

GET/v1/installations/{installationId}/resources

Lists all Resources. This endpoint has been deprecated.

This endpoint is deprecated. New integrations don't need to implement it. Vercel stores resource state locally after provisioning and uses Get Resource for per-resource lookups instead.

/v1/installations/{installationId}/resources

const response = await fetch('/v1/installations/installationId/resources?productId=string&ids=[]', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "resources": [
    {
      "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

Query parameters

productIdstringRequired

idsarrayOptional

Header parameters

X-Vercel-AuthstringOptional

The auth style used in the request (system, user, etc)

Response

200Return a list of Resources for a given Installation

resourcesarrayRequired

Errors

403Operation failed because the authentication is not allowed to perform this operation

errorobjectRequired

Related Vercel documentation

This page is not in the current cross-link map.

/v1/installations/{installationId}/resources

const response = await fetch('/v1/installations/installationId/resources?productId=string&ids=[]', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

Response

{
  "resources": [
    {
      "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"
    }
  }
}

OpenAPI Specification