Skip to main content
GET
Check if an FTP username is available

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

username
string
required

Lowercase letters, digits and underscores; must start with a letter.

Required string length: 5 - 16
Pattern: ^[a-z][a-z0-9_]+[a-z0-9]$

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Response

The username is available. The response body is empty.