Adding an SSH Public Key

This API is used to add an SSH public key.

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

POST https://{hostURL}/v4/user/keys

**Table 1** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A.

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
title	No	String	Definition Title. Range 1–1,000 characters.
key	No	String	Definition Key. Range 1–1,000 characters.

Status code: 201

**Table 3** Response body parameters
Parameter	Type	Description
id	Integer	Definition: Key ID Value range: 1~2147483647
title	String	Definition: Secret name Value range: 1–1,000 characters.
key	String	Definition Public key. Range 1–1,000 characters.
created_at	String	Definition Creation time. Range 1–1,000 characters.

Status code: 401

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Definition Error code.
error_msg	String	Definition Error message.

POST https://{endpoint}/v4/user/keys

{
  "key" : null,
  "title" : 12312
}

Status code: 201

{
  "id" : 2112483822,
  "title" : 12312,
  "key" : null,
  "created_at" : "2025-06-16T03:05:58.000+08:00"
}

Status code: 401

Unauthorized

{
  "error_code" : "DEV.00000003",
  "error_msg" : "Authentication information expired."
}

Status Code	Description
201	OK
401	Unauthorized

Parent topic: User

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.