Introduction
-The YAAMS REST API (v1) for virtual airline management - airlines, fleet and PIREPs. All endpoints live under /api/v1 and return JSON.
- -This documentation covers the YAAMS REST API v1. Every endpoint is served under `/api/v1` and returns JSON.
-
-Except for the public `GET /api/v1/info` endpoint, requests must be authenticated with a personal Sanctum bearer token (see the Authenticating section below).
-
-<aside>As you scroll, you'll see code examples for working with the API in different programming languages in the dark area to the right (or as part of the content on mobile).
-You can switch the language used with the tabs at the top right (or from the nav menu at the top left on mobile).</aside>Authenticating requests
-To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".
All authenticated endpoints are marked with a requires authentication badge in the documentation below.
Create a personal API token from your account settings (Settings → API tokens) in the web UI, then send it as a bearer token: Authorization: Bearer {YOUR_TOKEN}. Tokens are managed with Laravel Sanctum.
Account
- -The token owner's own account.
- -Current user
- --requires authentication -
- -"Who am I" - returns the account the API token belongs to, with its -airline memberships. Useful as a token sanity check for API clients.
- - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/user" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/user"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/user';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": {
- "id": 1,
- "name": "Homer Simpson",
- "email": "homer@test.com",
- "airlines": [
- {
- "id": 1,
- "name": "Example Virtual Airlines",
- "prefix": "EV",
- "icaoCallsign": "EVA",
- "atcCallsign": "EXAMPLE",
- "unitIsLbs": false,
- "requirePirepReview": true,
- "locationContinuity": false,
- "createdAt": "2026-01-01T00:00:00.000000Z",
- "updatedAt": "2026-01-01T00:00:00.000000Z"
- }
- ]
- }
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Aircraft
- -An airline's fleet. Aircraft are scoped to their airline - an aircraft that -does not belong to {airline} resolves as a 404.
- -List fleet
- --requires authentication -
- -List the airline's aircraft.
- - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/airlines/16/aircraft" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16/aircraft"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16/aircraft';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": [
- {
- "id": 7,
- "registration": "D-EXAM",
- "manufacturer": "Airbus",
- "model": "A320-200",
- "currentLoc": "EDDF",
- "engineType": "CFM56",
- "satcom": false,
- "winglets": true,
- "selcal": "AB-CD",
- "hexCode": "3C6444",
- "msn": "1234",
- "mtow": 78000,
- "mzfw": 62500,
- "mlw": 66000,
- "remarks": null,
- "status": "active",
- "active": true,
- "retiredAt": null,
- "retiredReason": null,
- "inServiceSince": "2020-01-01",
- "firstFlight": "2019-11-15",
- "createdAt": "2026-01-01T00:00:00.000000Z",
- "updatedAt": "2026-01-01T00:00:00.000000Z"
- }
- ]
-}
-
- --Example response (403):
-
-
-{
- "message": "You are not a member of this airline."
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Add an aircraft
- --requires authentication -
- -Add an aircraft to the airline's fleet. Requires the "add aircraft" -permission and membership of the airline. Permission, membership, -normalization and the duplicate-registration rule are enforced by -StoreAircraftRequest.
- - -Example request:- - -
-
-
-
-curl --request POST \
- "http://localhost:8000/api/v1/airlines/16/aircraft" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" \
- --data "{
- \"registration\": \"D-EXAM\",
- \"manufacturer\": \"Airbus\",
- \"model\": \"A320-200\",
- \"engine_type\": \"CFM56\",
- \"satcom\": false,
- \"winglets\": true,
- \"selcal\": \"AB-CD\",
- \"hex_code\": \"3C6444\",
- \"msn\": \"1234\",
- \"mtow\": 78000,
- \"mzfw\": 62500,
- \"mlw\": 66000,
- \"remarks\": \"Delivered new.\",
- \"current_loc\": \"EDDF\"
-}"
-
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16/aircraft"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-let body = {
- "registration": "D-EXAM",
- "manufacturer": "Airbus",
- "model": "A320-200",
- "engine_type": "CFM56",
- "satcom": false,
- "winglets": true,
- "selcal": "AB-CD",
- "hex_code": "3C6444",
- "msn": "1234",
- "mtow": 78000,
- "mzfw": 62500,
- "mlw": 66000,
- "remarks": "Delivered new.",
- "current_loc": "EDDF"
-};
-
-fetch(url, {
- method: "POST",
- headers,
- body: JSON.stringify(body),
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16/aircraft';
-$response = $client->post(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- 'json' => [
- 'registration' => 'D-EXAM',
- 'manufacturer' => 'Airbus',
- 'model' => 'A320-200',
- 'engine_type' => 'CFM56',
- 'satcom' => false,
- 'winglets' => true,
- 'selcal' => 'AB-CD',
- 'hex_code' => '3C6444',
- 'msn' => '1234',
- 'mtow' => 78000,
- 'mzfw' => 62500,
- 'mlw' => 66000,
- 'remarks' => 'Delivered new.',
- 'current_loc' => 'EDDF',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (201):
-
-
-{
- "data": {
- "id": 7,
- "registration": "D-EXAM",
- "manufacturer": "Airbus",
- "model": "A320-200",
- "currentLoc": "EDDF",
- "engineType": "CFM56",
- "satcom": false,
- "winglets": true,
- "selcal": "AB-CD",
- "hexCode": "3C6444",
- "msn": "1234",
- "mtow": 78000,
- "mzfw": 62500,
- "mlw": 66000,
- "remarks": null,
- "status": "active",
- "active": true,
- "retiredAt": null,
- "retiredReason": null,
- "inServiceSince": null,
- "firstFlight": null,
- "createdAt": "2026-07-11T12:00:00.000000Z",
- "updatedAt": "2026-07-11T12:00:00.000000Z"
- }
-}
-
- --Example response (403):
-
-
-{
- "message": "This action is unauthorized."
-}
-
- --Example response (422):
-
-
-{
- "message": "The registration field is required.",
- "errors": {
- "registration": [
- "The registration field is required."
- ]
- }
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Show an aircraft
- --requires authentication -
- -The scoped route binding 404s any aircraft that does not belong to {airline}.
- - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/airlines/16/aircraft/16" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16/aircraft/16"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16/aircraft/16';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": {
- "id": 7,
- "registration": "D-EXAM",
- "manufacturer": "Airbus",
- "model": "A320-200",
- "currentLoc": "EDDF",
- "engineType": "CFM56",
- "satcom": false,
- "winglets": true,
- "selcal": "AB-CD",
- "hexCode": "3C6444",
- "msn": "1234",
- "mtow": 78000,
- "mzfw": 62500,
- "mlw": 66000,
- "remarks": null,
- "status": "active",
- "active": true,
- "retiredAt": null,
- "retiredReason": null,
- "inServiceSince": "2020-01-01",
- "firstFlight": "2019-11-15",
- "createdAt": "2026-01-01T00:00:00.000000Z",
- "updatedAt": "2026-01-01T00:00:00.000000Z"
- }
-}
-
- --Example response (403):
-
-
-{
- "message": "You are not a member of this airline."
-}
-
- --Example response (404):
-
-
-{
- "message": "No query results for model [App\\Models\\Aircraft] 999"
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Airlines
- -Virtual airlines. Aircraft and flights are nested resources of an airline.
- -List airlines
- --requires authentication -
- - - - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/airlines?members_only=1" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines"
-);
-
-const params = {
- "members_only": "1",
-};
-Object.keys(params)
- .forEach(key => url.searchParams.append(key, params[key]));
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- 'query' => [
- 'members_only' => '1',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": [
- {
- "id": 1,
- "name": "Example Virtual Airlines",
- "prefix": "EV",
- "icaoCallsign": "EVA",
- "atcCallsign": "EXAMPLE",
- "unitIsLbs": false,
- "requirePirepReview": true,
- "locationContinuity": false,
- "createdAt": "2026-01-01T00:00:00.000000Z",
- "updatedAt": "2026-01-01T00:00:00.000000Z"
- }
- ]
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Found a new airline
- --requires authentication -
- -Requires the "add airlines" permission (enforced by StoreAirlineRequest).
- - -Example request:- - -
-
-
-
-curl --request POST \
- "http://localhost:8000/api/v1/airlines" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" \
- --data "{
- \"name\": \"Example Virtual Airlines\",
- \"prefix\": \"EV\",
- \"icao_callsign\": \"EVA\",
- \"atc_callsign\": \"EXAMPLE\"
-}"
-
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-let body = {
- "name": "Example Virtual Airlines",
- "prefix": "EV",
- "icao_callsign": "EVA",
- "atc_callsign": "EXAMPLE"
-};
-
-fetch(url, {
- method: "POST",
- headers,
- body: JSON.stringify(body),
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines';
-$response = $client->post(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- 'json' => [
- 'name' => 'Example Virtual Airlines',
- 'prefix' => 'EV',
- 'icao_callsign' => 'EVA',
- 'atc_callsign' => 'EXAMPLE',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (201):
-
-
-{
- "data": {
- "id": 2,
- "name": "Example Virtual Airlines",
- "prefix": "EV",
- "icaoCallsign": "EVA",
- "atcCallsign": "EXAMPLE",
- "unitIsLbs": false,
- "requirePirepReview": true,
- "locationContinuity": false,
- "createdAt": "2026-01-01T00:00:00.000000Z",
- "updatedAt": "2026-01-01T00:00:00.000000Z"
- }
-}
-
- --Example response (403):
-
-
-{
- "message": "This action is unauthorized."
-}
-
- --Example response (422):
-
-
-{
- "message": "The prefix has already been taken.",
- "errors": {
- "prefix": [
- "The prefix has already been taken."
- ]
- }
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Show an airline
- --requires authentication -
- - - - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/airlines/16" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": {
- "id": 1,
- "name": "Example Virtual Airlines",
- "prefix": "EV",
- "icaoCallsign": "EVA",
- "atcCallsign": "EXAMPLE",
- "unitIsLbs": false,
- "requirePirepReview": true,
- "locationContinuity": false,
- "createdAt": "2026-01-01T00:00:00.000000Z",
- "updatedAt": "2026-01-01T00:00:00.000000Z"
- }
-}
-
- --Example response (404):
-
-
-{
- "message": "No query results for model [App\\Models\\Airline] 999"
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Flights
- -PIREPs (pilot reports / flight logs) for an airline. Filing, listing, and - -for reviewers - the review queue plus accept/reject.
- -List my flights
- --requires authentication -
- -List the authenticated pilot's own flights for a specific airline.
- - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/airlines/16/flights?status_id=2" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16/flights"
-);
-
-const params = {
- "status_id": "2",
-};
-Object.keys(params)
- .forEach(key => url.searchParams.append(key, params[key]));
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16/flights';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- 'query' => [
- 'status_id' => '2',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": [
- {
- "id": 42,
- "callsign": "421",
- "flightNumber": "421",
- "fullFlightNumber": "EV421",
- "fullIcaoCallsign": "EVA421",
- "departureIcao": "EDDF",
- "arrivalIcao": "EGLL",
- "cruiseAltitude": 36000,
- "blockOff": "2026-07-11 10:00:00",
- "blockOn": "2026-07-11 11:30:00",
- "duration": "01:30",
- "burnedFuel": 4200,
- "route": "SOVAT UL610 KONAN",
- "onlineNetwork": 1,
- "status": {
- "id": 2,
- "name": "Accepted"
- },
- "remarks": null,
- "rejectionRemarks": null,
- "createdAt": "2026-07-11T11:35:00.000000Z",
- "updatedAt": "2026-07-11T11:40:00.000000Z"
- }
- ]
-}
-
- --Example response (403):
-
-
-{
- "message": "You are not a member of this airline."
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.File a PIREP
- --requires authentication -
- -Submit a new PIREP for the airline. Membership, airport/aircraft -existence and the location-continuity rule are enforced by -StoreFlightRequest. If the airline requires review the flight is created -Pending (status 1) and reviewers are notified; otherwise it is Accepted -(status 2) immediately.
- - -Example request:- - -
-
-
-
-curl --request POST \
- "http://localhost:8000/api/v1/airlines/16/flights" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" \
- --data "{
- \"flightnumber\": 421,
- \"departure_icao\": \"EDDF\",
- \"arrival_icao\": \"EGLL\",
- \"aircraft_id\": 7,
- \"callsign\": \"421\",
- \"crzalt\": 36000,
- \"blockoff\": \"2026-07-11 10:00:00\",
- \"blockon\": \"2026-07-11 11:30:00\",
- \"burned_fuel\": 4200,
- \"route\": \"SOVAT UL610 KONAN\",
- \"online_network_id\": 1,
- \"remarks\": \"Smooth flight.\"
-}"
-
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16/flights"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-let body = {
- "flightnumber": 421,
- "departure_icao": "EDDF",
- "arrival_icao": "EGLL",
- "aircraft_id": 7,
- "callsign": "421",
- "crzalt": 36000,
- "blockoff": "2026-07-11 10:00:00",
- "blockon": "2026-07-11 11:30:00",
- "burned_fuel": 4200,
- "route": "SOVAT UL610 KONAN",
- "online_network_id": 1,
- "remarks": "Smooth flight."
-};
-
-fetch(url, {
- method: "POST",
- headers,
- body: JSON.stringify(body),
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16/flights';
-$response = $client->post(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- 'json' => [
- 'flightnumber' => 421,
- 'departure_icao' => 'EDDF',
- 'arrival_icao' => 'EGLL',
- 'aircraft_id' => 7,
- 'callsign' => '421',
- 'crzalt' => 36000,
- 'blockoff' => '2026-07-11 10:00:00',
- 'blockon' => '2026-07-11 11:30:00',
- 'burned_fuel' => 4200.0,
- 'route' => 'SOVAT UL610 KONAN',
- 'online_network_id' => 1,
- 'remarks' => 'Smooth flight.',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (201):
-
-
-{
- "data": {
- "id": 42,
- "callsign": "421",
- "flightNumber": "421",
- "fullFlightNumber": "EV421",
- "fullIcaoCallsign": "EVA421",
- "departureIcao": "EDDF",
- "arrivalIcao": "EGLL",
- "cruiseAltitude": 36000,
- "blockOff": "2026-07-11 10:00:00",
- "blockOn": "2026-07-11 11:30:00",
- "duration": "01:30",
- "burnedFuel": 4200,
- "route": "SOVAT UL610 KONAN",
- "onlineNetwork": 1,
- "status": {
- "id": 1,
- "name": "Pending"
- },
- "remarks": null,
- "rejectionRemarks": null,
- "createdAt": "2026-07-11T11:35:00.000000Z",
- "updatedAt": "2026-07-11T11:35:00.000000Z"
- }
-}
-
- --Example response (403):
-
-
-{
- "message": "This action is unauthorized."
-}
-
- --Example response (422):
-
-
-{
- "message": "The departure icao field is required.",
- "errors": {
- "departure_icao": [
- "The departure icao field is required."
- ]
- }
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.List the review queue
- --requires authentication -
- -List pending PIREPs (status 1) for an airline. Requires the per-airline -Dispatcher or Manager role.
- - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/airlines/16/flights/review" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/airlines/16/flights/review"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/airlines/16/flights/review';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": [
- {
- "id": 43,
- "callsign": "422",
- "flightNumber": "422",
- "fullFlightNumber": "EV422",
- "fullIcaoCallsign": "EVA422",
- "departureIcao": "EGLL",
- "arrivalIcao": "EDDF",
- "cruiseAltitude": 37000,
- "blockOff": "2026-07-11 13:00:00",
- "blockOn": "2026-07-11 14:25:00",
- "duration": "01:25",
- "burnedFuel": 4100,
- "route": "DET L6 KONAN",
- "onlineNetwork": 1,
- "status": {
- "id": 1,
- "name": "Pending"
- },
- "remarks": null,
- "rejectionRemarks": null,
- "createdAt": "2026-07-11T14:30:00.000000Z",
- "updatedAt": "2026-07-11T14:30:00.000000Z"
- }
- ]
-}
-
- --Example response (403):
-
-
-{
- "message": "You do not have permission to review flights for this airline."
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Accept a PIREP
- --requires authentication -
- -Mark a pending PIREP as Accepted (status 2) and notify the pilot. -Requires the "review flight" permission for the flight's airline.
- - -Example request:- - -
-
-
-
-curl --request POST \
- "http://localhost:8000/api/v1/flights/16/accept" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/flights/16/accept"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "POST",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/flights/16/accept';
-$response = $client->post(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": {
- "id": 43,
- "callsign": "422",
- "flightNumber": "422",
- "fullFlightNumber": "EV422",
- "departureIcao": "EGLL",
- "arrivalIcao": "EDDF",
- "status": {
- "id": 2,
- "name": "Accepted"
- },
- "rejectionRemarks": null
- }
-}
-
- --Example response (403):
-
-
-{
- "message": "This action is unauthorized."
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Reject a PIREP
- --requires authentication -
- -Mark a PIREP as Rejected (status 3) and notify the pilot. If location -continuity is on and the flight was still pending, the aircraft is moved -back to the flight's departure. Requires the "review flight" permission.
- - -Example request:- - -
-
-
-
-curl --request POST \
- "http://localhost:8000/api/v1/flights/16/reject" \
- --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json" \
- --data "{
- \"rejection_remarks\": \"Cruise altitude above aircraft ceiling.\"
-}"
-
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/flights/16/reject"
-);
-
-const headers = {
- "Authorization": "Bearer {YOUR_AUTH_KEY}",
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-let body = {
- "rejection_remarks": "Cruise altitude above aircraft ceiling."
-};
-
-fetch(url, {
- method: "POST",
- headers,
- body: JSON.stringify(body),
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/flights/16/reject';
-$response = $client->post(
- $url,
- [
- 'headers' => [
- 'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- 'json' => [
- 'rejection_remarks' => 'Cruise altitude above aircraft ceiling.',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": {
- "id": 43,
- "callsign": "422",
- "flightNumber": "422",
- "fullFlightNumber": "EV422",
- "departureIcao": "EGLL",
- "arrivalIcao": "EDDF",
- "status": {
- "id": 3,
- "name": "Rejected"
- },
- "rejectionRemarks": "Cruise altitude above aircraft ceiling."
- }
-}
-
- --Example response (403):
-
-
-{
- "message": "This action is unauthorized."
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.Instance
- -Public metadata about this YAAMS instance.
- -Instance info
- --
- -Public instance metadata for API clients (e.g. ACARS "connect to your VA" -setup screens). Unauthenticated by design - exposes only what the public -landing page already shows.
- - -Example request:- - -
-
-
-
-curl --request GET \
- --get "http://localhost:8000/api/v1/info" \
- --header "Content-Type: application/json" \
- --header "Accept: application/json"
-
-
-
-const url = new URL(
- "http://localhost:8000/api/v1/info"
-);
-
-const headers = {
- "Content-Type": "application/json",
- "Accept": "application/json",
-};
-
-
-fetch(url, {
- method: "GET",
- headers,
-}).then(response => response.json());
-
-
-
-
-
- $client = new \GuzzleHttp\Client();
-$url = 'http://localhost:8000/api/v1/info';
-$response = $client->get(
- $url,
- [
- 'headers' => [
- 'Content-Type' => 'application/json',
- 'Accept' => 'application/json',
- ],
- ]
-);
-$body = $response->getBody();
-print_r(json_decode((string) $body));--Example response (200):
-
-
-{
- "data": {
- "name": "Example Virtual Airlines",
- "version": "1.1.0",
- "apiVersion": "v1",
- "supportEmail": "ops@example.com",
- "features": {
- "registration": true,
- "userAirlineCreation": false
- }
- }
-}
-
-
-
- Received response: --
Request failed with error:-
-
-Tip: Check that you're properly connected to the network.
-If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
-You can check the Dev Tools console for debugging information.