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

# Pause an endpoint

> Take an active endpoint out of rotation without deleting it. Endpoints awaiting approval or suspended can't be paused. Requires endpoints:write.



## OpenAPI

````yaml api-reference/openapi.json POST /v1/provider/endpoints/{id}/pause
openapi: 3.1.0
info:
  title: TokenChange API
  description: >-
    Manage TokenChange resources with a gateway API token. Errors share one
    envelope: `{"error":{"type","code","message"}}`.
  license:
    name: ''
  version: '1'
servers:
  - url: https://api.tokenchange.io
security: []
tags:
  - name: models
    description: Catalog models and endpoints
  - name: keys
    description: Inference API keys
  - name: usage
    description: Usage analytics
  - name: billing
    description: Credit balance and history
  - name: provider
    description: Your provider account, endpoints, validations and earnings
paths:
  /v1/provider/endpoints/{id}/pause:
    post:
      tags:
        - provider
      operationId: pause_endpoint
      parameters:
        - name: id
          in: path
          description: Endpoint id
          required: true
          schema:
            type: string
        - name: Idempotency-Key
          in: header
          description: Makes retries safe for 24 hours
          required: false
          schema:
            type:
              - string
              - 'null'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderEndpoint'
        default:
          description: Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
        - bearer:
            - endpoints:write
components:
  schemas:
    ProviderEndpoint:
      type: object
      description: >-
        One of your endpoints. The upstream bearer token is write-only and never
        returned.
      required:
        - id
        - slug
        - model_id
        - url
        - pricing
        - slots
        - capabilities
        - availability
        - status
        - config_version
        - latest_validations
        - created_at
      properties:
        availability:
          $ref: '#/components/schemas/Availability'
        capabilities:
          type: array
          items:
            type: string
        config_version:
          type: integer
          format: int32
        context_window:
          type:
            - integer
            - 'null'
          format: int32
        created_at:
          type: string
        id:
          type: string
        latest_price_change:
          oneOf:
            - $ref: '#/components/schemas/PriceChange'
            - type: 'null'
        latest_validations:
          type: array
          items:
            $ref: '#/components/schemas/ValidationRun'
          description: Latest run per suite against the current configuration.
        model_id:
          type: string
        output_tokens_per_sec:
          type:
            - number
            - 'null'
          format: double
        pricing:
          $ref: '#/components/schemas/Pricing'
        quantization:
          type:
            - string
            - 'null'
        review_reason:
          type:
            - string
            - 'null'
        reviewed_at:
          type:
            - string
            - 'null'
        slots:
          type: integer
          format: int32
        slug:
          type: string
        status:
          $ref: '#/components/schemas/EndpointStatus'
        upstream_model_name:
          type:
            - string
            - 'null'
        url:
          type: string
        validated_at:
          type:
            - string
            - 'null'
        validation_error:
          type:
            - string
            - 'null'
    ErrorBody:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/ErrorDetail'
    Availability:
      type: string
      enum:
        - pending
        - validating
        - up
        - degraded
        - down
        - rejected
    PriceChange:
      type: object
      description: >-
        Price changes on a live endpoint wait for operator review; the live
        prices stay in effect.
      required:
        - id
        - status
        - pricing
        - requested_at
      properties:
        decided_at:
          type:
            - string
            - 'null'
        decision_reason:
          type:
            - string
            - 'null'
        id:
          type: string
        pricing:
          $ref: '#/components/schemas/Pricing'
        requested_at:
          type: string
        status:
          $ref: '#/components/schemas/PriceChangeStatus'
    ValidationRun:
      type: object
      required:
        - id
        - suite
        - trigger
        - status
        - metrics
        - config_version
        - started_at
        - finished_at
      properties:
        config_version:
          type: integer
          format: int32
        error:
          type:
            - string
            - 'null'
        finished_at:
          type: string
        id:
          type: string
        metrics:
          type: object
          additionalProperties:
            type: string
          propertyNames:
            type: string
        started_at:
          type: string
        status:
          $ref: '#/components/schemas/ValidationStatus'
        suite:
          type: string
        trigger:
          $ref: '#/components/schemas/ValidationTrigger'
    Pricing:
      type: object
      description: Prices in USD per million tokens, as decimal strings.
      required:
        - input_per_million
        - output_per_million
      properties:
        cached_per_million:
          type:
            - string
            - 'null'
        input_per_million:
          type: string
        output_per_million:
          type: string
    EndpointStatus:
      type: string
      enum:
        - active
        - paused
        - suspended
        - retired
        - pending
        - rejected
    ErrorDetail:
      type: object
      required:
        - type
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        resource_id:
          type:
            - string
            - 'null'
        type:
          type: string
    PriceChangeStatus:
      type: string
      enum:
        - pending
        - approved
        - rejected
        - withdrawn
    ValidationStatus:
      type: string
      enum:
        - passed
        - failed
        - unreachable
        - timed_out
        - skipped
    ValidationTrigger:
      type: string
      enum:
        - admission
        - recheck
        - manual
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: A gateway API token (`tcg_…`) created in the dashboard

````

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