A modern and flexible .NET client library to interact with Redmine's REST API.
- Full REST API support with CRUD operations
- Supports both XML and JSON data formats
- Handles GZipped server responses transparently
- Easy integration via NuGet package
- Actively maintained and community-driven
Resource | Read | Create | Update | Delete |
---|---|---|---|---|
Attachments | ✅ | ✅ | ❌ | ❌ |
Custom Fields | ✅ | ❌ | ❌ | ❌ |
Enumerations | ✅ | ❌ | ❌ | ❌ |
Files | ✅ | ✅ | ❌ | ❌ |
Groups | ✅ | ✅ | ✅ | ✅ |
Issues | ✅ | ✅ | ✅ | ✅ |
Issue Categories | ✅ | ✅ | ✅ | ✅ |
Issue Relations | ✅ | ✅ | ✅ | ✅ |
Issue Statuses | ✅ | ❌ | ❌ | ❌ |
My Account | ✅ | ❌ | ✅ | ❌ |
News | ✅ | ✅ | ✅ | ✅ |
Projects | ✅ | ✅ | ✅ | ✅ |
Project Memberships | ✅ | ✅ | ✅ | ✅ |
Queries | ✅ | ❌ | ❌ | ❌ |
Roles | ✅ | ❌ | ❌ | ❌ |
Search | ✅ | |||
Time Entries | ✅ | ✅ | ✅ | ✅ |
Trackers | ✅ | ❌ | ❌ | ❌ |
Users | ✅ | ✅ | ✅ | ✅ |
Versions | ✅ | ✅ | ✅ | ✅ |
Wiki Pages | ✅ | ✅ | ✅ | ✅ |
Add the package via NuGet:
dotnet add package Redmine.Net.Api
Or via Package Manager Console:
Install-Package Redmine.Net.Api
using Redmine.Net.Api;
using Redmine.Net.Api.Types;
using System;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
var options = new RedmineManagerOptionsBuilder()
.WithHost("https://your-redmine-url")
.WithApiKeyAuthentication("your-api-key");
var manager = new RedmineManager(options);
// Retrieve an issue asynchronously
var issue = await manager.GetAsync<Issue>(12345);
Console.WriteLine($"Issue subject: {issue.Subject}");
}
}
Explore more usage examples on the Wiki.
Detailed API reference, guides, and tutorials are available in the GitHub Wiki.
See the CONTRIBUTING.md for detailed guidelines.
Thanks to all contributors!
This project is licensed under the Apache License 2.0.
If you find this project useful, consider to support development.