Skip to main content
POST
/
pilot
/
login
Error
A valid request URL is required to generate request examples
{
  "db_id": 123,
  "pilot_id": "QFA0001",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "jsmith@example.com",
  "rank": "First Officer",
  "rank_image": "<string>",
  "rank_level": 123,
  "avatar": "<string>",
  "token": "<string>"
}

Body

application/json
​
username
string
required

The pilot's displayed pilot ID (e.g. QFA0001) or their email address.

Example:

"QFA0001"

​
password
string<password>
required

The user's password.

Response

Credentials accepted.

​
db_id
integer
required

Internal database ID. Stable across pilot ID changes.

​
pilot_id
string
required

Display pilot ID (airline ICAO + zero-padded number per VA setting). Example: QFA0001.

Example:

"QFA0001"

​
first_name
string
required
​
last_name
string
required
​
email
string<email>
required
​
rank
string
required

Human-readable rank name.

Example:

"First Officer"

​
rank_image
string<uri> | null
required

URL to the pilot's rank insignia image. The Stratos client renders this as a rank badge in the dashboard and pilot-centre plugins. Return null if the rank has no image. The phpVMS reference resolves this from the rank's image_url column (relative paths are wrapped in your phpVMS public URL automatically).

​
rank_level
integer
required

Numeric rank tier (0-based) — index into the rank ladder ordered ascending by required hours. Used by the Stratos client for any rank-gated UI behaviour. The phpVMS reference computes this as the count of ranks with fewer required hours than the pilot's current rank, matching phpVMS's own auto-promote ordering.

​
avatar
string<uri>
required

Absolute URL to the pilot's avatar image.

​
token
string
required

The pilot's API key. Send as Authorization: Bearer <token> on every authenticated request.