---
title: "Compute MD5, SHA-1/256/384/512, CRC32 and HMAC digests."
method: POST
path: "/api/v1/hash"
tags: ["Cryptography & Hashing"]
---

# Compute MD5, SHA-1/256/384/512, CRC32 and HMAC digests.

`POST /api/v1/hash`

## Request

- Base URL: `https://programmes.net`
- URL: `https://programmes.net/api/v1/hash`
- Auth: none declared

Hash Generator. Operations: `hash` — Hash text with the chosen algorithm. `hmac` — Compute an HMAC digest (SHA algorithms only).

## Request body

- union
  - HashHash: Hash text with the chosen algorithm.
    - `operation` 'hash', required
    - `input` string: The text to hash.
    - `options` object
      - `algorithm` 'MD5' | 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512' | 'CRC32': Hash algorithm.
      - `format` 'hex' | 'base64' | 'binary': Output format.
      - `salt` string: Optional salt prefixed to the text.
  - HashHmac: Compute an HMAC digest (SHA algorithms only).
    - `operation` 'hmac', required
    - `input` string: The text to authenticate.
    - `options` object, required
      - `algorithm` 'SHA-1' | 'SHA-256' | 'SHA-384' | 'SHA-512': Hash algorithm.
      - `secret` string, required: The HMAC secret key.
      - `format` 'hex' | 'base64' | 'binary': Output format.

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'hash', required
  - `operation` 'hash' | 'hmac', required
  - `result` unknown, required

## Other responses

- `400`: The request is not valid (https://programmes.net/api#invalid-request); The tool has no such operation (https://programmes.net/api#unknown-operation)
- `404`: No such tool (https://programmes.net/api#unknown-tool)
- `413`: The request or its input is too large (https://programmes.net/api#content-too-large)
- `415`: The body must be JSON (https://programmes.net/api#unsupported-media-type)
- `422`: An option is missing, of the wrong type or out of range (https://programmes.net/api#invalid-options); This call needs more CPU than one API call may use (https://programmes.net/api#refused); The operation could not process the input (https://programmes.net/api#tool-error)
- `429`: Too many requests (https://programmes.net/api#rate-limited)
- `500`: Internal error (https://programmes.net/api#internal-error)

---

[API](https://skmtc.dev/programmes/apis/programmes-net-api.md) · [All operations](https://skmtc.dev/programmes/apis/programmes-net-api/llms.txt) · [OpenAPI document](https://skmtc.dev/programmes/apis/programmes-net-api/revisions/aa939784a2e6?raw)