Watch Webinar: Figma - Design to Code in 80% Less Time

Announcing Visual Copilot - Figma to production in half the time

Builder.io logo
Talk to Us
Platform
Developers
Talk to Us

Blog

Home

Resources

Blog

Forum

Github

Login

Signup

×

Visual CMS

Drag-and-drop visual editor and headless CMS for any tech stack

Theme Studio for Shopify

Build and optimize your Shopify-hosted storefront, no coding required

Resources

Blog

Get StartedLogin

When you need a model that is only privately accessible, you can adjust the configuration of your model, use a Private API Key, as well as the Content API to ensure privacy.

By default, Builder Page, Section, and Data models are publicly readable.

Tip: When setting a model to be private, consider whether you want all entries of that model to be private. If some of them need to be publicly readable, create a model specifically for private content entries.

To make a model private:

  1. Go to Models.
  2. Open your page model.
  3. Go to Advanced.
  4. Switch the Public Readable toggle to off.
  5. Click Save.
  6. Create content entries from this model for any that you'd like to be private.

The following video shows how to toggle off the Public Readable setting for a Page model, but you can change this setting on any kind of model.

To leverage a private model, you need to create a Private API Key in your Organization Settings. Follow the instructions in the Managing Private Keys section of the API Keys documentation.

When you have your Private API Key, continue with the instructions below.

Use the Content API with your Private API key with the following code, where you replace these values with your own:

  1. modelName
  2. yourPublicAPIKey
  3. yourPrivateAPIKey
let apiUrl = 'https://cdn.builder.io/api/v2/content'
let modelName = 'private-page'
let content = await request(`${apiUrl}/${modelName}?apiKey=${yourPublicAPIKey}&limit=1&userAttributes.urlPath=/some-page`, {
  headers: { Authorization: `Bearer ${yourPrivateAPIKey}` },
})

Next, pass the JSON to render as needed; for example as in this React snippet for a model named private-page:

let page = content.results[0];

if (page) {
  return <BuilderComponent model="private-page" content={page} />
}

Models are a foundational part of Builder that you can customize to countless use cases. For more information on what you can do with models, refer to the following documentation:

Was this article helpful?

Product

Visual CMS

Theme Studio for Shopify

Sign up

Login

Featured Integrations

React

Angular

Next.js

Gatsby

Get In Touch

Chat With Us

Twitter

Linkedin

Careers

© 2020 Builder.io, Inc.

Security

Privacy Policy

Terms of Service

Newsletter

Get the latest from Builder.io

By submitting, you agree to our Privacy Policy