Whether a lowercase Community name is free. Names are globally unique at the AppView, and a record whose name is taken is rejected at projection time rather than at write time, so clients check before writing.
Parameters
Output
Encoding
application/jsonavailable
boolean
Required
No description available.
name
string
Required
No description available.
reason
string
Optional
Why the name is unavailable. Absent when available. `recently-released` is a name a Community gave up by renaming or being deleted: links shared under it still resolve there, so it is held for a cooldown before anyone else may take it.
Known values:
taken, invalid, reserved, recently-releasedTry It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"description": "Whether a lowercase Community name is free. Names are globally unique at the AppView, and a record whose name is taken is rejected at projection time rather than at write time, so clients check before writing.",
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"available": {
"type": "boolean"
},
"name": {
"type": "string"
},
"reason": {
"description": "Why the name is unavailable. Absent when available. `recently-released` is a name a Community gave up by renaming or being deleted: links shared under it still resolve there, so it is held for a cooldown before anyone else may take it.",
"knownValues": [
"taken",
"invalid",
"reserved",
"recently-released"
],
"type": "string"
}
},
"required": [
"name",
"available"
],
"type": "object"
}
},
"parameters": {
"properties": {
"name": {
"maxLength": 63,
"minLength": 2,
"type": "string"
}
},
"required": [
"name"
],
"type": "params"
},
"type": "query"
}