Cloud

Jira Cloud platform / Reference / REST API v3

Project key and name validation

This resource provides validation for project keys and names.

Operations

GET/rest/api/3/projectvalidate/key GET/rest/api/3/projectvalidate/validProjectKey GET/rest/api/3/projectvalidate/validProjectName

GET

Validate project key

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

Permissions required: None.

Data Security Policy: Exempt from app access rules

Scopes

OAuth 2.0 scopes required:

ClassicRECOMMENDED:read:jira-work

Granular:read:project:jira

Connect app scope required: READ

Request

Query parameters

key

string

Responses

Returned if the request is successful.

application/json

ErrorCollection

Error messages from an operation.

GET/rest/api/3/projectvalidate/key

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestJira(route`/rest/api/3/projectvalidate/key?key=HSP`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

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

GET

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.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

Request

Query parameters

key

string

Responses

Returned if the request is successful.

application/json

string

GET/rest/api/3/projectvalidate/validProjectKey

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication
import api, { route } from "@forge/api";

const response = await api.requestJira(route`/rest/api/3/projectvalidate/validProjectKey?key=HSP`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

"VPNE"

GET

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.

Data Security Policy: Exempt from app access rules

Scopes

Connect app scope required: READ

Request

Query parameters

name

string

Required

Responses

Returned if the request is successful.

application/json

string

GET/rest/api/3/projectvalidate/validProjectName

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
//
// This API resource doesn't support Oauth2 (3LO). See alternate authorization methods:
// https://developer.atlassian.com/cloud/jira/platform/rest/v3/#authentication
import api, { route } from "@forge/api";

const response = await api.requestJira(route`/rest/api/3/projectvalidate/validProjectName?name={name}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

200Response

"Valid Project Name Example"