Check a location name
const url = 'https://example.com/api/v1/locations:checkName';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"location":"example","name":"example","parent":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/locations:checkName \ --header 'Content-Type: application/json' \ --data '{ "location": "example", "name": "example", "parent": "example" }'Reports whether a proposed name is a valid slug and currently free within the given placement (under the given parent, or among roots when no parent is given). Advisory (Save is still gated by the unique constraint). Gated by location:update.
Request Body required
Section titled “Request Body required ”object
A URL to the JSON Schema for this object.
The location (by name or uuid) the entity would be placed at, if any and if unparented; ignored by the locations check
The proposed name to check
The parent (by name or uuid) the entity would be created under, if any; omit for a root/unplaced check
Responses
Section titled “ Responses ”OK
object
A URL to the JSON Schema for this object.
Whether the name is free within the checked placement (parent/location); a name taken elsewhere in the fleet is still available here
Human explanation when not valid or not available
Whether the name matches the slug rule
Example
{ "$schema": "/api/v1/schemas/CheckNameOutputBody.json"}default
Section titled “default ”Error
object
A URL to the JSON Schema for this object.
A human-readable explanation specific to this occurrence of the problem.
Optional list of individual error details
object
Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’
Error message text
The value at the given location
A URI reference that identifies the specific occurrence of the problem.
HTTP status code
A short, human-readable summary of the problem type. This value should not change between occurrences of the error.
A URI reference to human-readable documentation for the error.
Example
{ "$schema": "/api/v1/schemas/ErrorModel.json", "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}