Create project

POST

/rest/api/3/project

Projects

Creates a project based on a project type template, as shown in the following table:

Project Type Key	Project Template Key
`business`	`com.atlassian.jira-core-project-templates:jira-core-simplified-content-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-document-approval`, `com.atlassian.jira-core-project-templates:jira-core-simplified-lead-tracking`, `com.atlassian.jira-core-project-templates:jira-core-simplified-process-control`, `com.atlassian.jira-core-project-templates:jira-core-simplified-procurement`, `com.atlassian.jira-core-project-templates:jira-core-simplified-project-management`, `com.atlassian.jira-core-project-templates:jira-core-simplified-recruitment`, `com.atlassian.jira-core-project-templates:jira-core-simplified-task-tracking`
`service_desk`	`com.atlassian.servicedesk:simplified-it-service-management`, `com.atlassian.servicedesk:simplified-general-service-desk-it`, `com.atlassian.servicedesk:simplified-general-service-desk-business`, `com.atlassian.servicedesk:simplified-external-service-desk`, `com.atlassian.servicedesk:simplified-hr-service-desk`, `com.atlassian.servicedesk:simplified-facilities-service-desk`, `com.atlassian.servicedesk:simplified-legal-service-desk`, `com.atlassian.servicedesk:simplified-analytics-service-desk`, `com.atlassian.servicedesk:simplified-marketing-service-desk`, `com.atlassian.servicedesk:simplified-design-service-desk`, `com.atlassian.servicedesk:simplified-sales-service-desk`, `com.atlassian.servicedesk:simplified-finance-service-desk`
`software`	`com.pyxis.greenhopper.jira:gh-simplified-agility-kanban`, `com.pyxis.greenhopper.jira:gh-simplified-agility-scrum`, `com.pyxis.greenhopper.jira:gh-simplified-basic`, `com.pyxis.greenhopper.jira:gh-simplified-kanban-classic`, `com.pyxis.greenhopper.jira:gh-simplified-scrum-classic`
The project types are available according to the installed Jira features as follows:

Jira Core, the default, enables business projects.

Jira Service Management enables service_desk projects.

Jira Software enables software projects.

To determine which features are installed, go to Jira settings > Apps > Manage apps and review the System Apps list. To add Jira Software or Jira Service Management into a JIRA instance, use Jira settings > Apps > Finding new apps. For more information, see Managing add-ons.

Permissions required: Administer Jira global permission.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'http://jira.local:8080/jira/rest//rest/api/3/project' \
--header 'Content-Type: application/json' \
--data-raw '{
    "assigneeType": "PROJECT_LEAD",
    "avatarId": 10200,
    "categoryId": 10120,
    "description": "Cloud migration initiative",
    "issueSecurityScheme": 10001,
    "key": "EX",
    "leadAccountId": "5b10a0effa615349cb016cd8",
    "name": "Example",
    "notificationScheme": 10021,
    "permissionScheme": 10011,
    "projectTemplateKey": "com.atlassian.jira-core-project-templates:jira-core-simplified-process-control",
    "projectTypeKey": "business",
    "url": "http://atlassian.com"
}'

Response Example

201 - Success

{
  "self": "https://your-domain.atlassian.net/jira/rest/api/3/project/10042",
  "id": 10010,
  "key": "EX"
}

Request

Body Params application/json

Details about the project.

assigneeType

enum<string>

optional

The default assignee when creating issues for this project.

Allowed values:

PROJECT_LEADUNASSIGNED

avatarId

integer <int64>

optional

An integer value for the project's avatar.

categoryId

integer <int64>

optional

The ID of the project's category. A complete list of category IDs is found using the Get all project categories operation.

description

string

optional

A brief description of the project.

fieldConfigurationScheme

integer <int64>

optional

The ID of the field configuration scheme for the project. Use the Get all field configuration schemes operation to get a list of field configuration scheme IDs. If you specify the field configuration scheme you cannot specify the project template key.

issueSecurityScheme

integer <int64>

optional

The ID of the issue security scheme for the project, which enables you to control who can and cannot view issues. Use the Get issue security schemes resource to get all issue security scheme IDs.

issueTypeScheme

integer <int64>

optional

The ID of the issue type scheme for the project. Use the Get all issue type schemes operation to get a list of issue type scheme IDs. If you specify the issue type scheme you cannot specify the project template key.

issueTypeScreenScheme

integer <int64>

optional

The ID of the issue type screen scheme for the project. Use the Get all issue type screen schemes operation to get a list of issue type screen scheme IDs. If you specify the issue type screen scheme you cannot specify the project template key.

key

string

required

Project keys must be unique and start with an uppercase letter followed by one or more uppercase alphanumeric characters. The maximum length is 10 characters.

lead

string

optional

This parameter is deprecated because of privacy changes. Use leadAccountId instead. See the migration guide for details. The user name of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with leadAccountId.

leadAccountId

string

optional

The account ID of the project lead. Either lead or leadAccountId must be set when creating a project. Cannot be provided with lead.

<= 128 characters

name

string

required

The name of the project.

notificationScheme

integer <int64>

optional

The ID of the notification scheme for the project. Use the Get notification schemes resource to get a list of notification scheme IDs.

permissionScheme

integer <int64>

optional

The ID of the permission scheme for the project. Use the Get all permission schemes resource to see a list of all permission scheme IDs.

projectTemplateKey

enum<string>

optional

A predefined configuration for a project. The type of the projectTemplateKey must match with the type of the projectTypeKey.

Allowed values:

com.pyxis.greenhopper.jira:gh-simplified-agility-kanbancom.pyxis.greenhopper.jira:gh-simplified-agility-scrumcom.pyxis.greenhopper.jira:gh-simplified-basiccom.pyxis.greenhopper.jira:gh-simplified-kanban-classiccom.pyxis.greenhopper.jira:gh-simplified-scrum-classiccom.pyxis.greenhopper.jira:gh-cross-team-templatecom.atlassian.servicedesk:simplified-it-service-managementcom.atlassian.servicedesk:simplified-general-service-deskcom.atlassian.servicedesk:simplified-general-service-desk-itcom.atlassian.servicedesk:simplified-general-service-desk-businesscom.atlassian.servicedesk:simplified-internal-service-deskcom.atlassian.servicedesk:simplified-external-service-deskcom.atlassian.servicedesk:simplified-hr-service-deskcom.atlassian.servicedesk:simplified-facilities-service-deskcom.atlassian.servicedesk:simplified-legal-service-deskcom.atlassian.servicedesk:simplified-marketing-service-deskcom.atlassian.servicedesk:simplified-finance-service-deskcom.atlassian.servicedesk:simplified-analytics-service-deskcom.atlassian.servicedesk:simplified-design-service-deskcom.atlassian.servicedesk:simplified-sales-service-deskcom.atlassian.servicedesk:simplified-halp-service-deskcom.atlassian.servicedesk:simplified-blank-project-itcom.atlassian.servicedesk:simplified-blank-project-businesscom.atlassian.jira-core-project-templates:jira-core-simplified-content-managementcom.atlassian.jira-core-project-templates:jira-core-simplified-document-approvalcom.atlassian.jira-core-project-templates:jira-core-simplified-lead-trackingcom.atlassian.jira-core-project-templates:jira-core-simplified-process-controlcom.atlassian.jira-core-project-templates:jira-core-simplified-procurementcom.atlassian.jira-core-project-templates:jira-core-simplified-project-managementcom.atlassian.jira-core-project-templates:jira-core-simplified-recruitmentcom.atlassian.jira-core-project-templates:jira-core-simplified-task-

projectTypeKey

enum<string>

optional

The project type, which defines the application-specific feature set. If you don't specify the project template you have to specify the project type.

Allowed values:

softwareservice_deskbusiness

url

string

optional

A link to information about this project, such as project documentation

workflowScheme

integer <int64>

optional

The ID of the workflow scheme for the project. Use the Get all workflow schemes operation to get a list of workflow scheme IDs. If you specify the workflow scheme you cannot specify the project template key.

Examples

Responses

🟢201Returned if the project is created.

application/json

Body

Identifiers for a project.

integer <int64>

read-onlyrequired

The ID of the created project.

key

string

read-onlyrequired

The key of the created project.

self

string <uri>

read-onlyrequired

The URL of the created project.

🟠400Returned if the request is not valid and the project could not be created.

🟠401Returned if the authentication credentials are incorrect or missing.

🟠403Returned if the user does not have permission to create projects.

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

Get all projects

Get recent projects