List lint violations for an API.

Returns paginated lint violations produced by the async governance evaluator for the given API within the caller’s org. Results are sorted by severity (error → warn → info → hint), then by ruleset_id. Use ?p=<page> to paginate; send -1 to return all results. Optional filters: ruleset_id (exact match) and severity (one of error, warn, info, hint).

GET /api/governance/evaluation-details/{apiID}

List lint violations for an API.

cURL

curl --request GET \
  --url https://{tenant}/api/governance/evaluation-details/{apiID} \
  --header 'Authorization: Bearer <token>'

200

{
  "violations": [
    {
      "_id": "6644b38535715ec496cbef3d",
      "org_id": "5e4f2c1a3b6d7e8f9a0b1c2d",
      "api_id": "abc123",
      "ruleset_id": "my-ruleset",
      "ruleset_name": "My OAS Ruleset",
      "rule_id": "operation-tags",
      "rule_summary": "Operation must have at least one tag",
      "how_to_fix": "Add a tags field to the operation object",
      "message": "Operation must have at least one tag",
      "severity": "warn",
      "severity_order": 2,
      "path": "paths./pets.get",
      "location": {
        "start_line": 12,
        "start_char": 4,
        "end_line": 12,
        "end_char": 20
      },
      "created_at": "2024-05-01T12:00:00Z"
    }
  ],
  "pages": 3
}

Authorizations

Authorization · string · header · required

The Tyk Dashboard API Access Credentials

Path Parameters

apiID · string · required

The API ID to fetch violations for.

Query Parameters

p · integer

Page number. Send -1 to return all results. Defaults to 1.

ruleset_id · string

Filter violations to a specific ruleset.

severity · enum<string>

Filter violations by severity level.

Available options: error, warn, info, hint

Response

200

application/json

Violations fetched.

violations · object[]

Show child attributes

pages · integer

Total number of pages at the current page size. 0 when all results are returned.