> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unstructured.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Jira
First time creating a connector? [Read this first](/api-reference/workflow/connector-first-time-reqs).
Ingest your files into Unstructured from Jira.
## Requirements
You will need:
* A [Jira Cloud account](https://www.atlassian.com/try/cloud/signup?bundle=jira-software\&edition=free) or
[Jira Data Center installation](https://confluence.atlassian.com/adminjiraserver/installing-jira-data-center-938846870.html).
* The site URL for your [Jira Data Center installation](https://confluence.atlassian.com/jirakb/find-your-site-url-to-set-up-the-jira-data-center-and-server-mobile-app-954244798.html) or Jira Cloud account.
For Jira Cloud, open Jira in your web browser and copy the address from the browser's address bar.
If you're unsure, check the dashboard URL, or if viewing an issue, project or board, the site URL is typically everything that comes before **but not including** `/jira`, such as
`https://.atlassian.net`.
* To process Jira projects, provide the IDs for the target projects. To get a project's ID, sign in to your Jira Cloud account or Jira Data Center installation, and then go to the following URL: `https://.atlassian.net/rest/api/latest/project/`,
replacing `` with yours, and replacing `` with the target project's key. In the
response, look for the URL `https://.atlassian.net/rest/api/3/project/`, where `` is the target project's ID.
* To process Jira boards, the IDs for the target boards. To get a board's ID, sign in to your Jira Cloud account or Jira Data Center installation, and then go to the following URL: `https://.atlassian.net/rest/agile/1.0/board?projectKeyOrId=`,
replacing `` with yours, and `` with the associated project's key or ID. In the
response, look for the URL `https://.atlassian.net/rest/agile/1.0/board/`, where `` is the board's ID.
* To process Jira issues, the IDs for the target issues. To get an issue's ID, sign in to your Jia Cloud account or Jira Data Center installation, open the issue, and then look at the URL in your browser's address bar. The issue ID is the string of characters after the final slash in the URL.
* A user in your [Jira Cloud account](https://support.atlassian.com/jira-cloud-administration/docs/manage-users-groups-permissions-and-roles-in-jira-cloud/) or
[Jira Data Center installation](https://confluence.atlassian.com/adminjiraserver/create-edit-or-remove-a-user-938847025.html).
* The user must have the correct permissions in your
[Jira Cloud account](https://support.atlassian.com/jira-cloud-administration/docs/manage-users-groups-permissions-and-roles-in-jira-cloud/) or
[Jira Data Center installation](https://confluence.atlassian.com/jirakb/permissions-made-simple-for-jira-server-717062767.html) to
access the target projects, boards, and issues.
* One of the following:
* For Jira Cloud or Jira Data Center, the target user's name or email address, and password.
[Change a Jira Cloud user's password](https://support.atlassian.com/user-management/docs/change-password-for-portal-only-customers/).
[Change a Jira Data Center user's password](https://confluence.atlassian.com/adminjiraserver/create-edit-or-remove-a-user-938847025.html).
* For Jira Cloud only, the target user's name or email address, and API token.
[Create an API token](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
* For Jira Data Center only, the target user's personal access token (PAT).
[Create a PAT](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html).
## Examples
To create a Jira source connector, see the following examples.
For more information on working with source connectors using the Unstructured API, see [Source endpoints](/api-reference/api/source/source-apis).
```python Python SDK theme={null}
import os
from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector
with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
response = client.sources.create_source(
request=CreateSourceRequest(
create_source_connector=CreateSourceConnector(
name="",
type="jira",
config={
"url": "",
# For password or API token authentication:
# "username": "",
# "password": "",
# For personal access token authentication:
# "token": "",
"projects": [
"",
""
],
"boards": [
"",
""
],
"issues": [
"",
""
],
"status_filters": [
"",
""
],
"download_attachments": ,
"cloud":
}
)
)
)
print(response.source_connector_information)
```
```bash curl theme={null}
curl --request 'POST' --location \
"$UNSTRUCTURED_API_URL/sources" \
--header 'accept: application/json' \
--header "unstructured-api-key: $UNSTRUCTURED_API_KEY" \
--header 'content-type: application/json' \
--data \
'{
"name": "",
"type": "jira",
"config": {
"url": "",
# For password or API token authentication:
"username": "",
"password": ",
# For personal access token authentication:
"token": "",
"projects": [
"",
""
],
"boards": [
"",
""
],
"issues": [
"",
""
],
"status_filters": [
"",
""
],
"download_attachments": ,
"cloud":
}
}'
```
## Configuration settings
Replace the preceding placeholders as follows:
A unique name for this connector.
The URL of the Jira instance.
Required for password or API token authentication. The username of the Jira user.
Required for password or API token authentication. For password authentication, the password of the Jira user. For API token authentication, the API token of the Jira user.
Required for personal access token authentication. The personal access token of the Jira user.
The ID of a target project in Jira to access.
The ID of a target board in Jira to access.
The ID of a target issue in Jira to access.
The name of a status to filter Jira issues by.
Set to `true` to download attachments from Jira issues.
Set to `true` to specify using Jira Cloud or `false` to specify using Jira Data Center. The default is to use Jira Data Center.
## Learn more
* [Jira Integration in Unstructured: Build RAG Systems with Project Management Data](https://unstructured.io/blog/jira-integration-in-unstructured-build-rag-systems-with-project-management-data)