Project key and name validation

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/2/projectvalidate/key

Request

  • Base URL: https://your-domain.atlassian.net
  • URL: https://your-domain.atlassian.net/rest/api/2/projectvalidate/key
  • Auth: one of:
    • HTTP basic
    • OAuth 2 (authorization code, authorization URL https://auth.atlassian.com/authorize, token URL https://auth.atlassian.com/oauth/token, scopes: read:jira-work)

Query parameters

keystring
Example:HSP

The project key.

Response

Returned if the request is successful.

errorMessagesstring[]

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

errorsobject

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."

statusinteger

Changes

No recorded changes to this operation across all 26 revisions of this API.