Search the docs

REST API Rules

Use the existing /shares endpoints with referral fields populated.

  • On creation, both referral.path and at least one referral.address are required.

  • On update, you can modify referral.path or adjust addresses.

Validation rules include:

  • The referral path must begin with /.

  • At least one valid referral address (IPv4, IPv6, or hostname) must be provided.

  • Local addresses cannot match floating IPs or Anvil static IPs.

  • You cannot convert a normal share into a referral share (or vice versa).

  • You cannot blank out the path or remove all addresses.