Prerequisites
- A Backlog space with access to the projects you want to work in.
- A space-scoped API key, created from the issuing user’s Personal Settings → API tab.
- For create/update actions, the key’s user needs the matching project permission.
Read-only tracking works with any key whose user can see the target projects. Creating or updating issues, wikis, and pull requests additionally requires that user to have write permission on the project. If your space restricts API access, a space administrator must enable it before keys can be issued.
Setup
Create an API key
In Backlog, open your profile menu and go to Personal Settings → API. Enter a memo (e.g.
cloudthinker) and click Submit to generate the key, then copy it.Connection Details
| Field | Description | Example |
|---|---|---|
| BACKLOG_DOMAIN | Full Backlog domain for your space, not just the space key | <myorg>.backlog.com |
| BACKLOG_API_KEY | Space-scoped API key used to authenticate the connection | — |
Required Permissions
The API key inherits the access of the user who issued it. Read operations work with any key whose user can see the target projects. Create, update, and delete operations additionally require the user to have write permission on the project and explicit approval in CloudThinker.Agent Capabilities
Once connected, agents have read access to your Backlog projects, issues, wikis, and repositories, plus a set of approval-gated write operations.| Capability | Description |
|---|---|
| Project & Space Discovery | List projects, categories, custom fields, priorities, and recent space activity |
| Issue Tracking | Search, read, and count issues; create and update issues, change status, and add comments — writes require approval |
| Milestones & Releases | List milestones/versions and plan releases; create or update them — writes require approval |
| Wiki & Documents | Read project wikis and documents; create or update wiki pages — writes require approval |
| Git & Pull Requests | Inspect repositories and pull requests, pull ticket context during code review, and comment on PRs — writes require approval |
Verify the Connection
Example Prompts
For spaces with many projects, scope requests to a single project or milestone so the agent returns focused results.
Troubleshooting
401 Unauthorized
401 Unauthorized
Requests return 404 or the wrong space
Requests return 404 or the wrong space
BACKLOG_DOMAIN is set to just the space key instead of the full domain. Use the complete host, e.g.
<myorg>.backlog.com, and reconnect.Connection works but no projects or issues appear
Connection works but no projects or issues appear
The key’s user is not a member of any project, or lacks visibility on the ones you expect. Add the user to the target project in Backlog, then re-run discovery.
Create or update actions fail with a permission error
Create or update actions fail with a permission error
The key’s user lacks write permission on the project. Re-issue the key under a user with the right project role, and approve the action when prompted.
Results look cut off on large projects
Results look cut off on large projects
Very large responses are trimmed to keep replies focused. Scope the request to a single project, milestone, or status, or ask for a count first and then drill in.
Security Best Practices
- Least-privilege user - Issue the API key under a user with only the project access CloudThinker needs
- Approval for writes - Keep issue, wiki, milestone, and pull-request write actions approval-gated
- Key rotation - Rotate the API key regularly and update it in CloudThinker
- Correct domain - Store the full domain (
<myorg>.backlog.com), not just the space key - Revoke when unused - Delete the key in Backlog if you stop using the connection
Related
Atlassian Connection
Jira and Confluence issue tracking and knowledge base
Approval
How approval-gated actions work