Create a new SDK key for a project

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/sdk-keys/create

Generates a new SDK key and, optionally, a secret for a specified project and environment. This key is then used by the Convert SDKs to authenticate and fetch project configurations. If has_secret is true and no sdk_secret is provided, a secret will be auto-generated. The SDK secret (if generated) is only shown at the time of creation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to be retrieved

Body Params

Contains the name for the new SDK key, the target environment (e.g., 'production', 'staging') it applies to, and a boolean has_secret indicating if an SDK secret should be generated for secure SDK authentication.

Request payload for creating a new SDK key. The SDK key will be automatically generated upon creation and returned in the response. Required fields must be provided to successfully create the key.

name

string

required

length ≤ 100

A user-defined, friendly name for the SDK key to help identify its purpose or the application/service using it (e.g., "Production Backend API", "Staging iOS App").

environment

string

required

The specific environment within the Full Stack project that this SDK key is associated with (e.g., "production", "development", "staging"). The SDK will fetch configurations relevant to this environment. This must match one of the environments defined at the project level. KB: "The Environments Feature".

status

string

enum

Defaults to enabled

Indicates whether the SDK key is active and can be used for API authentication. When disabled, all requests using this key will be rejected.

Allowed:

selected_default

boolean

If true, this SDK key is marked as the default for its environment within the project. Only one SDK key can be default per project environment. When a key is set as default, any previously default key for the same environment will be automatically unset.

has_secret

boolean

Defaults to true

Whether the SDK key should have a secret key. When true, a secret key will be generated and returned in the response.

Responses

201Details of a single SDK key, including its name, the key string itself, the environment it's for, and whether it uses a secret for authentication. The secret is only shown in full upon creation if auto-generated.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.