Skip to content

projectvalidate

get-valid-project-key

Get valid project key

Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

Permissions required: None.

GET /rest/api/3/projectvalidate/validProjectKey

FlagTypeRequiredDescription
--keystringNoThe project key.

Example:

bash
jr projectvalidate get-valid-project-key

get-valid-project-name

Get valid project name

Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

Permissions required: None.

GET /rest/api/3/projectvalidate/validProjectName

FlagTypeRequiredDescription
--namestringNoThe project name.

Example:

bash
jr projectvalidate get-valid-project-name

validate-project-key

Validate project key

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

Permissions required: None.

GET /rest/api/3/projectvalidate/key

FlagTypeRequiredDescription
--keystringNoThe project key.

Example:

bash
jr projectvalidate validate-project-key