Skip to main content
GET
Get compliance status for an API.

Authorizations

Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Path Parameters

apiID
string
required

The API's api_id.

Response

Compliance stats fetched.

Governance compliance summary for one API. Returned by GET /api/governance/apis/{apiID}/compliance.

overall_status
enum<string>

compliant = all completed rulesets have zero errors. non_compliant = at least one completed ruleset has error_count > 0. in_process = no failing completed ruleset, but at least one evaluation is still running. not_evaluated = no records exist, or all evaluations failed.

Available options:
compliant,
non_compliant,
in_process,
not_evaluated
rulesets
object[]