Page tree

Overview

The Rename an API key API renames an API key. 

You can use the Get API keys to find the ID and the current name of the API key.

You can use the Get Users API to find the user ID.


Sample request

PUT https://api.armor.com/users/6/keys


{
  "apiKeyId": "00000000-0000-0000-0000-000000000000",
  "prevApiKeyName": "Old API Key Name",
  "newApiKeyName": "New API Key Name"
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/users/{id}/keysPUT


The following table describes the parameter (or parameters) for this API call: 

ParameterDescriptionRequired or optionalTypeExample
user id

The ID of the user

You can use the Get Users API to find the ID of your users.

RequiredInteger6
apiKeyId

The ID of the API key

You can use the Get API keys to find the key ID.
RequiredString00000000-0000-0000-0000-000000000000
preApiKeyName

The current name of the API key

You can use the Get API keys to find the current name of the API key.
RequiredStringOld API Key Name
newApiKeyNameThe new name for the API keyRequiredStringNew API Key Name



Sample return

StatusResponse
200
OK