> ## Documentation Index > Fetch the complete documentation index at: https://docs.polymorfa.com/llms.txt > Use this file to discover all available pages before exploring further. # Get project health policy settings > Returns the health threshold and the actions configured for numbers in this project. Integration flags report whether email and webhook delivery are ready to use. Requires `sessions:read`. Project tokens only access resources in their own project. ## OpenAPI ````yaml api-reference/features/operate.json GET /platform/projects/{projectId}/health-policy openapi: 3.0.3 info: title: Operate API methods version: 1.0.0 description: Task-focused operate methods across supported Polymorfa connection types. servers: [] security: [] paths: /platform/projects/{projectId}/health-policy: get: tags: - Bansafe summary: Get project health policy settings description: >- Returns the health threshold and the actions configured for numbers in this project. Integration flags report whether email and webhook delivery are ready to use. Requires `sessions:read`. Project tokens only access resources in their own project. operationId: managementGetProjectHealthPolicySettings parameters: - schema: type: string format: uuid required: true name: projectId in: path description: |- Identifier of the Polymorfa project that owns this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | responses: '200': description: Success headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: type: object additionalProperties: false properties: data: allOf: - $ref: '#/components/schemas/management__ProjectHealthPolicy' description: Structured data carried by this object. required: - data '400': $ref: '#/components/responses/management__BadRequest' '401': $ref: '#/components/responses/management__Unauthorized' '403': $ref: '#/components/responses/management__Forbidden' '404': $ref: '#/components/responses/management__NotFound' security: - management__ApiKeyAuth: [] servers: - url: https://api.polymorfa.com - url: http://localhost:8080 description: local dev components: schemas: management__ProjectHealthPolicy: type: object additionalProperties: false properties: projectId: type: string format: uuid description: |- Identifier of the Polymorfa project that owns this resource. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uuid` | version: type: integer minimum: 0 description: |- Revision required by the next update. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` or greater | enabled: type: boolean description: Whether this feature is enabled. threshold: type: integer minimum: 0 maximum: 100 description: >- Actions trigger only when an available health estimate is below this value. **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | `0` through `100` (inclusive) | sessionAction: type: string enum: - none - stop - slow_down - log_out description: |- Specifies session action for this management project health policy. **Allowed values** | Value | Meaning | | --- | --- | | `none` | None. | | `stop` | Stop. | | `slow_down` | Slow down. | | `log_out` | Log out. | slowDownMps: type: number minimum: 0 exclusiveMinimum: true nullable: true description: |- Specifies slow down mps for this management project health policy. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `number`; Numeric value: Greater than `0` | | Alternative 2 | `null` | **Value constraints** | Constraint | Accepted input | | --- | --- | | Numeric value | Greater than `0` | emailNotification: type: boolean description: Whether email notification. webhookNotification: type: boolean description: Whether webhook notification. integrations: allOf: - $ref: '#/components/schemas/management__ProjectHealthPolicyIntegrations' description: Specifies integrations for this management project health policy. required: - projectId - version - enabled - threshold - sessionAction - slowDownMps - emailNotification - webhookNotification - integrations management__ProjectHealthPolicyIntegrations: type: object additionalProperties: false properties: emailConfigured: type: boolean description: Whether notification email delivery is configured. webhookConfigured: type: boolean description: Whether an enabled webhook exists for this organization or project. required: - emailConfigured - webhookConfigured management__ErrorEnvelope: type: object required: - error - data - docs properties: error: type: object required: - type - code - message - param properties: type: type: string enum: - invalid_request_error - authentication_error - permission_error - conflict_error - rate_limit_error - api_error - upstream_error description: |- Type discriminator for this object. **Allowed values** | Value | Meaning | | --- | --- | | `invalid_request_error` | Invalid request error. | | `authentication_error` | Authentication error. | | `permission_error` | Permission error. | | `conflict_error` | Conflict error. | | `rate_limit_error` | Rate limit error. | | `api_error` | Api error. | | `upstream_error` | Upstream error. | code: type: string description: Stable failure code. Use this value for programmatic handling. message: type: string description: Safe explanation of the failure. param: type: string nullable: true description: |- Invalid request field, or null when no field applies. **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | description: Error details returned when the operation fails. data: type: string nullable: true enum: - null description: |- Always null for a failed request. **Allowed values** | Value | Meaning | | --- | --- | | `null` | Null. | **Accepted alternatives** | Alternative | Accepted input | | --- | --- | | Alternative 1 | Type: `string` | | Alternative 2 | `null` | docs: type: string format: uri description: |- Documentation link to this failure code. **Value constraints** | Constraint | Accepted input | | --- | --- | | Format | `uri` | responses: management__BadRequest: description: A path, query, or request-body value did not pass validation. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Unauthorized: description: Missing/invalid credential for this audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__Forbidden: description: Authenticated but lacks the required scope/role/audience. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' management__NotFound: description: >- The requested resource was not found inside the authenticated organization or project scope. headers: X-Request-Id: schema: type: string description: Stable request correlation identifier. Polymorfa-Version: schema: type: string description: API version applied to this response. content: application/json: schema: $ref: '#/components/schemas/management__ErrorEnvelope' securitySchemes: management__ApiKeyAuth: type: http scheme: bearer description: >- Polymorfa server credential: a scoped pmfa_ organization key, or a pmfa_pt_ project token on project- and session-bound operations inside its exact authenticated project. Keys may be personal or service-account owned. Both enforce selected action scopes; organization keys can address team resources and every project in the organization. Listener and browser client credentials are rejected. ````