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

# Pause or resume a guardrail

> Pauses (`is_active: false`) or resumes (`is_active: true`) a guardrail. A paused guardrail keeps its assignments but applies to nobody. Each limit comes from the closest active guardrail that sets it, in the order key, member, role, organization default, so the keys and members a paused guardrail covers fall through to the next one. Requires the `manage:write` scope.



## OpenAPI

````yaml https://api.edenai.run/v2/info/splitted-schema/management_api/openapi.json put /v3/manage/guardrails/{guardrail_id}/active/
openapi: 3.0.3
info:
  title: Organization Management
  version: '2.0'
  description: Your project description
servers:
  - url: https://api.edenai.run
security: []
paths:
  /v3/manage/guardrails/{guardrail_id}/active/:
    put:
      tags:
        - Guardrails
      summary: Pause or resume a guardrail
      description: >-
        Pauses (`is_active: false`) or resumes (`is_active: true`) a guardrail.
        A paused guardrail keeps its assignments but applies to nobody. Each
        limit comes from the closest active guardrail that sets it, in the order
        key, member, role, organization default, so the keys and members a
        paused guardrail covers fall through to the next one. Requires the
        `manage:write` scope.
      operationId: manage_guardrails_active_update
      parameters:
        - in: path
          name: guardrail_id
          schema:
            type: integer
          description: The guardrail's id.
          required: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuardrailActiveRequest'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/GuardrailActiveRequest'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/GuardrailActiveRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Guardrail'
          description: ''
      security:
        - ManagementKeyAuth: []
components:
  schemas:
    GuardrailActiveRequest:
      type: object
      properties:
        is_active:
          type: boolean
      required:
        - is_active
    Guardrail:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 200
        description:
          type: string
        model_rules:
          nullable: true
        rate_limit:
          type: string
          nullable: true
          maxLength: 15
        budget_cap:
          type: number
          format: double
          maximum: 100000
          minimum: -100000
          exclusiveMaximum: true
          exclusiveMinimum: true
          nullable: true
        budget_period:
          nullable: true
          oneOf:
            - $ref: '#/components/schemas/BudgetPeriodEnum'
            - $ref: '#/components/schemas/BlankEnum'
            - $ref: '#/components/schemas/NullEnum'
        budget_alert_percent:
          type: integer
          maximum: 100
          minimum: 1
          nullable: true
        is_active:
          type: boolean
          readOnly: true
        is_default:
          type: boolean
          description: >-
            Whether this is its organization's default guardrail.


            Pass ``organization`` in the context (every guardrail view does) so
            a list

            reads the default off that one row instead of a query per guardrail.
          readOnly: true
        created_at:
          type: string
          format: date-time
          readOnly: true
        updated_at:
          type: string
          format: date-time
          readOnly: true
      required:
        - created_at
        - id
        - is_active
        - is_default
        - name
        - updated_at
    BudgetPeriodEnum:
      enum:
        - daily
        - weekly
        - monthly
      type: string
      description: |-
        * `daily` - Daily
        * `weekly` - Weekly
        * `monthly` - Monthly
    BlankEnum:
      enum:
        - ''
    NullEnum:
      enum:
        - null
  securitySchemes:
    ManagementKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque
      description: >-
        A management key (created from the organization dashboard or with `POST
        /v3/manage/auth-keys`), sent as `Authorization: Bearer
        <management_key>`. Inference API keys (`sk-eden...`) are not accepted on
        these endpoints.

````

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