VTEX Developer Portal

VTEX Resource Name (VRN)

VTEX Resource Name (VRN)

A VTEX Resource Name (VRN) is how the VTEX IO platform expresses the resource path called in a request.

A resource can be accessed by sending a request to its Uniform Resource Locator (URL). However, the resource concept is broad, and, to name a few, a resource can be a proxy, an API segment, an app endpoint, etc.

Therefore, in VTEX IO, we identify and express a resource by using a VRN, which structure carries essential information about the resource itself and the context in which it is being accessed.

The format of a VRN is vrn:{service}:{region}:{account}:{workspace}:{path} whose elements can be described as:

  • service - the infrastructure service that holds the app's information.
  • region - the region from where the request was performed.
  • account - the VTEX account responsible for performing the request.
  • workspace - the workspace used to perform a request.
  • path - the resource URL or endpoint.

Examples of real VRNs are:

  • vrn:apps:aws-us-east-1:vtex:example:/v2/apps (for a VTEX IO app)
  • vrn:proxy:aws-us-east-1:vtex:example:api.visa.com/merchantlocator/v1/locator (for an external service)

When performing a request for external services (outside VTEX IO), remember to provide the full URL in the path element and also to define proxy in service.

As in vrn:apps:aws-us-east-1:vtex:example:/v2/apps/*, a VRN may contain wildcards (*) to represent any value or variable. However, for security reasons, the wildcard is NOT allowed to replace the VTEX account name responsible for performing the request.

Updated 7 days ago


VTEX Resource Name (VRN)


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.