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

# Opt a rental in or out of Hyperbolic telemetry

> Opt a running or pending virtual machine rental in or out of Hyperbolic telemetry. Takes effect within a few minutes, without a restart. Collection is on unless a rental is opted out. Only standalone virtual machine rentals in supported regions can opt out, not Kubernetes cluster node pools: other rentals get a 400. An unknown rental gets `RENTAL_NOT_FOUND`, and a failed update a 500 that is safe to retry.



## OpenAPI

````yaml /api-reference/openapi.json post /v2/on-demand/rentals/monitoring-opt-out
openapi: 3.1.0
info:
  title: Hyperbolic API
  description: >-
    HTTP API for Hyperbolic's on-demand GPU compute: rent virtual machines and
    bare-metal instances, manage storage volumes, and track usage and billing.
    Authenticate with a Bearer API key (`Authorization: Bearer <api-key>`).
  version: 2.0.0
  contact:
    name: Hyperbolic
    url: https://hyperbolic.ai
    email: support@hyperbolic.ai
servers:
  - url: https://api.hyperbolic.ai
    description: Production
  - url: https://api.hyperbolic.xyz
    description: >-
      Legacy host — the same API on Hyperbolic's original domain, kept for
      existing integrations.
security: []
tags:
  - name: openapi
    description: OpenAPI specification
    x-group: OpenAPI
  - name: rentals
    description: Manage rentals
    x-group: Rentals
  - name: storage-volumes
    description: Manage storage volumes
    x-group: Storage Volumes
  - name: billing
    description: Manage billing
    x-group: Billing
  - name: users
    description: Manage users
    x-group: Users
  - name: balances
    description: Manage balances
    x-group: Balances
  - name: api-keys
    description: Manage API keys
    x-group: API Keys
  - name: ssh-keys
    description: Manage SSH public keys
    x-group: SSH Keys
  - name: virtual-machine-rentals
    description: >-
      **Deprecated.** Manage virtual machine rentals. These endpoints are still
      supported for now but are no longer preferred.
    x-group: Virtual Machine Rentals (Deprecated)
    x-deprecated: true
  - name: bare-metal-rentals
    description: >-
      **Deprecated.** Manage bare metal rentals. These endpoints are still
      supported for now but are no longer preferred.
    x-group: Bare Metal Rentals (Deprecated)
    x-deprecated: true
paths:
  /v2/on-demand/rentals/monitoring-opt-out:
    post:
      tags:
        - rentals
      summary: Opt a rental in or out of Hyperbolic telemetry
      description: >-
        Opt a running or pending virtual machine rental in or out of Hyperbolic
        telemetry. Takes effect within a few minutes, without a restart.
        Collection is on unless a rental is opted out. Only standalone virtual
        machine rentals in supported regions can opt out, not Kubernetes cluster
        node pools: other rentals get a 400. An unknown rental gets
        `RENTAL_NOT_FOUND`, and a failed update a 500 that is safe to retry.
      operationId: ondemand-setRentalMonitoringOptOut
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                rentalId:
                  anyOf:
                    - type: string
                      minLength: 1
                      description: The rental's `rentalId`.
                    - type: integer
                      exclusiveMinimum: 0
                      maximum: 9007199254740991
                      deprecated: true
                      description: >-
                        Deprecated. The rental's legacy numeric id; use
                        `rentalId`.
                monitoringOptOut:
                  type: boolean
                  description: >-
                    Opt the rental out of Hyperbolic telemetry: the GPU health
                    and system metrics (CPU, memory, root filesystem, network
                    interfaces) Hyperbolic collects from inside the virtual
                    machine to detect hardware faults. No logs, process lists or
                    file contents are collected.
              required:
                - rentalId
                - monitoringOptOut
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '400':
          description: Invalid input data
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.BAD_REQUEST'
        '401':
          description: Authorization not provided
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.UNAUTHORIZED'
        '403':
          description: Insufficient access
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.FORBIDDEN'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error.INTERNAL_SERVER_ERROR'
      security:
        - Authorization: []
components:
  schemas:
    SuccessResponse:
      type: object
      properties:
        success:
          type: boolean
      required:
        - success
      additionalProperties: false
      description: Result of an operation that returns no payload.
    error.BAD_REQUEST:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Invalid input data
        code:
          type: string
          description: The error code
          example: BAD_REQUEST
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Invalid input data error (400)
      description: The error information
      example:
        code: BAD_REQUEST
        message: Invalid input data
        issues: []
    error.UNAUTHORIZED:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Authorization not provided
        code:
          type: string
          description: The error code
          example: UNAUTHORIZED
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Authorization not provided error (401)
      description: The error information
      example:
        code: UNAUTHORIZED
        message: Authorization not provided
        issues: []
    error.FORBIDDEN:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Insufficient access
        code:
          type: string
          description: The error code
          example: FORBIDDEN
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Insufficient access error (403)
      description: The error information
      example:
        code: FORBIDDEN
        message: Insufficient access
        issues: []
    error.INTERNAL_SERVER_ERROR:
      type: object
      properties:
        message:
          type: string
          description: The error message
          example: Internal server error
        code:
          type: string
          description: The error code
          example: INTERNAL_SERVER_ERROR
        issues:
          description: An array of issues that were responsible for the error
          example: []
          type: array
          items:
            type: object
            properties:
              message:
                type: string
            required:
              - message
            additionalProperties: false
      required:
        - message
        - code
      additionalProperties: false
      title: Internal server error error (500)
      description: The error information
      example:
        code: INTERNAL_SERVER_ERROR
        message: Internal server error
        issues: []
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer

````

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