Credentials and access

Update an allow-list entry

Changes the address or label on an existing entry. Send the whole entry, not just the field you are changing. Requires the edit-IP permission on your user's role.

put/v2/ip-address/{ipId}

Request

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

Path parameters

ipIdstring required

The entry's identifier.

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 entry was updated.

object required

Changes

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