key is invalid. You must supply a key in OpenSSH public key format

[bconeDemo]

Select Topic Area

Question

Body

Hi All, When trying to hit POST Create a Deploy key from the postman end, we are able to successfully get the response.

But when we are trying it from the different environment we are getting error "key is invalid. You must supply a key in OpenSSH public key format".

We generated the key and using the public key from id_rsa.pub file.

Can someone please suggest any solution for the same.

Thank you.

[nirav-gajera]

"key is invalid. You must supply a key in OpenSSH public key format" means that the public key that you are trying to use is not in the correct format.

The OpenSSH public key format is a standard format for public keys used by SSH. It is a text file that starts with the line ssh-rsa, followed by the public key data.

To check if your public key is in the OpenSSH format, you can open it in a text editor and make sure that it starts with the line ssh-rsa.

If your public key is not in the OpenSSH format, you can convert it to the OpenSSH format using a tool like PuTTYgen. PuTTYgen is a free and open-source SSH key generator.

Once you have converted your public key to the OpenSSH format, you can try to create the deploy key again.

Here are the steps on how to convert your public key to the OpenSSH format using PuTTYgen:

1. Open PuTTYgen.
2. Click on the Load button and select the public key file that you want to convert.
3. Click on the Save OpenSSH key button and save the key in a file with the .pub extension.

The public key file with the .pub extension is now in the OpenSSH format. You can use this file to create the deploy key.

[bconeDemo]

Hi, thanks for the reply,

this is the key that we generated and using to hit the API, with the same key, we are able to hit successfully on postman, but facing the above issue on another environment.
ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBEu5Jb8ILsaxLg/MjPjhv5+Fs/ae/fBnwfRol407U6x [email]

Hope this is the correct format that got generated, could you please provide your insight here

[nirav-gajera]

maybe gitHub only supports the RSA and DSA public key formats for deploy keys. The Ed25519 public key format is not supported.

To create a deploy key that GitHub will accept, you need to generate an RSA or DSA key.

[tushii05]

Copy Correct Public Key: After generating the key pair, make sure to copy the content of the newly generated public key (id_rsa.pub) correctly. Avoid any accidental changes or extra characters.

Check for Whitespace or Line Breaks: Ensure that there are no extra whitespace characters or line breaks in the public key content. The key should be a single continuous line.

Environment Differences: Analyze any differences between the environment where the key creation is successful (Postman) and the environment where it fails. Are there any proxy configurations, network restrictions, or security settings that might affect the key generation process?

[tushii05]

API Endpoint: Verify that the API endpoint and request parameters are consistent between the Postman environment and the other environment where you're encountering the error.

API Documentation: Check the API documentation to see if there are any specific requirements or guidelines for providing the public key during deploy key creation.

Error Handling: Ensure that you're handling error responses from the API properly in your application. The error message you provided indicates an issue with the key format, so your code should capture and display such error messages for troubleshooting.

[tushii05]

API Endpoint: Verify that the API endpoint and request parameters are consistent between the Postman environment and the other environment where you're encountering the error.

API Documentation: Check the API documentation to see if there are any specific requirements or guidelines for providing the public key during deploy key creation.

Error Handling: Ensure that you're handling error responses from the API properly in your application. The error message you provided indicates an issue with the key format, so your code should capture and display such error messages for troubleshooting.

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬