Updated on 2025-05-29 GMT+08:00

Upload CSR

Function

Upload CSR

URI

POST /v3/scm/csr/upload

Request Parameters

Table 1 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 32

Maximum: 2097152

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

User-defined CSR name.

Minimum: 0

Maximum: 63

csr

Yes

String

Certificate CSR file

Minimum: 0

Maximum: 2555

private_key

No

String

Certificate private key file

Minimum: 0

Maximum: 63

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

CSR ID.

Minimum: 32

Maximum: 32

name

String

User-defined CSR name.

Minimum: 1

Maximum: 63

create_time

Long

CSR creation time.

Minimum: 13

Maximum: 20

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for an error request.

Minimum: 3

Maximum: 36

error_msg

String

Error information returned for an error request.

Minimum: 0

Maximum: 1024

Example Requests

{
  "name" : "csrxxxx",
  "csr" : "xxxxxx",
  "private_key" : "xxxxxx"
}

Example Responses

Status code: 200

Normal response.

{
  "id" : "474a519e2c884c34a2d01033a6493b3c",
  "name" : "xxxx",
  "create_time" : 1685325399000
}

Status code: 401

Authentication failed.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 403

Access denied.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status code: 500

Failed to complete the request because of an internal server error.

{
  "error_code" : "SCM.XXX",
  "error_msg" : "XXX"
}

Status Codes

Status Code

Description

200

Normal response.

401

Authentication failed.

403

Access denied.

404

Access page not found.

500

Failed to complete the request because of an internal server error.

Error Codes

See Error Codes.