{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-mansoq-pinelabs-healthcheckviewset-7380bae2","title":"Health Check API reference · mansoq-pinelabs","summary":"Static source contract for Health Check: 1 declared or inherited operation mappings, schema/field evidence and authorization/refusal references. Deployment and behavioral review remain explicit.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Declared route and availability","body":"This resource is declared in **mansoq-pinelabs** at `/api/{installed_plugin_prefix}/health_check/`. plugin/local mount; actual prefix and enablement require deployment verification A registered path and an indexed handler do not prove deployment availability, user permission or production readiness."},{"title":"Operation map","body":"| Method | Path | Action | Evidence |\n| --- | --- | --- | --- |\n| GET | `/api/{installed_plugin_prefix}/health_check/ping/` | ping | @action declaration |"},{"title":"ping · GET","body":"**GET /api/{installed_plugin_prefix}/health_check/ping/** — action `ping`. static contract extracted; runtime/permission/payload behavior review pending.\n\nPath and deployment-context parameters:\n\n| Location | Parameter | Type | Required |\n| --- | --- | --- | --- |\n| deployment mount | installed_plugin_prefix | deployment-selected mount prefix | true |\n\n**Authorization:** no literal permission name was resolved in the bounded handler/helper traversal. Authentication, inherited policies, object/facility scoping and middleware still require review; this does not mean public access."},{"title":"Integration review checklist","body":"Confirm the installed route and full schema; review authentication, organization/facility scoping, all accepted fields, value-state and date/time semantics, idempotency, pagination, response/exception branches and the allowed correction/reversal workflow. Test positive and negative cases with synthetic data. This source reference does not establish external certification or replace an illustrated user procedure."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/urls.py","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py","line":8,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["backend-resource-f2f41ba97380bae2","backend-resource-f2f41ba97380bae2:GET:ping"]},"backend":{"resources":[{"id":"backend-resource-f2f41ba97380bae2","localPrefix":"health_check","viewset":"HealthCheckViewSet","classId":"repositories/teleicu/mansoq-pinelabs:mansoq_pinelabs.api.viewsets.health_check.HealthCheckViewSet","basename":"pinelabs__health_check","source":{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/urls.py","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"conditions":[],"repository":"repositories/teleicu/mansoq-pinelabs","classSource":{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py","line":8,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","path":"/api/{installed_plugin_prefix}/health_check/","mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","operationIds":["backend-resource-f2f41ba97380bae2:GET:ping"],"unresolvedViewset":false,"reviewStatus":"registered resource enumerated; behavioral review pending"}],"operations":[{"id":"backend-resource-f2f41ba97380bae2:GET:ping","resourceId":"backend-resource-f2f41ba97380bae2","repository":"repositories/teleicu/mansoq-pinelabs","boundary":"optional-plugin/local-service","method":"GET","path":"/api/{installed_plugin_prefix}/health_check/ping/","declaredPattern":"/api/{installed_plugin_prefix}/health_check/ping/","action":"ping","viewset":"HealthCheckViewSet","classId":"repositories/teleicu/mansoq-pinelabs:mansoq_pinelabs.api.viewsets.health_check.HealthCheckViewSet","detail":false,"allowedByDeclaredHttpMethods":true,"mountStatus":"plugin/local mount; actual prefix and enablement require deployment verification","routeEvidence":{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/urls.py","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"handlerSource":{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"registrationConditions":[],"evidenceKind":"@action declaration","methodEvidenceIds":["repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py:10:ping"],"schemaIds":{},"classPermissionEvidence":[],"filterEvidence":[],"reviewStatus":"static contract extracted; runtime/permission/payload behavior review pending","pathParameters":[{"name":"installed_plugin_prefix","in":"deployment mount","type":"deployment-selected mount prefix","required":true,"source":{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/urls.py","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}}]}],"methodEvidence":[{"id":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py:10:ping","name":"ping","owner":"repositories/teleicu/mansoq-pinelabs:mansoq_pinelabs.api.viewsets.health_check.HealthCheckViewSet","summary":"","source":{"path":"repositories/teleicu/mansoq-pinelabs/mansoq_pinelabs/api/viewsets/health_check.py","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"signatureParameters":[],"parametersRead":[],"permissionChecks":[],"declaredErrors":[],"explicitResponseStatuses":[],"conditions":[],"schemaIds":[],"schemaUsages":[],"unconditionalRaise":false,"reviewStatus":"static declaration extracted; behavioral/security review pending"}],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[],"schemas":[]},"services":{"operations":[]},"boundaries":[]}