Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ User/ Adding an SSH Public Key
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Adding an SSH Public Key

Function

This API is used to add an SSH public key.

Debugging

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

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo::createUserSSHkey

Write

-

-

-

-

URI

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

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

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.

Response Parameters

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.

Example Requests

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

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

Example Responses

Status code: 201

OK

{
  "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 Codes

Status Code

Description

201

OK

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: User