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

# Deprecate version

> Marks a version deprecated — a non-destructive marker. Requires the admin:schemas:write scope. Rulesets bound to the version keep evaluating and their traffic is accepted while an operational signal flags it; creating a ruleset bound to a deprecated version rejects, and activating a ruleset whose binding became deprecated rejects. Versions are never auto-removed; there is no hard-removal flow. Deprecating a built-in schema or an already-deprecated version is an invalid transition.



## OpenAPI

````yaml /products/specter/openapi.yaml post /api/admin/schemas/{name}/versions/{version}/deprecate
openapi: 3.1.0
info:
  contact:
    email: support@hellgate.io
    name: Starfish GmbH & Co. KG
    url: https://hellgate.io/cpa/specter
  description: Composable decision engine and fraud prevention service.
  license:
    name: Hellgate API Terms
    url: https://hellgate.io/terms-and-conditions
  title: Specter API
  version: '1.0'
servers:
  - description: Managed instance of Specter
    url: https://{instance}.{env}.on-hellgate.cloud
    variables:
      instance:
        default: my-instance
        description: Your unique instance slug, provided during onboarding.
      env:
        default: eu1
        description: Deployment environment (currently eu1).
security: []
tags:
  - description: Evaluate transactions and retrieve decision results.
    name: Decisions
  - description: Close decisions that were flagged for manual review.
    name: Resolutions
  - description: Report payment lifecycle events for a prior decision.
    name: Lifecycle Events
  - description: Manage rulesets and their activation lifecycle.
    name: Rulesets
  - description: Register and version custom decision-payload schemas.
    name: Schemas
  - description: Configure interceptors and intercept live payment requests.
    name: Interceptors
  - description: Subscribe to decision and event notifications.
    name: Webhooks
  - description: Manage blocked field values.
    name: Blacklist
paths:
  /api/admin/schemas/{name}/versions/{version}/deprecate:
    post:
      tags:
        - Schemas
      summary: Deprecate version
      description: >-
        Marks a version deprecated — a non-destructive marker. Requires the
        admin:schemas:write scope. Rulesets bound to the version keep evaluating
        and their traffic is accepted while an operational signal flags it;
        creating a ruleset bound to a deprecated version rejects, and activating
        a ruleset whose binding became deprecated rejects. Versions are never
        auto-removed; there is no hard-removal flow. Deprecating a built-in
        schema or an already-deprecated version is an invalid transition.
      operationId: admin_schema_versions_deprecate
      parameters:
        - description: Schema name
          in: path
          name: name
          required: true
          schema:
            type: string
        - description: Schema version (system-assigned integer)
          in: path
          name: version
          required: true
          schema:
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SchemaVersion'
          description: Deprecated version
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: Not found
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrors'
          description: Invalid transition
      callbacks: {}
      security:
        - bearerAuth: []
components:
  schemas:
    SchemaVersion:
      properties:
        carry_over:
          description: >-
            Whether velocity counters carry over from the previous version for
            field paths present in both versions. When false, rulesets bound to
            this version count from zero — counters of earlier versions are
            untouched and keep serving the rulesets bound to them. Blacklist
            entries are not versioned — they are global and unaffected by this
            flag. Fixed at publication and immutable thereafter. Always true for
            version 1.
          type: boolean
        created_at:
          description: >-
            Null for version 1 of a built-in schema, which ships with the
            platform.
          format: date-time
          type:
            - string
            - 'null'
        deprecated_at:
          format: date-time
          type:
            - string
            - 'null'
        document:
          description: >-
            The JSON Schema document. Each field carries `x-specter-type` (one
            of the 23 entries of the type vocabulary — `string`, `integer`,
            `number`, `boolean`, `email`, `iban`, `country-code`,
            `currency-code`, `language-code`, `date`, `datetime`, `url`, `uuid`,
            `phone`, `ip`, `amount`, `pan`, `masked-pan`, `scheme-enum`,
            `card-funding-type-enum`, `card-segment-enum`, `object`, `array`)
            and optionally `x-data-classification` (`any` — the default — `pii`,
            `pci-pan`, `pci-sad`). A `pan` field is always `pci-pan`;
            `masked-pan` defaults to `pii`. Types validate the decision payload
            at ingestion; markers drive the PCI gate, redaction, and retention.
            See [Schemas](/products/specter/concepts/schemas).
          type: object
        name:
          example: customer-registration
          type: string
        status:
          enum:
            - active
            - deprecated
          type: string
        version:
          description: >-
            System-assigned monotonic integer per schema, starting at 1.
            Merchants never choose it.
          example: 2
          type: integer
      title: SchemaVersion
      type: object
    Error:
      description: Generic error response with classifier, code, and message
      example:
        classifier: NOT_FOUND
        code: 404
        message: The requested resource does not exist
      properties:
        classifier:
          type: string
        code:
          type: integer
        message:
          type: string
      required:
        - classifier
        - code
        - message
      title: Error
      type: object
    ValidationErrors:
      description: Response shape for request validation failures
      example:
        classifier: VALIDATION_ERROR
        code: 422
        validation_errors:
          - message: must be a positive integer
            path: limit
      properties:
        classifier:
          example: VALIDATION_ERROR
          type: string
        code:
          example: 422
          type: integer
        validation_errors:
          items:
            properties:
              message:
                example: must be a positive integer
                type: string
              path:
                example: limit
                type: string
            type: object
          type: array
      required:
        - classifier
        - code
        - validation_errors
      title: ValidationErrors
      type: object
  securitySchemes:
    bearerAuth:
      bearerFormat: JWT
      description: >-
        HS256-signed JWT bearer token, obtained via the OAuth2
        client-credentials grant (see Authentication).
      scheme: bearer
      type: http

````