Schemas

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.

POST

api

admin

schemas

{name}

versions

{version}

deprecate

Deprecate version

curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "carry_over": true,
  "created_at": "2023-11-07T05:31:56Z",
  "deprecated_at": "2023-11-07T05:31:56Z",
  "document": {},
  "name": "customer-registration",
  "version": 2
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

Authorizations

Authorization

string

header

required

HS256-signed JWT bearer token, obtained via the OAuth2 client-credentials grant (see Authentication).

Path Parameters

name

string

required

Schema name

version

integer

required

Schema version (system-assigned integer)

Response

Deprecated version

carry_over

boolean

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.

created_at

string<date-time> | null

Null for version 1 of a built-in schema, which ships with the platform.

deprecated_at

string<date-time> | null

document

object

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.

name

string

Example:

"customer-registration"

status

enum<string>

Available options:

active,

deprecated

version

integer

System-assigned monotonic integer per schema, starting at 1. Merchants never choose it.

Example:

2

⌘I

Deprecate version

curl --request POST \
  --url https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{instance}.{env}.on-hellgate.cloud/api/admin/schemas/{name}/versions/{version}/deprecate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "carry_over": true,
  "created_at": "2023-11-07T05:31:56Z",
  "deprecated_at": "2023-11-07T05:31:56Z",
  "document": {},
  "name": "customer-registration",
  "version": 2
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "NOT_FOUND",
  "code": 404,
  "message": "The requested resource does not exist"
}

{
  "classifier": "VALIDATION_ERROR",
  "code": 422,
  "validation_errors": [
    {
      "message": "must be a positive integer",
      "path": "limit"
    }
  ]
}

Getting Started

Decisions

Lifecycle Events

Admin

Deprecate version

Authorizations

Path Parameters

Response