Trying requests in the docs

Every endpoint in the API reference has a Try it panel that sends the request from your browser. It can't compute the signature a service credential needs, so it uses a login token for your own CloudERM user instead.

Try it uses production

Requests go to https://api.clouderm.com as you, with your permissions. A GET only reads, but POST, PUT, PATCH and DELETE change real data in your organization.

Get a login token

read -r -p "Email: " CLOUDERM_USER
read -r -s -p "Password: " CLOUDERM_PASSWORD; echo
printf '{"username":"%s","password":"%s"}' "$CLOUDERM_USER" "$CLOUDERM_PASSWORD" |
  curl https://api.clouderm.com/v1/login -H "Content-Type: application/json" --data-binary @-
unset CLOUDERM_PASSWORD

This keeps your password out of your shell history and the process list.

The response's jwt field is the token, and data is when it expires (in milliseconds since 1970). In the reference, open Authentication, choose bearerAuth, and paste the token. The docs don't save it: it's gone when you close or reload the page.

Use this for exploring. Build an integration on a service credential, never on a person's password.

If Try it says the request failed

If the browser reports a CORS or network error with no status code, the request never reached CloudERM's normal handling. Two common causes:

• A request body that isn't valid JSON. Check the body you typed.
• The API isn't accepting requests from the docs site (the case until docs.clouderm.com is on its allow-list, and if it's ever removed).

Either way, copy the request as curl from the panel and run it in a terminal to see the real response.