marketplace

Get Integration Resource

Changed on

Get a resource by its partner ID.

get/v1/installations/{integrationConfigurationId}/resources/{resourceId}

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/installations/{integrationConfigurationId}/resources/{resourceId}
  • Auth: HTTP bearer

Path parameters

integrationConfigurationIdstring required

The ID of the integration configuration (installation) the resource belongs to

resourceIdstring required

The ID provided by the 3rd party provider for the given resource

Response

billingPlanIdstring

The ID of the billing plan the resource is subscribed to, if applicable

idstring required

The ID provided by the 3rd party provider for the given resource

internalIdstring required

The ID assigned by Vercel for the given resource

metadataobject

The configured metadata for the resource as defined by its product's Metadata Schema

namestring required

The name of the resource as it is recorded in Vercel

productIdstring required

The ID of the product the resource is derived from

status'error' | 'onboarding' | 'pending' | 'ready' | 'resumed' | 'suspended' | 'uninstalled'

The current status of the resource

Changes

  • 8939e3983223Revision changes
    • breaking

      response property customClaims/claimRules/items/claims/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 200

  • dd6a90982ed0Revision changes
    • info

      added the optional property to the response with the status