# Autoscale Metric

> GET /api/v1/health/autoscale-metric — request parameters and responses from the Menace Voice API schema.

`GET /api/v1/health/autoscale-metric`

{/* Generated by scripts/sync_docs_api.mjs. Edit the API schema source to change the contract. */}

See [authentication](/api-reference/authentication) for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

## API contract for documentation tools

Generated from the OpenAPI schema. Do not infer a different parameter type from an example. Authentication headers are alternatives as explained in the authentication guide.

### Parameters

| Name | Location | Type | Required | Description and constraints |
| --- | --- | --- | --- | --- |
| buffer | query | integer | no | default: 0 |
| X-Dograh-Devops-Secret | header | string or null | no |  |

### Response 200

Successful Response

application/json: AutoscaleMetricResponse (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| value | integer | yes |  |

### Response 404

Not found

### Response 422

Validation Error

application/json: HTTPValidationError (object).

| Field | Type | Required | Description and constraints |
| --- | --- | --- | --- |
| detail | array of ValidationError (object) | no |  |

## OpenAPI

````yaml api-reference/openapi.json get /api/v1/health/autoscale-metric
openapi: 3.1.0
info:
  title: Menace Voice API
  description: API for Menace Voice agents
  version: 1.0.0
servers:
  - url: https://voice.menaceui.com
    description: Production
  - url: http://localhost:8000
    description: Local development
paths:
  /api/v1/health/autoscale-metric:
    get:
      tags:
        - main
      summary: Autoscale Metric
      description: >-
        Fleet-wide autoscaling signal for KEDA: total active calls + warm
        buffer.


        Unlike /health/active-calls (a per-worker drain signal), this is the
        whole

        fleet's active-call count read from Redis, so a single scrape drives the

        ScaledObject. ``buffer`` (query param, in calls) is the warm headroom:
        KEDA

        divides value by the per-pod target K, giving desiredPods =

        ceil((calls + buffer) / K). All scaling policy — K, buffer, min/max —
        lives

        in the ScaledObject; this endpoint is pure signal.


        When the fleet count cannot be read (Redis down) this responds 503, NOT
        0:

        a failed scrape makes KEDA's HPA hold the current replica count, while a

        successful scrape of 0 would instruct it to scale toward minReplicas.
      operationId: autoscale_metric_api_v1_health_autoscale_metric_get
      parameters:
        - name: buffer
          in: query
          required: false
          schema:
            type: integer
            default: 0
            title: Buffer
        - name: X-Dograh-Devops-Secret
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: "null"
            title: X-Dograh-Devops-Secret
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/AutoscaleMetricResponse"
        "404":
          description: Not found
        "422":
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/HTTPValidationError"
components:
  schemas:
    AutoscaleMetricResponse:
      properties:
        value:
          type: integer
          title: Value
      type: object
      required:
        - value
      title: AutoscaleMetricResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: "#/components/schemas/ValidationError"
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
````