Simulators API — sim software catalog

The Simulators API lets you manage the catalog of sim racing software titles supported by PitPath Chrono. Each simulator can have layouts that map a PitPath track layout to the simulator’s internal identifier, and cars that do the same for vehicles. This mapping is essential when ingesting lap data from a specific simulator: the system uses these identifiers to resolve which canonical track layout or car the data belongs to. GET endpoints are public. Creating or modifying records requires a CRUD+ role.

Simulator object

string (UUID)

required

Unique identifier for the simulator.

string

required

Human-readable simulator name (3–120 characters).

string

required

URL-safe identifier (2–20 characters).

string

required

CDN key for the simulator’s square or standard logo asset.

string

required

CDN key for the simulator’s wide-format logo asset.

boolean

Whether the logo assets are SVG files.

object[]

List of simulator layout mappings embedded in the response.

Show SimulatorLayoutResponse properties

string (UUID)

UUID of this simulator.

string

Display name of this simulator.

string (UUID)

UUID of the PitPath track layout this entry maps to.

string

Display name of the mapped track layout.

string

The internal identifier used by the simulator to refer to this track (max 255 characters).

string (ISO 8601)

Timestamp when the simulator was created.

string (ISO 8601)

Timestamp of the most recent update.

List simulators

Public endpoint — no authentication required.

Returns all enabled simulators, each including their full list of layout mappings.

GET /api/v1/simulators

Example request

cURL

curl https://chrono.pitpath.de/api/v1/simulators \
  -H "X-API-Key: YOUR_API_KEY"

Example response

200

[
  {
    "id": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
    "displayName": "Assetto Corsa Competizione",
    "slug": "acc",
    "logo": "LOGO/acc.png",
    "logo_wide": "LOGO/acc-wide.png",
    "svg": false,
    "layouts": [
      {
        "simulatorId": "f1a2b3c4-d5e6-7890-abcd-ef1234567890",
        "simulatorDisplayName": "Assetto Corsa Competizione",
        "trackLayoutId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
        "trackLayoutDisplayName": "Grand Prix Circuit",
        "simulatorIdentifier": "nurburgring_gp"
      }
    ],
    "createdAt": "2024-01-01T00:00:00Z",
    "updatedAt": "2024-06-01T12:00:00Z"
  }
]

Get a simulator

Public endpoint — no authentication required.

Returns a single simulator by its UUID, including all layout mappings.

GET /api/v1/simulators/{simulatorId}

Path parameters

string (UUID)

required

The UUID of the simulator to retrieve.

Example request

cURL

curl https://chrono.pitpath.de/api/v1/simulators/f1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  -H "X-API-Key: YOUR_API_KEY"

Create a simulator

Requires CRUD+ role.

Registers a new simulator in the catalog. Returns 201 Created with a Location header.

POST /api/v1/simulators

Request body

string

required

Simulator name (3–120 characters).

string

required

URL-safe identifier (2–20 characters).

string

required

CDN key for the standard logo asset.

string

required

CDN key for the wide-format logo asset.

boolean

Whether the logo assets are SVG files. Defaults to false.

boolean

Whether the simulator appears in public listings. Defaults to true.

Example request

cURL

curl -X POST https://chrono.pitpath.de/api/v1/simulators \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Assetto Corsa Competizione",
    "slug": "acc",
    "logo": "LOGO/acc.png",
    "logoWide": "LOGO/acc-wide.png",
    "svg": false,
    "enabled": true
  }'

Update a simulator

Requires CRUD+ role.

Updates an existing simulator. All fields are required in the update body because the underlying service replaces the full set of mutable fields.

PATCH /api/v1/simulators/{simulatorId}

Path parameters

string (UUID)

required

The UUID of the simulator to update.

Request body

string

required

New simulator name (3–120 characters).

string

required

New URL-safe identifier (3–20 characters).

string

required

New CDN key for the standard logo.

string

required

New CDN key for the wide-format logo.

boolean

Whether the new logo assets are SVG files.

boolean

Set to false to hide from public listings.

Example request

cURL

curl -X PATCH https://chrono.pitpath.de/api/v1/simulators/f1a2b3c4-d5e6-7890-abcd-ef1234567890 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "displayName": "Assetto Corsa Competizione",
    "slug": "acc",
    "logo": "LOGO/acc-v2.png",
    "logoWide": "LOGO/acc-wide-v2.png",
    "enabled": true
  }'

Simulator layout mappings

A simulator layout maps a PitPath track layout to the string identifier the simulator uses for that track internally. The simulatorIdentifier is what the sim reports in its telemetry or data export — for example "nurburgring_gp" in Assetto Corsa Competizione.

List layouts for a simulator

Public endpoint — no authentication required.

GET /api/v1/simulators/{simulatorId}/layouts

string (UUID)

required

The UUID of the simulator.

Example request

cURL

curl https://chrono.pitpath.de/api/v1/simulators/f1a2b3c4-d5e6-7890-abcd-ef1234567890/layouts \
  -H "X-API-Key: YOUR_API_KEY"

Get a simulator layout

Public endpoint — no authentication required.

GET /api/v1/simulators/{simulatorId}/layouts/{trackLayoutId}

string (UUID)

required

The UUID of the simulator.

string (UUID)

required

The UUID of the PitPath track layout.

Create a simulator layout

Requires CRUD+ role.

Links a PitPath track layout to a simulator using the simulator’s own internal identifier.

POST /api/v1/simulators/{simulatorId}/layouts

string (UUID)

required

The UUID of the simulator.

Request body

string (UUID)

required

UUID of the PitPath track layout to link.

string

required

The internal string the simulator uses for this track (max 255 characters).

Example request

cURL

curl -X POST https://chrono.pitpath.de/api/v1/simulators/f1a2b3c4-d5e6-7890-abcd-ef1234567890/layouts \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "trackLayoutId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    "simulatorIdentifier": "nurburgring_gp"
  }'

Update a simulator layout

Requires CRUD+ role.

Updates the simulator’s internal identifier for an existing layout mapping.

PATCH /api/v1/simulators/{simulatorId}/layouts/{trackLayoutId}

string (UUID)

required

The UUID of the simulator.

string (UUID)

required

The UUID of the PitPath track layout.

Request body

string

required

The updated internal identifier (max 255 characters).

Example request

cURL

curl -X PATCH https://chrono.pitpath.de/api/v1/simulators/f1a2b3c4-d5e6-7890-abcd-ef1234567890/layouts/b2c3d4e5-f6a7-8901-bcde-f12345678901 \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"simulatorIdentifier": "nurburgring_gp_2024"}'

Delete a simulator layout

Requires CRUD+ role with delete permission.

Removes the link between a simulator and a track layout. Returns 204 No Content.

DELETE /api/v1/simulators/{simulatorId}/layouts/{trackLayoutId}

string (UUID)

required

The UUID of the simulator.

string (UUID)

required

The UUID of the PitPath track layout to unlink.

Example request

cURL

curl -X DELETE https://chrono.pitpath.de/api/v1/simulators/f1a2b3c4-d5e6-7890-abcd-ef1234567890/layouts/b2c3d4e5-f6a7-8901-bcde-f12345678901 \
  -H "X-API-Key: YOUR_API_KEY"

Simulator car mappings

In addition to track layouts, you can map PitPath cars to simulator-specific identifiers using the /cars sub-resource. This follows the same pattern as layout mappings.

List cars for a simulator

Public endpoint — no authentication required.

GET /api/v1/simulators/{simulatorId}/cars

Get a simulator car

Public endpoint — no authentication required.

GET /api/v1/simulators/{simulatorId}/cars/{carId}

The response includes simulatorId, simulatorDisplayName, carId, carDisplayName, carBrandId, carBrandDisplayName, carClassId, carClassDisplayName, simulatorIdentifier, and contentId.

Create a simulator car

Requires CRUD+ role.

POST /api/v1/simulators/{simulatorId}/cars

Request body

string (UUID)

required

UUID of the PitPath car to link.

string

required

The internal string the simulator uses for this car.

Update a simulator car

Requires CRUD+ role.

PATCH /api/v1/simulators/{simulatorId}/cars/{carId}

Request body

string

required

Updated internal identifier.

Delete a simulator car

Requires CRUD+ role with delete permission.

Removes the car mapping. Returns 204 No Content.

DELETE /api/v1/simulators/{simulatorId}/cars/{carId}

Overview

Endpoints

Simulators API — sim software catalog

Simulator object

List simulators

Get a simulator

Create a simulator

Update a simulator

Simulator layout mappings

List layouts for a simulator

Get a simulator layout

Create a simulator layout

Update a simulator layout

Delete a simulator layout

Simulator car mappings

List cars for a simulator

Get a simulator car

Create a simulator car

Update a simulator car

Delete a simulator car

​Simulator object

​List simulators

​Get a simulator

​Create a simulator

​Update a simulator

​Simulator layout mappings

​List layouts for a simulator

​Get a simulator layout

​Create a simulator layout

​Update a simulator layout

​Delete a simulator layout

​Simulator car mappings

​List cars for a simulator

​Get a simulator car

​Create a simulator car

​Update a simulator car

​Delete a simulator car

Simulator object

List simulators

Get a simulator

Create a simulator

Update a simulator

Simulator layout mappings

List layouts for a simulator

Get a simulator layout

Create a simulator layout

Update a simulator layout

Delete a simulator layout

Simulator car mappings

List cars for a simulator

Get a simulator car

Create a simulator car

Update a simulator car

Delete a simulator car