JiraAPI¶

JiraAPI is the low-level entry point for Jira Cloud operations.

Constructor¶

from jira2py import JiraAPI

jira = JiraAPI(
    url=None,
    username=None,
    api_token=None,
    max_retries=4,
    max_retry_delay=30.0,
    credentials_file=None,
)

Parameter	Default	Description
`url`	`None`	Jira site URL. Overrides file/env values when provided.
`username`	`None`	Atlassian account email. Overrides file/env values when provided.
`api_token`	`None`	Jira API token. Overrides file/env values when provided.
`max_retries`	`4`	Max retry attempts on HTTP 429.
`max_retry_delay`	`30.0`	Max delay between retries in seconds.
`credentials_file`	`None`	Explicit path to a JSON file with `url`, `username`, and `api_token`. No default path is used.

If credentials_file is omitted, jira2py falls back to JIRA_URL, JIRA_USER, and JIRA_API_TOKEN.

Properties¶

Property	Type	Description
`issues`	`Issues`	Issue operations
`search`	`IssueSearch`	JQL search
`comments`	`IssueComments`	Issue comments
`worklogs`	`IssueWorklogs`	Issue worklogs
`fields`	`IssueFields`	System and custom fields
`issue_links`	`IssueLinks`	Issue-link operations
`projects`	`Projects`	Project lookup and search
`metadata`	`Metadata`	Statuses and priorities
`filters`	`Filters`	Saved filter discovery and lookup
`attachments`	`Attachments`	Attachment operations
`users`	`Users`	User search and current user

Usage¶

from jira2py import JiraAPI

jira = JiraAPI()

issue = jira.issues.get_issue("PROJ-123")
me = jira.users.get_current_user()
transitions = jira.issues.get_transitions("PROJ-123")
project = jira.projects.get_project("PROJ")
statuses = jira.metadata.get_statuses()
filters = jira.filters.search_filters(max_results=10)

See Configuration for credential resolution and Rate Limiting for retry behavior.