Validate project key

GET

/rest/api/3/projectvalidate/key

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

Permissions required: None.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://jira.local:8080/jira/rest//rest/api/3/projectvalidate/key'

Response Example

200 - Success

{"errorMessages":[],"errors":{"projectKey":"A project with that project key already exists."}}

Request

Query Params

key

string

optional

The project key.

Responses

🟢200Returned if the request is successful.

application/json

Body

Error messages from an operation.

errorMessages

array[string]

optional

The list of error messages produced by this operation. For example, "input parameter 'key' must be provided"

errors

object

optional

The list of errors by parameter returned by the operation. For example,"projectKey": "Project keys must start with an uppercase letter, followed by one or more uppercase alphanumeric characters."

Additional properties

string

optional

status

integer <int32>

optional

🟠401Returned if the authentication credentials are incorrect.

Modified at 2023-07-13 03:27:27

Delete project category

Get valid project key