Create a new key pair
POST/v1/projects/:projectId/zones/:zoneName/keypairs
Create a Key Pair: if the public key is not provided, generate it together with the private key.
Request
Path Parameters
Project Identifier
Zone name
Header Parameters
Your SIU token if you use this API through Orange Developer.
Bearer access token authentication if you use this API through Orange Developer or Orange Developer Inside.
Your SIU Id if you use this API through Orange Developer Inside.
- application/json
Bodyrequired
Key pair to create.
Unique resource name. This attribute can not be updated.
Possible values: <= 40 characters
, Value must match regular expression [A-Za-z0-9-]
Resource description
tags object
SSH Public Key to connect to virtual machines. If a public key is provided, it will be used to create the KeyPair resource. Otherwise, a public key and a private key will be automatically generated and their values will be returned as a result of the KeyPair creation request.
Possible values: >= 512 characters
and <= 2000 characters
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 500
- 503
Created
Response Headers
- application/json
- Schema
- Example (auto)
- OK
Schema
Resource identifier.
Hypertext reference of the resource.
SSH Public Key to connect to virtual machines. If a public key is provided, it will be used to create the KeyPair resource. Otherwise, a public key and a private key will be automatically generated and their values will be returned as a result of the KeyPair creation request.
Possible values: >= 512 characters
and <= 1024 characters
Value of the Private Key generated automatically if the Public Key was not provided NB: this value is visible only in the result of the creation. It will not be returned in the result of a GET request.
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"hRef": "string",
"publicKey": "string",
"privateKey": "string"
}
{ "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "hRef": "/projects/{projectId}/zones/{zoneName}/keypairs/{keyPairId}", "privateKey": "MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCDiJAec5i4De6UlVI9mabo9KHPPhVIIy4h8EWE+kZ/drdkRWyU+GfygMdTxgztymkJI81H/9TOad6n4j8n+/9TnJ+7RPR0gxuPJQ4UI0amOaM3x+Mo1ukqQCT4oXpVfC0MrZcBGoJ6yJCQB611/fVbsCWs5BMoypkX5HNV53gk6ak35WvbtlIN8uiZne4HXdHntTs1Ev7RGZjTluaIFbtJccGXqzYmkDpjgGbgI7bUY1mvkRetXIsorygticUzWo7luEn9g4YOQCvoZtFoUk0wYfs1fyfY5n4pCXC/0E2e+FyVDFqXhooKJkGYoJHnXVNA7fvlaWHJyLqGqrM6IJLGmK6RmXKEwN+4cQQRb2Q+FxQz53tAr0C25Aj0lEbZrQj27tEvIHlfe+FKtF4a4oLVD6xCRBKfWNgofyTm71z5P9Ejfh34TFXIkZJnEZovBPELv8FuS0dgwq/31X6hJpdeCy7ohg13efw2ElXvL/s8nAvtNTbS5f5jIib8LOCLBzmsOHcbxfjqLvi/HVRXwFTjIPlDBTXK+x8vaa16rwtlm0z+ICZTtDmt6lain0m0Kl/3T6MaUna9KHR1qjTd8tsB9w5fe2WEBJgbmrVClTFMLdwVR67jPlpdmPYNxh4PjeR0laZd2m3tS6Z3hMq/eYV+1dy1K4kEyC/qWw2wWSz+KQIDAQABAoICAAFYPhDxoZi3m77NIAAdOAWdqqILddg889XI/Qz0+g+HiSxvQULsnzNteZwzpCIyNYywXwLjbKuHjY0t1PN1shCKw19Ivy8JwBhgippOGgTNBgwl8P6T4+JYsYgRLoz9LgC5LZgHS1ox/rhaO72/EOkVDe2Mj12VZKdH4J36NdI6yU4W/FlMrd4So6oeYTaWEPVLdwV94jkFB/jxy/2MK1P+47nHOFCAnPgzcdnMw6u8MEiJNTLChXGvCLwecnOp81gJ4EfFNnOi2FAR7QYiAUQDXGwZlrCy+os024A6gvCjHV8wtyRhbbvY1EbZLWSuIZHCXRblUuibMrz5tcdcWePGHx4/BGNnqQTXYEagc+stM4Wox0Hv5JU6oLHhy2N0p9x054degwUvreY0t6oUZokM2TIGOJXxszW/tyzx0ROgHrQiBpH9XV1eq74QuCa/kw+Y6N3R5RXFx5FIbK7wbJwT84+S9omoKUkGwKBa3hvJKRPXdjauLnQlgIM1pe4FV5UV0oRPw1LSjLRYNZkDP8MY4ye+B5BLxtXGTNInLmJ8ol8/h4u4hyitpCBswSuimyII5q7wI9ob/c6fHek+sQPqETJ3rGxrYcio2snKspny4vXDrSX6bw+R6vhsGxPsdLvzbnD6Qouehmo7NQ4ZkJF6kngvKZG/pxYFd3xYu375AoIBAQC7NwobVlMDAJI/xKfybICr9ZTO5QIW0sN+eLVgSQFP2r6sC6UE/F4GAGrylIWGe0zn/0yMYES8yvRbSX4jnJT69cTqgHjerFFBSCVA7U2JJsVTDF0xnuqnZpUMnMgRoRWxJs4uXgTl3SMJCY2rXNWbtpzRkaLrynoQG27NyDBLVt6F+hBuGfD8WsaBb2t0gVT1Re7J2peNiCd6UnfhM2EtUlvbJ2vas3HDTrsdmIKNgrkTj8ITeP/ci2jF9Dc3K1APx7HWwWiPy1UYzLg/LXrZkSI9HqQr6Z0GiLzy3T2p3+5ipGDAe7BJ+M9m3uatxqZJLdw0N78AE67PiPvNIVfzAoIBAQCz3EKqMKp2pB2irvsq/f61vgGPctGkdSn0fnnboCM8lPV8FzO9WHDDaPEY9BKo+fyLsHKAcVXqUjC6z7HHKIh+C2qGWwIguf9S6/tVj0f9AmBrAHEYjFBU2iyH8JxJ3N9x2/Y51vKxkHu25lJthCustTe6vZY59eL5Vu8f/0NSlLGmaeN/v2sb31lPf5We02xMdrfi+gaX86sJHCzVR7bbsVFN3M3W5UvlAQBjR5aR30py0nNxIAg+84PAIfIoGa8ygVDYQ8j/zYYSjJeGAgrWnsKnorf401Ry46IuYasYfqMsvpWrUpIvhBofuOle+g2bON/7/yhGpSUsLzBCvpRzAoIBAQCkYz3ipzgY6MWCbOGzwoZxeCCEUx40gDjcso1A0JnwTnkihM8Pw7Gjv3YpLzTX0yjCha/nixiQVf2esrep+XHvsyKHbuuzSsfGdN0RV82/YmXd+HtUeOA+wZqbCoe6wyFS/moI2NGgLT74ToUxNUDzi7PDaQgP1yi7P/tZgjC11r9qERugMfMjA2pOeVF3aaD6BcAZSnHM+wL/K67L9ducejbiBolz7iE0h8tRv3rTWze7731Qr+yq8Va8iyZ4sPWKBaUol4eCy94a+pfGEd9Pb1sLI/6v+F/DPwn6jz34DgM6Zm/2VCWFro4fHBad/FJC65vx1glGvgG/hd7kTiT1AoIBAQCrzYScXtolc8SfJjfjLDWGUtXYuVuJlSUbV0h9Qq0F7F/FRcB1aCpmbjKGnHXKlOfoYwYsrJXdut6zQztUuuIOTEdXyUzyB9jc028DnlasVf3Vl9lwEm+VbcXFoE8ZuvJxJyQ+wZSXiiSyY7VuySaS1ZNDPF9oQ/ioJaNK1CDxm/lJtbHK0AS23hTIfF1mFhxHucsS87MiqG3CyPgGTndbyTeZgYXZdLOXLuq46qPn+Pt7TI1bDLbzstYxy/ss1MPmIWIhAjbYKfCcfVErf33s3j+fsy26b9sl10yOs1qkjiq9zdrXiIr8+lmd3ZqFz6L5l01Uv7kwKgWk+/pEdxkDAoIBAG7I5so4k3rfzc8/1bGWz2okN9ODz2o3h/jyVSnHHNiWQVebmUE3HlT7jksuh6x586U8v4QuVcVEJ+eDIXfUKll5EfeCVqpYI684VnNiOxt7Sg6JJ4mBpSilC6N4+2FTEx2WgrQ+fwGaX/kbri5B8G2ceNVLNN8lpF8IjXxHtbc5CPHYtQVV0gOK+3kd8CZnD4qVks7SveDC1GWseiGIDZg/NCt89tGksYmMAau32JoUPftgVs93mIpvuKUbJw64+iQk77ruTKVGLkafUMG3d7LQIyOZzXmm2YbEc4Dmez5lQEuPCc2TABtRBblSu+dEuLOjMTAFGlBxb1s3yFmuzTU=", "publicKey": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCDiJAec5j4De6UlVI9mabo9KHlShVIIy4h8EWE+kZ/drdkRWyU+GfygMdTxgztymkJI81H/9TOad6n4j8n+/9TnJ+7RPR0gxuPJQ4UI0amOaM3x+Mo1ukqQCT4oXpVfC0MrZcBGoJ6yJCQB611/fVbsCWs5BMoypkX5HNV53gk6ak35WvbtlIN8uiZne4HXdHntTs1Ev7RGZjTluaIFbtJccGXqzYmkDpjgGbgI7bUY1mvkRetXIsorygticUzWo7luEn9g4YOQCvoZtFoUk0wYfs1fyfY5n4pCXC/0E2e+FyVDFqXhooKJkGYoJHnXVNA7fvlaWHJyLqGqrM6IJLGmK6RmXKEwN+4cQQRb2Q+FxQz53tAr0C25Aj0lEbZrQj27tEvIHlfe+FKtF4a4oLVD6xCRBKfWNgofyTm71z5P9Ejfh34TFXIkZJnEZovBPELv8FuS0dgwq/31X6hJpdeCy7ohg13efw2ElXvL/s8nAvtNTbS5f5jIib8LOCLBzmsOHcbxfjqLvi/HVRXwFTjIPlDBTXK+x8vaa16rwtlm0z+ICZTtDmt6lain0m0Kl/3T6MaUna9KHR1qjTd8tsB9w5fe2WEBJgbmrVClTFMLdwVRAAjPlpdmPYNxh4Pje0la]+2m3tS6Z3hMq/eYV+1dy1K4kEyC/qWw2wWSz+KQ=="}
Bad Request
Request is not valid
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Unauthorized
Credentials are missing
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Forbidden
Valid credentials but not enough privileges to perform the operation
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Not Found
Unknown resource or service
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Method Not Allowed
Operation is not valid according to the state of the resource
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Internal Server Error
Unexpected error, please contact support
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
Service Unavailable
Service probably in maintenance. Please retry later.
- application/json
- Schema
- Example (auto)
Schema
An integer coding the error type. This is given to caller so he can translate them if required.
A short localized string that describes the error.
(optional) A long localized error description if needed. It can contain precise information about which parameter is missing, or what are the identifier acceptable values.
{
"code": 0,
"message": "string",
"description": "string"
}
- curl
- python
- go
- nodejs
- php
- java
- CURL
curl -L '/v1/projects/:projectId/zones/:zoneName/keypairs' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"name": "string",
"description": "string",
"tags": {},
"publicKey": "string"
}'