Credentials and access

Add an IP to the allow-list

Adds one address to the allow-list.

Adding the first entry switches the allow-list on. Until then every IP is allowed; the moment one entry exists, every other IP is refused with 403 Unauthorized IP address. So add all of your callers before you rely on the list, and make sure the machine you are adding from is one of them.

Requires the create-IP permission on your user's role.

post/v2/ip-address

Request

  • Base URL: https://test-api.kashier.io
  • URL: https://test-api.kashier.io/v2/ip-address
  • Auth: API key in header Authorization

Request body

namestring required

Your label for the address, e.g. Production API server.

ipAddressstring required

A valid IPv4 or IPv6 address. 0.0.0.0 is rejected.

userIdstring required

The dashboard user the entry applies to. The allow-list is checked per user as well as per merchant, so the entry must name the user whose secret key does the calling.

Response

The address was added.

object required

Changes

No recorded changes to this operation across all 1 revision of this API.