Check whether a project handle is free

Reports whether a handle can be used for a project and why not when it cannot, with free alternatives an agent can offer. A handle is one to five lowercase words of letters and digits separated by single hyphens, three to fifty-nine characters, and never one of the reserved words. Availability is answered across all projects without revealing which organization holds a taken handle.

get/v1/project-handles/{handle}

Request

  • Base URL: https://app.ohmyho.st
  • URL: https://app.ohmyho.st/v1/project-handles/{handle}
  • Auth: HTTP bearer

Path parameters

handlestring required

The handle a customer would like to use.

Headers

X-Request-Idstring

Optional caller-provided correlation identifier.

Response

Whether the handle is usable, and alternatives when it is not.

handlestring required

The handle exactly as it was asked about.

availableboolean required

True when a project may take this handle now.

reason'taken' | 'too_short' | 'too_long' | 'invalid_shape' | 'prohibited_word'

Why the handle cannot be used. Absent when it is available.

alternativesstring[] required

Free handles to offer instead, empty when the handle is available.

Changes

No recorded changes to this operation across all 1 revision of this API.