Function: validateProjectKey()

function validateProjectKey(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  errorMessages?: string[];
  errors?: Record<string, string>;
  status?: number;
}>;

Defined in: src/cloud/api/projectKeyAndNameValidation.ts:13

Validates a project key by confirming the key is a valid string and not in use.

Permissions required: None.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ key?: string; }	-
parameters.key?	string	The project key.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; errorMessages?: string[]; errors?: Record<string, string>; status?: number; }>