Create a new white label

Create a new white label

Create a new white label

POSThttps://studio.edgeimpulse.com/v1/api/whitelabels

Body

application/json

name*string

The name of the white label.

Example: "Octopus's Garden"

domain*string

The domain where the white label lives.

Example: "underthesea.com"

ownerOrganizationId*integer

identityProvidersarray of string

The list of allowed identity providers.

Example: "[google, okta, github]"

allowPasswordAuthboolean

Whether this white label accepts password based authentication.

deploymentTargetsarray of string

The list of deployment targets to show on the UI

Example: "['C++ library', 'Arduino library', 'Arduino Nano 33 BLE Sense']"

documentationUrlstring

Custom documentation URL

Example: "https://docs.edgeimpulse.com/renesas/"

allowSignupboolean

Whether this white label allow sign ups or not.

allowFreeProjectsboolean

Whether this white label allows the creation of free projects.

sandboxedboolean

Whether this white label should work in sandboxed mode or not.

exposePublicProjectsboolean

Whether public projects created in this white label scope should be exposed through the Public Projects API or not.

learningBlocksarray of string

The list of learning block types to show on the UI

Example: "['keras']"

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

id*integer

Unique whitelabel identifier

themeId*integer

Unique identifier for the theme associated with the white label

Request

JavaScriptCurl

const response = await fetch('https://studio.edgeimpulse.com/v1/api/whitelabels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "Octopus's Garden",
      "domain": "underthesea.com"
    }),
});
const data = await response.json();

Response

{
  "success": false,
  "error": "text"
}