v1

latestOpenAPI 3.0.02026-07-13103151174.7 KB

Environments

Generate SDK Keys

Generate new SDK keys for an environment, for any or all of the SDK types. This is the expected and recommended way to rotate SDK keys. Adding a new SDK key will not invalidate existing SDK keys. Generating new keys is restricted for protected environments to those with Publisher permissions

post/v1/projects/{project}/environments/{environment}/sdk-keys

Path parameters

environmentstring required

An Environment key or ID

projectstring required

A Project key or ID

Request body

clientboolean

serverboolean

mobileboolean

Response

namestring required

A unique display name

keystring required

Unique Environment identifier, can be used in the SDK / API to reference by key rather than ID. Must only contain lower-case characters and _, - or ..

descriptionstring

Environment description.

colorstring

Environment display color, used to highlight different environments on the dashboard. Must use Hex color code.

_idstring required

A unique Environment ID

_projectstring required

The Project owning the Environment

type'development' | 'staging' | 'production' | 'disaster_recovery' required

The environment type

_createdBystring required

ID of the User who created the Environment.

createdAtstring date-time required

The date the Environment was created

updatedAtstring date-time required

The date the Environment was last updated

readonlyboolean required

Controls whether the environment is editable for a given user

Example response

{
  "name": "Staging Upcoming",
  "key": "staging-upcoming",
  "description": "Pre-production changes",
  "color": "#4073FF",
  "_id": "61450f3daec96f5cf4a49946",
  "type": "staging"
}