NSns-api
Authentication/API Key (Machine 2 Machine)

Update API Key

Changed on

This is a limited action and will require special access to create API keys. The Update is even more limited only allowing the change of the description and IP restrictions. You will not be able to change the scope, access rights or any premissions. A new apikey would need to be created in those cases.

put/apikeys/{key_id}

Request

  • Base URL
    https://ns-api.com/ns-api/v2
  • URL
    https://ns-api.com/ns-api/v2/apikeys/{key_id}
  • Auth
    HTTP bearer

Path parameters

key_idstring required

Request body

descriptionstring required

This is the main description/name for the API key that should describe its purpose for tracking and understanding its intended use.

ip-addressstring

Optional IP restrictions for API to require access from matching IP or subnets. Multipe ips/subnets can be provided comma seperated

Example request

{
  "description": "Used by Vendor Xyz for Billing Automation",
  "ip-address": "1.2.3.4,5.6.7.0/24"
}

Response

codeinteger required
messagestring required

Changes

  • bce16087d479Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status