/
OP
openrailassociation
/
OSRD Editoast
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 55m ago · Updated 16h ago
latest
OpenAPI 3.1.0
LGPL
raw.githubusercontent.com
2026-08-21
161
461
449.1 KB
e1fc96bc11fd
authz
8
post
/authz/grants
get
/authz/groups
get
/authz/me
post
/authz/me/grants
get
/authz/me/groups
post
/authz/me/privileges
post
/authz/user/info
get
/authz/{resource_type}/{resource_id}
catalog_entry
4
get
/catalog_entries
post
/catalog_entries
put
/catalog_entries/{id}
delete
/catalog_entries/{id}
delimited_area
1
get
Computes all tracks between a set of `entries` locations and a set of `exits` locations
documents
3
post
Post a new document (content_type by header + binary data)
get
Returns a document of any type
delete
Delete an existing document
electrical_profiles
5
get
Retrieve the list of ids and names of electrical profile sets available
post
import a new electrical profile set
get
Return a specific set of electrical profiles
delete
Delete an electrical profile set
get
Return the electrical profile value order for this set
fonts
1
get
This endpoint is used by map libre to retrieve the fonts. They are separated by font and unicode block
icons
1
get
/icons/{signaling_system}/{file_name}
infra
29
get
Lists all infras along with their current loading state in Core
post
Creates an empty infra
post
Import an infra from railjson
post
Refresh infra generated geographic layers
get
Returns the set of voltages for all infras and rolling_stocks modes.
get
Retrieve a specific infra
put
Rename an infra
post
Edit the content of an infrastructure
delete
Delete an infra and all entities linked to it.
get
Retrieve all objects attached to a given track
get
Retrieve a list of operations to fix infra issues
get
Retrieve the bounding box of an infra.
post
Duplicate an infra
get
A paginated list of errors related to an infra
get
Returns the BBoxes of a line
post
Lock an infra
post
/infra/{infra_id}/match_operational_points
post
Retrieves specific infra objects
get
/infra/{infra_id}/objects/{object_type}/ids
post
This endpoint search path between starting and ending track locations
get
Serialize an infra
post
Returns the list of routes crossing the specified nodes, along with the available positions for each of them.
get
Compute the track ranges through which routes passes.
get
Retrieve all routes that starting and ending by the given waypoint (detector or buffer stop)
get
Returns the set of speed limit tags for a given infra
post
/infra/{infra_id}/split_track_section
get
Return the railjson list of switch types
post
Unlock an infra
get
Returns the set of voltages for a given infra and/or rolling_stocks modes. If include_rolling_stocks_modes is true, it returns also rolling_stocks modes.
layers
2
get
Returns layer view metadata to query tiles
get
Mvt tile from the cache if possible, otherwise gets data from the database and caches it in valkey
level_crossing
1
post
Get the occupancy of a set of level crossings for a set of trains
linkings
3
post
Create linkings in batch
post
List train schedule linkings whose target or source is part of the input train schedules
post
Delete linkings in batch
pathfinding
2
post
Compute path properties
post
Compute a pathfinding
projects
5
get
Returns a paginated list of projects
post
Create a new project
get
Retrieve a project
delete
Delete a project
patch
Update a project
rolling_stock
17
get
Paginated list of rolling stock with a lighter response
get
Retrieve a rolling stock's light representation by its name
get
Retrieve a rolling stock's light representation by its id
post
Create a rolling stock
get
Get a rolling stock by name
get
Returns the set of power restrictions for all rolling_stocks modes.
get
Get a rolling stock by Id
put
Modify a rolling stock
delete
Delete a rolling_stock and all entities linked to it
post
Create a rolling stock livery
patch
Update rolling_stock locked field
get
List the scenarios (and their respective studies and projects) which use a given rolling stock.
get
/towed_rolling_stock
post
Create a towed rolling stock
get
/towed_rolling_stock/{towed_rolling_stock_id}
put
/towed_rolling_stock/{towed_rolling_stock_id}
patch
/towed_rolling_stock/{towed_rolling_stock_id}/locked
round_trips
2
post
Upsert a list of round trips / one-way of train schedules
post
Delete a list of round trips / one-way of train schedules
scenarios
15
get
Get macro node list by scenario id
post
Create macro nodes in batch
get
Retrieve a macro node by id
put
Update a macro node
delete
Delete a macro node
get
Return a list of notes for a given scenario
post
Create a note in batch
get
Return a specific note
put
Update a note
delete
Delete a note
get
Return a list of scenarios
post
Create a scenario
get
Return a specific scenario
delete
Delete a scenario
patch
Update a scenario
search
1
post
Returns all infra objects of some type according to a hierarchical query.
search_journey_environment
1
get
/search_journeys/search_environment
search_journeys
1
post
Search possible journeys from A to B using train parts from the given timetables.
similar_trains
1
post
/similar_trains
sprites
2
get
This endpoint returns the list of supported signaling systems
get
This endpoint is used by map libre to retrieve the atlas of each signaling system
stdcm
2
get
/stdcm/debug_data/{trace_id}
post
This function computes a STDCM and returns the result.
stdcm_search_environment
4
get
/stdcm/search_environment
post
/stdcm/search_environment
get
/stdcm/search_environment/list
delete
/stdcm/search_environment/{env_id}
studies
5
get
Return a list of studies
post
Create a new study
get
Return a specific study
delete
Delete a study
patch
Update a study
sub_categories
3
get
/sub_category
post
/sub_category
delete
/sub_category/{code}
temporary_speed_limits
1
post
/temporary_speed_limit_group
timetable
12
post
Create a timetable
delete
Delete a timetable
get
Retrieve the list of conflicts of the timetable
post
Retrieve list of local track names for each path step of each train schedule that match the given operational point references list
get
Retrieve the list of requirements of the timetable (invalid trains are ignored)
get
Paginated list of round trips / one-way of train schedules
get
Retrieve the list of train schedule sets linked to a timetable
post
Set links between a timetable and train schedule sets If a link already exists, it is ignored If a link exists and is not in the new list, it is removed
get
Return a specific timetable with its associated paced trains
delete
Delete a train schedule
get
Get a train schedule by its ID
put
Update a paced train
train_schedule
9
patch
/train_schedules/move
post
## Important: The following train schedules are **excluded** from the result: - train schedules for which pathfinding fails - train schedules for which the simulation fails - train schedules for which the simulation does not respect schedule times
post
Projects the space-time curves and paths of a number of train schedules onto a given path.
post
/train_schedules/project_path_op
post
Associate each train schedule id with its simulation summaries response If the simulation fails, it associates the reason: pathfinding failed or running time failed
post
/train_schedules/track_occupancy
get
Retrieve the etcs braking curves of an etcs train on etcs portions of the path
get
Get a path from a train schedule given an infrastructure id and a train schedule id
get
Retrieve the space, speed and time curve of a given train
train_schedule_exceptions
3
post
Create a train schedule exception
put
Update a train schedule exception
post
Delete train schedule exceptions
train_schedule_set
7
get
/train_schedule_sets
post
/train_schedule_sets
get
/train_schedule_sets/{id}
put
/train_schedule_sets/{id}
delete
/train_schedule_sets/{id}
get
List train schedules for a train schedule set
post
Create train schedules by batch
work_schedules
7
post
/work_schedules
get
/work_schedules/group
post
/work_schedules/group
get
/work_schedules/group/{id}
put
/work_schedules/group/{id}
delete
/work_schedules/group/{id}
post
/work_schedules/project_path
worker
1
post
Ensure a worker for the given infra (and stdcm timetable) is ready
get
/health
get
/version
authz
post
/authz/grants
Request body
union
required
grant
XOR
revoke
is expected
object
required
OR
object
required
Response
Successful granting