Skip to main content
GET
/
v1
/
generate
/
password
Generate Password
curl --request GET \
  --url https://api.example.com/v1/generate/password \
  --header 'X-API-Key: <api-key>'
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Query Parameters

length
integer
default:16

Password length

Required range: 8 <= x <= 128
uppercase
boolean
default:true

Include uppercase letters

lowercase
boolean
default:true

Include lowercase letters

numbers
boolean
default:true

Include numbers

symbols
boolean
default:true

Include symbols

exclude_ambiguous
boolean
default:false

Exclude ambiguous characters (0O1lI)

count
integer
default:1

How many passwords to generate

Required range: 1 <= x <= 10

Response

Successful Response