apyhub
DEVELOPER TOOLS · SECURITY & PRIVACY

Generate Password API

What it does

Password Generator creates a cryptographically secure random password from a single GET request. Send a length between 8 and 128 and a symbols flag to control whether special characters are included.

It returns the generated password along with the length used. That makes it easy to plug into signup flows, account recovery tools, admin dashboards, or internal utilities that need fresh credentials without handling password logic in your own code.

Use Password Generator when you need consistent password creation rules across services. You can request shorter passwords for constrained systems or longer ones for higher-entropy defaults, while keeping symbol usage configurable for sites that reject punctuation.

The response is simple and direct: a generated string you can present to a user, store temporarily, or hand off to another workflow.

GET
Generate a cryptographically secure random password of configurable length
http://localhost:8080/dosvak/password-generate
QUICKSTARTGUIDE

Quickstart

Generate a password with the default length and symbols enabled.

curl -X GET "http://localhost:8080/dosvak/password-generate?length=16&symbols=true" \
  -H "apy-token: $APY_TOKEN"

What you'll get back

Returns a JSON object with a length integer and a password string. length is the requested password length, and password is the generated password.

{
  "length": 16,
  "password": "A7!kQ3zP9mR2#tV8"
}
TRY ITLIVE · 10 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Generates a cryptographically secure random password and returns it in a JSON object along with the password length used.

Query Parameter(s)

AttributeTypeMandatoryDescription
lengthIntegerNoPassword length. Default: 16. Minimum: 8. Maximum: 128.
symbolsBooleanNoWhether to include symbols. Default: true.

Response

Returns a JSON object with length as an integer and password as a string. The length field reflects the generated password length, and password contains the generated password value.

ParameterTypeMandatoryDescription
lengthIntegerNoGenerated password length.
passwordStringNoGenerated password.

Query parameters

Name
Type
Description
lengthOPTIONAL
integer
DEFAULT 16
symbolsOPTIONAL
boolean
DEFAULT true
▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.