GETlive

Read the current Rules and public procedure metadata

Read the current Rules and public procedure metadata.

/api/rules/currentgetCurrentRulesCanonical

Authentication and authority

No bearer credential is required.

Parameters

NameLocationRequirementSchema
x-pc-compatibility

Bounded compatibility inputs on the canonical URL. Existing scoped credentials retain v1 responses; role-bound credentials use grant-checked typed operations. Preserves each contract’s original journals, consent and disclosure. See /openapi/partner-v1.json for scoped credentials.

headerOptional{"type":"string","enum":["v1"]}

Responses

200

Authorized operation result.

application/json

{
  "$ref": "#/components/schemas/CanonicalGetCurrentRulesCanonicalResponse",
  "type": "object",
  "properties": {
    "data": {
      "$ref": "#/components/schemas/CanonicalCurrentRules",
      "type": "object",
      "properties": {
        "rulesVersion": {
          "type": "string"
        },
        "rulesHash": {
          "type": "string"
        },
        "rulesetId": {
          "type": "string"
        },
        "dynamicRulesetId": {
          "type": "string"
        },
        "apiCompatibilityVersion": {
          "type": "string"
        },
        "application": {
          "const": "prospective_and_case_pinned",
          "type": "string"
        }
      },
      "required": [
        "rulesVersion",
        "rulesHash",
        "rulesetId",
        "dynamicRulesetId",
        "apiCompatibilityVersion",
        "application"
      ]
    },
    "requestId": {
      "type": "string"
    }
  },
  "required": [
    "data",
    "requestId"
  ],
  "x-code-source": "app/api/v2/rules/current/route.ts"
}
default

RFC 9457 style problem response.

application/problem+json

{
  "$ref": "#/components/schemas/Problem",
  "type": "object",
  "required": [
    "type",
    "title",
    "status",
    "code",
    "detail",
    "requestId"
  ],
  "properties": {
    "type": {
      "type": "string",
      "format": "uri"
    },
    "title": {
      "type": "string"
    },
    "status": {
      "type": "integer"
    },
    "code": {
      "type": "string"
    },
    "detail": {
      "type": "string"
    },
    "requestId": {
      "type": "string"
    }
  }
}

Example response

Successful response

{
  "data": {
    "rulesVersion": "rulesVersion_test",
    "rulesHash": "rulesHash_test",
    "rulesetId": "rulesetId_test",
    "dynamicRulesetId": "dynamicRulesetId_test",
    "apiCompatibilityVersion": "apiCompatibilityVersion_test",
    "application": "prospective_and_case_pinned"
  },
  "requestId": "requestId_test"
}

Errors

Read the response status and stable error code. See errors and rate limits for recovery. Refresh the resource before resolving a state or digest conflict.

Idempotency and retries

  • For throttling, honor Retry-After when present. Back off on retryable server failures.