Updated on 2023-01-13 GMT+08:00

Exporting a Certificate

Function

This API is used to export a certificate.

URI

POST /v3/scm/certificates/{certificate_id}/export

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

certificate_id

Yes

String

Certificate ID

Minimum: 16

Maximum: 16

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the token API of IAM. The value of X-Subject-Token in the response header is the user token.

Minimum: 32

Maximum: 2097152

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

certificate

String

Certificate content

Minimum: 1

Maximum: 4096

certificate_chain

String

Certificate chain

Minimum: 1

Maximum: 8192

private_key

String

Private key of the certificate

Minimum: 1

Maximum: 4096

Status code: 401

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for a request.

Minimum: 3

Maximum: 36

error_msg

String

Error message of an error code.

Minimum: 0

Maximum: 1024

Status code: 403

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for a request.

Minimum: 3

Maximum: 36

error_msg

String

Error message of an error code.

Minimum: 0

Maximum: 1024

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code returned for a request.

Minimum: 3

Maximum: 36

error_msg

String

Error message of an error code.

Minimum: 0

Maximum: 1024

Example Requests

None

Example Responses

Status code: 200

Normal response.

{
  "certificate" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----",
  "certificate_chain" : "-----BEGIN CERTIFICATE-----*******-----END CERTIFICATE-----",
  "private_key" : "-----BEGIN RSA PRIVATE KEY-----******-----END RSA PRIVATE KEY-----"
}

Status code: 401

Verification 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 respond the request due to an internal server error.

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

Status Codes

Status Code

Description

200

Normal response.

401

Verification failed.

403

Access denied.

404

Requested page not found.

500

Failed to respond the request due to an internal server error.

Error Codes

See Error Codes.