@timbenniks/contentstack-endpoints

A utility package that provides Contentstack API endpoints based on cloud provider and region. This package helps you easily get the correct API endpoints for different Contentstack environments and regions.

Beware: this is open source and maintained by @timbenniks and it's not officially supported contentstack. Support questions go to @timbenniks directly.

Installation

npm install @timbenniks/contentstack-endpoints

Usage

ESM (recommended)

import { getContentstackEndpoints } from "@timbenniks/contentstack-endpoints";

// Get default North America endpoints
const naEndpoints = getContentstackEndpoints();
console.log(naEndpoints.contentDelivery); // https://cdn.contentstack.io

// Get Azure Europe endpoints
const azureEuEndpoints = getContentstackEndpoints(Region.AZURE_EU);
console.log(azureEuEndpoints.contentDelivery); // https://azure-eu-cdn.contentstack.com

CommonJS

const {
  getContentstackEndpoints,
} = require("@timbenniks/contentstack-endpoints");

// Get default North America endpoints
const naEndpoints = getContentstackEndpoints();
console.log(naEndpoints.contentDelivery); // https://cdn.contentstack.io

API

getContentstackEndpoints(region?: Region, omitHttps: boolean): ContentstackEndpoints

Returns an object containing all Contentstack API endpoints for the specified cloud and region.

Parameters

• region as Region.US, Region.EU, Region.AZURE_NA, Region.AZURE_EU, or Region.GCP_NA
• omitHttps as boolean

Returns

An object containing the following endpoints:

• contentDelivery: Content Delivery API endpoint
• contentManagement: Content Management API endpoint
• imageDelivery: Image Delivery API endpoint
• assets: Assets API endpoint
• automate: Automate API endpoint (not available for GCP)
• graphql: GraphQL API endpoint
• graphqlPreview: GraphQL Preview API endpoint
• brandKit: Brand Kit API endpoint
• brandKitGenAI: Brand Kit GenAI and Knowledge Vault endpoint
• personalizeManagement: Personalize Management API endpoint
• personalizeEdge: Personalize Edge API endpoint
• application: Contentstack web application
• preview: REST Preview API endpoint

License

MIT