ICD (/infra) API Parameter Review

Source: services/config_app/src/web/infra.py + services/config_app/src/model/pModel.py. Gateway prefix: /config/infra/*.

Pass — Client should send this value in the request.

Internal — Server should derive / default / generate this; client should not send.

Auth-derived — Comes from the JWT (tenant context); never client-controlled.

Mark each field, add notes in the last column, then Print/Save PDF.

/infra/company — Company (tenant) records

GET /infra/company

List companies. DORI_ADMIN sees all; other roles see only their own tenant.

No parameters.

POST /infra/company

Create a company; optionally also create its first DORI_ADMIN user in the same transaction (ICD onboarding flow). Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes
`company_id`	str	optional	Handler slugifies from `name` when omitted.
`name`	str	required	—
`display_name`	str	optional	—
`last_run`	int	optional	—
`ux_config`	str	optional	—
`service_bundle_ids`	int[]	optional	Accepted but not persisted (no company↔service_bundle junction yet).
`admin_email`	EmailStr	optional	ICD onboarding: triggers DORI_ADMIN user creation.
`admin_password`	str	conditional	Required when `admin_email` is set.
`admin_first_name`	str	optional	—
`admin_last_name`	str	optional	—
`admin_phone`	str	optional	—

DELETE /infra/company/{company_id}

Delete a company. Path param only. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`company_id` (path)	int	required	—

/infra/user — Platform-wide user management

GET /infra/user?company_id=

List users across every company; ?company_id= filters to one tenant. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`company_id` (query)	int	optional	Filter.

POST /infra/user

Create a user under any company. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes	Pass
`company_id`	int	required	Target company.
`email`	EmailStr	required	Also used as `user_id` server-side.
`password`	str	required	Hashed server-side.
`first_name`	str	optional	—
`last_name`	str	optional	—
`phone`	str	optional	—
`user_role`	str	optional	default = "DORI_ADMIN"
is_active	bool	—	Hard-coded True server-side.	— server-set —
is_confirmed	bool	—	Hard-coded True server-side.	— server-set —

DELETE /infra/user/{user_id}

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`user_id` (path)	int	required	—

/infra/credentials — AWS credentials (per company)

GET /infra/credentials?company_id=

Auth: ADMIN. company_id only usable by DORI_ADMIN; tenant admin's is auth-derived.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`company_id` (query)	int	optional (DORI_ADMIN only)	Tenant admin — server derives from JWT.

POST /infra/credentials?company_id=

Upsert. Auth: ADMIN.

Field	Type	Req/Opt	Default / Notes
`company_id` (query)	int	optional (DORI_ADMIN only)	Tenant admin — auth-derived.
`access_key_id`	str	optional	—
`secret_access_key`	str	optional	—
`region`	str	optional	—
`bucket`	str	optional	—
`file_path`	str	optional	—

/infra/mlc — MLC (the compute node entity)

GET /infra/mlc

List all MLCs with attached configs. No parameters.

POST /infra/mlc

Create an MLC. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes
`name`	str	required	—
`url`	str	required	—
`status`	str	optional	—
`callback_url`	str	optional	—
`mount_point`	str	optional	—
`auth_token`	str	optional	—
`deployment_id`	str	optional	—
`sort_order`	int	optional	—
`model_class`	str	optional	—
`instance_type`	str	optional	—
`is_active`	bool	optional	default = True
`service_bundle_id`	int	optional	FK
`max_capacity`	int	optional	default = 10
`current_capacity`	int	optional	default = 0
`is_deployed`	bool	optional	default = False
`is_configured`	bool	optional	default = False
`poll_count`	int	optional	default = 0
`media_server_url`	str	optional	—

DELETE /infra/mlc/{mlc_id}

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`mlc_id` (path)	int	required	—

/infra/mlc_config — MLC tuning knobs (platform-level)

GET /infra/mlc_config?mlc_id=&company_id=

List configs; optional filters.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`mlc_id` (query)	int	optional	Filter to one MLC.
`company_id` (query)	int	optional	Filter to one company (via junction).

POST /infra/mlc_config

Create. Auth: DORI_ADMIN. Every field optional; server auto-names config-{id} if name omitted.

Field	Type	Req/Opt	Default / Notes
`mlc_id`	int	optional	FK; must exist if supplied.
`name`	str	optional	Server-generates `config-{id}` if empty.
`predictdb_url`	str	optional	—
`predictdb_port`	str	optional	—
`predictdb_name`	str	optional	—
`predictdb_user`	str	optional	—
`predictdb_password`	str	optional	—
`eventdb_url`	str	optional	—
`eventdb_port`	str	optional	—
`eventdb_name`	str	optional	—
`eventdb_user`	str	optional	—
`eventdb_password`	str	optional	—
`frame_window`	int	optional	default = 0
`max_queue_depth`	int	optional	default = 0
`queue_upper_bound`	int	optional	default = 0
`queue_lower_bound`	int	optional	default = 0
`is_benchmark`	bool	optional	default = True
`is_postgres`	bool	optional	default = True
`skip_count`	int	optional	default = 1
`scale`	int	optional	default = 100
`fps`	int	optional	default = 1
`non_max_suppression_conf`	float	optional	default = 0.25
`non_max_suppression_iou`	float	optional	default = 0.45
`second_model_def_state`	bool	optional	default = False
`inference_processes`	int	optional	default = 3

PATCH /infra/mlc_config/{config_id}

Partial update — every field optional; only send what you want to change.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`config_id` (path)	int	required	—
Body: same field set as POST /mlc_config, all optional.

DELETE /infra/mlc_config/{config_id}

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`config_id` (path)	int	required	Junction rows cascade.

/infra/mlc_config/{id}/companies — Junction: which companies a config applies to

GET /infra/mlc_config/{config_id}/companies

Returns an array of company_id ints.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`config_id` (path)	int	required	—

POST /infra/mlc_config/{config_id}/companies

Assign one or more companies to a config. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes
`config_id` (path)	int	required	—
`company_ids`	int[]	required	Each must exist.
`merge`	bool	optional	default = True (append). False = replace membership set.

DELETE /infra/mlc_config/{config_id}/companies/{company_id}

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`config_id` (path)	int	required	—
`company_id` (path)	int	required	—

/infra/client — Downstream Dori deployments

GET /infra/client

List clients with attached user ids.

POST /infra/client

Create a client; optional user_id also creates the client_user junction row. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes
`name`	str	optional	—
`app_server_url`	str	required	—
`dashboard_url`	str	optional	—
`is_active`	bool	optional	default = True
`user_id`	int	optional	Creates junction row when supplied.

DELETE /infra/client/{client_id}

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`client_id` (path)	int	required	—

/infra/company_config — Key/value company config

GET /infra/company_config?company_id=

Returns {key: value} map. Auth: tenant.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`company_id` (query)	int	optional (DORI_ADMIN only)	Tenant admin — auth-derived.

POST /infra/company_config?company_id=

Upsert key/value pairs. Body is a raw {key: value} dict. Auth: ADMIN.

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`company_id` (query)	int	optional (DORI_ADMIN only)	Tenant admin — auth-derived.
body `{key: value, ...}`	dict	required	Free-form key/value.

/infra/service_bundle — Service bundle definitions

GET /infra/service_bundle

List service bundles.

POST /infra/service_bundle

Create a service bundle. Auth: DORI_ADMIN.

Field	Type	Req/Opt	Default / Notes
`name`	str	required	—
`version`	str	optional	—
`description`	str	optional	—
`service_bundle_url`	str	optional	—
`service_bundle_config`	str	optional	—

DELETE /infra/service_bundle/{bundle_id}

Field	Type	Req/Opt	Default / Notes	Pass	Internal	Notes
`bundle_id` (path)	int	required	—

/infra/system_event — Stub (501 by design)

POST /infra/system_event

Pending — see /monitor/system_event/ for the wired version. Returns 501.

No parameters currently.

Generated from services/config_app/src/web/infra.py and services/config_app/src/model/pModel.py on the feat/icd-platform-admin-and-mlc-config branch.

ICD (/infra) API Parameter Review Print / Save PDF