> ## Documentation Index
> Fetch the complete documentation index at: https://gproxy.leenhawk.com/llms.txt
> Use this file to discover all available pages before exploring further.

# POST /admin/api/credentials/{id}/quota-probe



## OpenAPI

````yaml /generated/openapi.json post /admin/api/credentials/{id}/quota-probe
openapi: 3.1.0
info:
  description: >-
    Forwarding, management, portal and OAuth APIs generated from Rust types.
    Input and output schemas preserve their respective Serde contracts.
    Streaming events and WebSocket messages are documented alongside HTTP
    payloads.
  title: GPROXY HTTP API
  version: 4.2.1
servers: []
security:
  - bearer: []
  - anthropicKey: []
  - googleKey: []
  - queryKey: []
paths:
  /admin/api/credentials/{id}/quota-probe:
    post:
      tags:
        - Management
      summary: POST /admin/api/credentials/{id}/quota-probe
      parameters:
        - in: path
          name: id
          required: true
          schema:
            type: string
        - description: Administrative scope selected by the caller.
          in: header
          name: x-gproxy-admin-scope
          required: false
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_QuotaSnapshotDto'
          description: Success
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Output_Envelope'
          description: Gateway error
      security:
        - consoleSession: []
        - bearer: []
        - anthropicKey: []
        - googleKey: []
components:
  schemas:
    Output_QuotaSnapshotDto:
      description: >-
        One live answer from the upstream, already persisted as cycles and
        blocks

        by the time it is returned.
      properties:
        entries:
          items:
            $ref: '#/components/schemas/Output_QuotaEntryDto'
          type: array
        observedAtMs:
          format: int64
          type: integer
      required:
        - observedAtMs
        - entries
      type: object
    Output_Envelope:
      properties:
        error:
          $ref: '#/components/schemas/Output_EnvelopeBody'
      required:
        - error
      type: object
    Output_QuotaEntryDto:
      properties:
        allowance:
          anyOf:
            - $ref: '#/components/schemas/Output_QuotaAllowanceDto'
            - type: 'null'
          description: Present for `window`, `rate_limit` and `budget`.
        balance:
          anyOf:
            - $ref: '#/components/schemas/Output_QuotaBalanceDto'
            - type: 'null'
          description: Present only for `balance`.
        breakdown:
          items:
            $ref: '#/components/schemas/Output_QuotaBreakdownRowDto'
          type:
            - array
            - 'null'
        id:
          type: string
        kind:
          description: '`window`, `rate_limit`, `budget`, `balance` or `breakdown`.'
          type: string
        label:
          type:
            - string
            - 'null'
        modelScope:
          description: 'The channel''s `QuotaScope` JSON: `"all"`, `{"models":[…]}`, … .'
        sourceId:
          type: string
        subject:
          description: '`account`, `organization`, `project`, `key` or `unknown`.'
          type: string
      required:
        - id
        - sourceId
        - label
        - subject
        - modelScope
        - kind
        - allowance
        - balance
        - breakdown
      type: object
    Output_EnvelopeBody:
      properties:
        code:
          type: string
        message:
          type: string
      required:
        - code
        - message
      type: object
    Output_QuotaAllowanceDto:
      description: None means the upstream did not report the field, never zero.
      properties:
        limit:
          type:
            - string
            - 'null'
        periodEndMs:
          format: int64
          type:
            - integer
            - 'null'
        periodStartMs:
          format: int64
          type:
            - integer
            - 'null'
        remaining:
          type:
            - string
            - 'null'
        resetBehavior:
          description: '`periodic`, `recovering`, `expiring` or `unknown`.'
          type: string
        unit:
          type:
            - string
            - 'null'
        unlimited:
          type:
            - boolean
            - 'null'
        used:
          type:
            - string
            - 'null'
        usedPercent:
          description: On the 0..100 scale.
          type:
            - string
            - 'null'
      required:
        - used
        - limit
        - remaining
        - usedPercent
        - unlimited
        - unit
        - periodStartMs
        - periodEndMs
        - resetBehavior
      type: object
    Output_QuotaBalanceDto:
      properties:
        remaining:
          type:
            - string
            - 'null'
        unit:
          type:
            - string
            - 'null'
      required:
        - remaining
        - unit
      type: object
    Output_QuotaBreakdownRowDto:
      properties:
        key:
          type: string
        label:
          type:
            - string
            - 'null'
        percent:
          type: string
      required:
        - key
        - label
        - percent
      type: object
  securitySchemes:
    bearer:
      scheme: bearer
      type: http
    anthropicKey:
      in: header
      name: x-api-key
      type: apiKey
    googleKey:
      in: header
      name: x-goog-api-key
      type: apiKey
    queryKey:
      in: query
      name: key
      type: apiKey
    consoleSession:
      in: cookie
      name: gproxy_session
      type: apiKey

````

## Related topics

- [POST /admin/api/credentials/{id}/quota-reset](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials-quota-reset.md)
- [POST /admin/api/credentials/{id}/quota-diagnostics](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials-quota-diagnostics.md)
- [POST /admin/api/credentials](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials.md)
- [POST /admin/api/credentials/{id}/reveal](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials-reveal.md)
- [POST /admin/api/credentials/{id}/refresh](https://gproxy.leenhawk.com/api-reference/management/post-adminapicredentials-refresh.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.