Updated on 2026-01-27 GMT+08:00

Calculating an SHA256 Hash

Function

This API is used to calculate SHA256 values. The values of the encrypted fields must be in the UUID format.

Calling Method

For details, see Calling APIs.

URI

GET /v3/sha256/{key}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

key

Yes

String

The keyword. The value of the encrypted field must be in the UUID format.

Minimum: 1

Maximum: 16384

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 IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 16384

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

value

String

The SHA256 value.

Minimum: 1

Maximum: 1048576

Example Requests

This example calculates an SHA256 value.

GET https://{endpoint}/v3/sha256/xxxxx

Example Responses

Status code: 200

Calculating an SHA256 value succeeded.

{
  "value" : "xxxxxxxxxxx"
}

Status Codes

Status Code

Description

200

Calculating an SHA256 value succeeded.

Error Codes

See Error Codes.