Skip to main content
Documentation
API & Integration

Dits REST API

A planned REST API for programmatic access to Dits repositories, users, and metadata.

API Overview (Planned)

The planned Dits REST API would provide programmatic access to repository management, user administration, and metadata operations — intended for integrations with CI/CD, project management tools, and custom workflows. None of these endpoints exist yet.

Planned
API Endpoints
REST
Architecture
JSON
Data Format

Authentication

Bearer Tokens
For session-based authentication
Authorization: Bearer <session_token>
Content-Type: application/json

# Token expires after 24 hours
# Obtained via POST /auth/login

Use for interactive applications and short-lived sessions.

API Tokens
For programmatic access
Authorization: Bearer dits_<api_token>
Content-Type: application/json

# Scoped permissions available
# Created in user settings

Use for CI/CD, integrations, and long-running processes.

Authentication Endpoints

MethodEndpointDescription
POST/auth/loginLogin with username/password
POST/auth/refreshRefresh session token
POST/auth/logoutInvalidate session

Rate Limits & Best Practices

Rate Limits
Authenticated requests5,000/hour
Unauthenticated requests60/hour
Search requests30/minute
Best Practices
  • Use API tokens for CI/CD
  • Implement exponential backoff for retries
  • Cache responses when possible
  • Use webhooks for real-time updates
  • Batch operations when available