REST API
Gredit exposes a REST API under the /api/v1/ namespace for querying system data programmatically. Authentication is done via JWT (JSON Web Tokens).
Authentication
The API uses JWT tokens to authenticate requests. The token must be included in the Authorization header of each request:
Authorization: Bearer <token>
Available endpoints
Issues by script
Retrieves the issues generated by a specific script.
GET /api/v1/scripts/:id/issues
Parameters:
| Parameter | Type | Description |
|---|---|---|
id | integer | Script ID |
Issues by status
Retrieves a summary of issues grouped by status.
GET /api/v1/scripts/issues_by_status
Relevant internal routes
In addition to the public API, Gredit exposes internal routes for system operation:
| Route | Description |
|---|---|
POST /script/api_issues | Retrieve issues for a script (internal use) |
GET /home/api_issues_by_status | Issues by status dashboard |
POST /issues/exports | Export issues to file |
SAML endpoints
For SAML integration, Gredit exposes:
| Route | Description |
|---|---|
GET /saml/:tenant_name/auth | Initiate SAML authentication |
POST /saml/:tenant_name/callback | IdP callback |
GET /saml/:tenant_name/metadata | SP metadata |
Usage example
# Retrieve issues for a script
curl -H "Authorization: Bearer $TOKEN" \
https://gredit.example.com/api/v1/scripts/42/issues
# Retrieve issues by status
curl -H "Authorization: Bearer $TOKEN" \
https://gredit.example.com/api/v1/scripts/issues_by_status