Check whether a project slug and its docs subdomain are free to use
GET/v1/projects/subdomain-availableTry it
Session token
Check whether a slug can be used for a new project, before you call Create Project. Every project's doc site is served from {slug}-docs.syntext.dev, so slugs are unique across all of Syntext, not just your organization.
Note
Requires a session JWT. Any signed-in user can call it — no organization role is needed. Any plan. API keys are not accepted.
Query Parameters
NameDescription
slug:stringqueryRequired
The slug to check, e.g. acme-api. It is trimmed and lower-cased before the check.
Response
NameDescription
data:object
Show 5 child attributesobject
slug:string
The slug that was checked, trimmed and lower-cased.
subdomain:string
The docs subdomain the slug maps to: {slug}-docs.
hostname:string
The full default hostname: {slug}-docs.syntext.dev.
available:boolean
true when a project can be created with this slug.
reason:string
Present only when available is false:
•
invalid — the slug is not 2–50 characters of a-z, 0-9 and -, the same rule Create Project applies.
•
taken — a project already uses the slug or its subdomain. Deleting a project releases its subdomain, so a deleted project's slug is available again.
The response never says which project or organization holds a taken slug.
Response — 200 OK
A taken slug:
An invalid slug is still a 200, with available: false and reason: "invalid".
Note
The result is a snapshot. Someone can take a free slug between this check and your create call, so handle 409 conflict from Create Project as well.