Skip to main content
POST
Publish version

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

Body

application/json
document
object
required

The JSON Schema document for the new version (same format as SchemaVersion.document).

carry_over
boolean
default:true

When true (default), velocity counters carry over from the previous version for field paths present in both versions. When false, rulesets bound to the new version count from zero; earlier versions keep their counters. Blacklist entries are global and not affected. Baked into the version at publication; immutable thereafter.

Response

Published 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