---
title: "Generate and inspect UUIDs."
method: POST
path: "/api/v1/uuid"
tags: ["Cryptography & Hashing"]
---

# Generate and inspect UUIDs.

`POST /api/v1/uuid`

## Request

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

UUID Generator. Operations: `v4` — Generate one or more random (v4) UUIDs. `v3` — Generate a name-based (v3 / MD5) UUID. `parse` — Parse a UUID and report its version, variant and (where present) timestamp.

## Request body

- union
  - UuidV4: Generate one or more random (v4) UUIDs.
    - `operation` 'v4', required
    - `input` string: Unused (pass an empty string).
    - `options` object
      - `count` integer: How many UUIDs to generate.
      - `format` 'standard' | 'uppercase' | 'no-hyphens' | 'braces' | 'urn': Output format.
  - UuidV3: Generate a name-based (v3 / MD5) UUID.
    - `operation` 'v3', required
    - `input` string: The name to hash.
    - `options` object
      - `namespace` string: Namespace UUID.
  - UuidParse: Parse a UUID and report its version, variant and (where present) timestamp.
    - `operation` 'parse', required
    - `input` string: The UUID to parse.
    - `options` object

## Response `200`

The operation ran.

- object
  - `ok` unknown, required
  - `tool` 'uuid', required
  - `operation` 'v4' | 'v3' | 'parse', 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)