How to regenerate an API Key

API Issues
#1

There is a recommendation in the documentation that API keys should be regularly regenerated for security - which I would like to do but there is no obvious way to do this. How can I regenerate an API key without deleting the application and setting up a new one?

#2

I’d find it handy to have some way of automating this but I also couldn’t see anything. All I could find was:

To reset password:

  1. Access Companies House Beta. Log in (or login to this forum and then open CH Beta in a new tab / window).
  2. Cick on “Your details” at the top. This gets you to a password / email address change page ( https://account.companieshouse.gov.uk/user/account ).

To change / add applications / sites you use to access API with:

  1. Log in to this forum.
  2. Click the avatar icon at top right and choose “Profile”. This gets you to the applications page ( https://developer.companieshouse.gov.uk/developer/applications ) - annoyingly it seems you don’t change your password from there however.
#3

You do not need to delete an application to create a new API key.
Simply login and go to ‘Your Applications’ (https://developer.companieshouse.gov.uk/developer/applications)
It will list you current API key(s), click ‘Register an application’ and name it,
Start using this new API key and stop using the old key. When you are sure you are not using the old API key, select the old key in ‘Your Applications’ and click ‘Remove Application’.
Hope this helps answer your question.

Invalid Authorization Header
Changing an application API key
#4

a) wanted to check if the way to refresh keys is still the same, i.e. login to the account and do?
b) if we are refreshing keys, then it is getting new keys for the an application that is live. Are you suggesting that the Same Application be added again (because it is the same one) with exactly same URL, IPs and then generate the key which we have to update in our application setup?
c) is there no way to declare the refresh frequency while registering the Application, and using an Admin API that we can use to refresh keys through our internal administration processes?

#5

a) yes
b) no, we suggest you use a new name (refer to my previous advice)
c) no, there is no other way