CoderHelm Docs
API

All routes

Every route the CoderHelm gateway serves (304 in all), read from its router at build time.

This list is generated from services/gateway/src/main.rs at commit 637aaa459db2 each time the docs are built, so it always matches the code. All paths are on https://api.coderhelm.com. Path parameters are written :name.

Unless a section says otherwise, a route needs a signed-in session: see Authentication. These are the routes the dashboard itself calls; they can change between releases, and there are no API keys for them yet.

Service

Public.

MethodPathHandler
GET/inline

Sign-in

Public, limited to 20 requests per 5 minutes per IP address.

MethodPathHandler
POST/auth/signupauth::signup
POST/auth/waitlistauth::join_waitlist
POST/auth/loginauth::login_email
POST/auth/verify-emailauth::verify_email
POST/auth/forgot-passwordauth::forgot_password
POST/auth/confirm-resetauth::confirm_reset
POST/auth/mfa/verifyauth::mfa_verify
GET/auth/googleauth::google_login
GET/auth/google/callbackauth::google_callback
GET/auth/githubauth::github_login
GET/auth/github/callbackauth::github_callback
POST/auth/logoutauth::logout

Webhooks

Public, but every call is verified: see Webhooks.

MethodPathHandler
POST/webhooks/githubgithub_webhook::handle
POST/webhooks/jira/:tokenjira_webhook::handle
POST/webhooks/jirajira_webhook::handle_forge
POST/webhooks/alerts/snsalerts::handle_sns
POST/webhooks/ci/tests/resultstests::ci_upload
GET/webhooks/ci/tests/quarantinetests::ci_quarantine

Public; the signed t token in the link is the credential. Limited to 60 requests per 5 minutes per IP address.

MethodPathHandler
GET/email/unsubscribeemail::unsubscribe_link
POST/email/unsubscribeemail::unsubscribe_one_click

Account and teams

MethodPathHandler
GET/api/meapi::me
GET/api/teamsapi::list_teams
POST/api/teams/switchapi::switch_team
PUT/api/teams/renameapi::rename_team
GET/api/allowlistapi::list_allowlist
POST/api/allowlistapi::add_to_allowlist
DELETE/api/allowlistapi::remove_from_allowlist
POST/api/account/resetapi::reset_account

Users and roles

MethodPathHandler
GET/api/usersusers::list_users
GET/api/users/permissionsusers::get_permissions
POST/api/users/inviteusers::invite_user
PUT/api/users/:user_id/roleusers::update_role
POST/api/users/:user_id/resendusers::resend_invite
POST/api/users/:user_id/link-githubusers::link_github
DELETE/api/users/:user_idusers::remove_user
PUT/api/users/passwordusers::change_password
POST/api/users/mfa/setupusers::mfa_setup
POST/api/users/mfa/verifyusers::mfa_verify_setup
DELETE/api/users/mfausers::mfa_disable

Runs

MethodPathHandler
GET/api/runsapi::list_runs
GET/api/runs/:run_idapi::get_run
GET/api/runs/:run_id/tracesapi::get_run_traces
GET/api/runs/:run_id/agent-logapi::get_agent_log
GET/api/runs/:run_id/openspecapi::get_run_openspec
POST/api/runs/:run_id/retryapi::retry_run
POST/api/runs/:run_id/resetapi::reset_and_rerun
POST/api/runs/:run_id/re-reviewapi::re_review_run
POST/api/runs/:run_id/cancelapi::cancel_run
POST/api/runs/:run_id/closerun_close::close_run
POST/api/runs/:run_id/reopenrun_close::reopen_run
POST/api/runs/closerun_close::close_runs
MethodPathHandler
GET/api/searchsearch::search

Repos

MethodPathHandler
GET/api/reposapi::list_repos
POST/api/repos/syncapi::sync_repos
POST/api/repos/:owner/:nameapi::update_repo
DELETE/api/repos/:owner/:nameapi::delete_repo
POST/api/repos/:owner/:name/regenerateapi::regenerate_repo
POST/api/repos/:owner/:name/roleapi::set_repo_role
POST/api/github/link-installationgithub::link_installation
GET/api/github/installation-statusgithub::installation_status

Plans

MethodPathHandler
GET/api/plansplans::list_plans
POST/api/plansplans::create_plan
POST/api/plans/chatplans::plan_chat
POST/api/plans/chat/tokenplans::stream_token
GET/api/plans/templatesplans::list_templates
POST/api/plans/templatesplans::create_template
POST/api/plans/templates/from-plan/:plan_idplans::create_template_from_plan
GET/api/plans/templates/:template_idplans::get_template
DELETE/api/plans/templates/:template_idplans::delete_template
POST/api/plans/templates/:template_id/useplans::use_template
GET/api/plans/:plan_idplans::get_plan
PUT/api/plans/:plan_idplans::update_plan
DELETE/api/plans/:plan_idplans::delete_plan
POST/api/plans/:plan_id/tasksplans::add_task
PUT/api/plans/:plan_id/tasks/:task_idplans::update_task
DELETE/api/plans/:plan_id/tasks/:task_idplans::delete_task
POST/api/plans/:plan_id/tasks/:task_id/approveplans::approve_task
POST/api/plans/:plan_id/tasks/:task_id/rejectplans::reject_task
POST/api/plans/:plan_id/executeplans::execute_plan
POST/api/plans/:plan_id/tasks/:task_id/force-runplans::force_run_task
POST/api/plans/:plan_id/approve-and-executeplans::approve_all_and_execute
GET/api/plans/:plan_id/openspecplans::get_plan_openspec
POST/api/plans/:plan_id/openspec/generateplans::generate_plan_openspec
POST/api/plans/chat/streamplans::plan_chat_stream

Reviewer and releases

MethodPathHandler
GET/api/reviewer/org-configreviewer::get_org_config
PUT/api/reviewer/org-configreviewer::update_org_config
GET/api/reviewer/config/:owner/:namereviewer::get_config
PUT/api/reviewer/config/:owner/:namereviewer::update_config
GET/api/reviewer/reviewsreviewer::list_reviews
GET/api/reviewer/reviewreviewer::get_review
GET/api/reviewer/livereviewer::live_prs
GET/api/reviewer/gatereviewer::get_gate
POST/api/reviewer/gatereviewer::control_gate
POST/api/reviewer/review/ratereviewer::rate_review
POST/api/reviewer/re-reviewreviewer::re_review
GET/api/reviewer/lessonsreview_lessons::list_lessons
DELETE/api/reviewer/lessonsreview_lessons::delete_lesson
GET/api/releasesreviewer::list_releases
POST/api/releases/sendreviewer::send_release
GET/api/releases/pendingreviewer::pending_releases
POST/api/releases/nowreviewer::release_now

Skills

MethodPathHandler
GET/api/skillsskills::list
POST/api/skills/reposskills::connect
DELETE/api/skills/repos/:owner/:nameskills::disconnect
POST/api/skills/repos/:owner/:name/syncskills::sync
GET/api/skills/itemskills::item
PUT/api/skills/itemskills::set_enabled
GET/api/skills/asksskills::asks
POST/api/skills/asksskills::try_agent
GET/api/skills/statsskills::stats
POST/api/skills/recheckskills::recheck
PUT/api/skills/alwaysskills::set_always_apply
PUT/api/skills/reviewsskills::set_reviews
PUT/api/skills/translatedskills::set_use_translated
GET/api/skills/activityskills::activity
GET/api/skills/usedskills::used

Team tools

MethodPathHandler
GET/api/toolstools::list
POST/api/toolstools::create
POST/api/tools/validatetools::check
GET/api/tools/askstools::asks
POST/api/tools/asks/:idtools::decide
GET/api/tools/:nametools::get
PUT/api/tools/:nametools::update
DELETE/api/tools/:nametools::remove
POST/api/tools/:name/approvetools::approve
POST/api/tools/:name/previewtools::preview

Connections (MCP)

MethodPathHandler
GET/api/plugins/catalogplugins::list_catalog
GET/api/pluginsplugins::list_enabled
POST/api/plugins/:id/enableplugins::enable_plugin
DELETE/api/plugins/:idplugins::disable_plugin
PUT/api/plugins/:id/credentialsplugins::update_credentials
PUT/api/plugins/:id/promptplugins::update_prompt
POST/api/plugins/:id/testplugins::test_connection

Data sources

MethodPathHandler
GET/api/data-sourcesdata_sources::list
GET/api/data-sources/activitydata_sources::activity
POST/api/data-sources/api/probedata_sources::probe
POST/api/data-sources/api/checkdata_sources::check
POST/api/data-sources/apidata_sources::create
POST/api/data-sources/restdata_sources::create_rest
POST/api/data-sources/searchdata_sources::create_search
GET/api/data-sources/aws/setupdata_sources::aws_setup
POST/api/data-sources/aws/connectdata_sources::aws_connect
POST/api/data-sources/logsdata_sources::create_logs
POST/api/data-sources/databasedata_sources::create_database
PUT/api/data-sources/:iddata_sources::update
DELETE/api/data-sources/:iddata_sources::remove
POST/api/data-sources/:id/keydata_sources::replace_key
POST/api/data-sources/:id/testdata_sources::test
GET/api/data-sources/:id/samplesdata_sources::samples
POST/api/data-sources/:id/trydata_sources::try_lookup
GET/api/data-sources/:id/hidden-suggestionsdata_sources::hidden_suggestions
POST/api/data-sources/:id/hidden-suggestionsdata_sources::decide_hidden_suggestions

Integrations

MethodPathHandler
GET/api/integrations/jira/checkapi::get_jira_integration_check
POST/api/integrations/jira/checkapi::validate_jira_integration_payload
DELETE/api/integrations/jira/checkapi::delete_jira_integration
POST/api/integrations/jira/secretapi::generate_jira_secret
DELETE/api/integrations/jira/secretapi::delete_jira_secret
GET/api/integrations/jira/configapi::get_jira_config
PUT/api/integrations/jira/configapi::update_jira_config
PUT/api/integrations/jira/projectsapi::update_jira_projects
GET/api/integrations/jira/projects/fetchapi::fetch_jira_projects
GET/api/integrations/jira/eventsapi::get_jira_events
GET/api/aws-connectionslog_analyzer::list_connections
POST/api/aws-connectionslog_analyzer::create_connection
GET/api/aws-connections/cfn-urllog_analyzer::get_cfn_url
PUT/api/aws-connections/:idlog_analyzer::update_connection
DELETE/api/aws-connections/:idlog_analyzer::delete_connection
POST/api/aws-connections/:id/testlog_analyzer::test_connection
GET/api/aws-connections/:id/log-groupslog_analyzer::discover_log_groups
PUT/api/aws-connections/:id/abilitiesintegrations::set_aws_abilities
POST/api/aws-connections/:id/abilities/checkintegrations::check_aws
GET/api/integrationsintegrations::list
GET/api/connectorsconnectors::list
GET/api/connectors/aws-checkconnectors::aws_check
PUT/api/connectors/:kindconnectors::save
DELETE/api/connectors/:kindconnectors::remove
POST/api/connectors/:kind/testconnectors::test
POST/integrations/jira/forge-registerapi::forge_register_urls

Memories

MethodPathHandler
GET/api/memoriesmemory::list_memories
POST/api/memoriesmemory::create_memory
GET/api/memories/agentsmemory::agent_profiles
POST/api/memories/previewmemory::preview_recall
GET/api/memories/statsmemory::memory_stats
DELETE/api/memories/:memory_idmemory::delete_memory
PUT/api/memories/:memory_idmemory::update_memory

Code graph

MethodPathHandler
GET/api/graph/reposgraph::list_repos
GET/api/graph/statusgraph::status
GET/api/graph/symbolgraph::symbol
GET/api/graph/neighborhoodgraph::neighborhood
PUT/api/graph/config/:owner/:namegraph::update_config
POST/api/graph/rebuild/:owner/:namegraph::rebuild

Settings and instructions

MethodPathHandler
GET/api/notificationsapi::get_notification_prefs
PUT/api/notificationsapi::update_notification_prefs
GET/api/instructions/globalapi::get_global_instructions
PUT/api/instructions/globalapi::update_global_instructions
GET/api/instructions/repo/:owner/:nameapi::get_repo_instructions
PUT/api/instructions/repo/:owner/:nameapi::update_repo_instructions
GET/api/rules/globalapi::get_global_rules
PUT/api/rules/globalapi::update_global_rules
GET/api/rules/repo/:owner/:nameapi::get_repo_rules
PUT/api/rules/repo/:owner/:nameapi::update_repo_rules
GET/api/voice/globalapi::get_global_voice
PUT/api/voice/globalapi::update_global_voice
GET/api/voice/repo/:owner/:nameapi::get_repo_voice
PUT/api/voice/repo/:owner/:nameapi::update_repo_voice
GET/api/agents/globalapi::get_global_agents
PUT/api/agents/globalapi::update_global_agents
GET/api/agents/repo/:owner/:nameapi::get_repo_agents
PUT/api/agents/repo/:owner/:nameapi::update_repo_agents
GET/api/settings/budgetapi::get_budget
PUT/api/settings/budgetapi::update_budget
GET/api/settings/workflowapi::get_workflow_settings
PUT/api/settings/workflowapi::update_workflow_settings
GET/api/settings/git-conventionsapi::get_git_conventions
PUT/api/settings/git-conventionsapi::update_git_conventions
GET/api/settings/model-providerapi::get_model_provider
PUT/api/settings/model-providerapi::update_model_provider
DELETE/api/settings/model-providerapi::delete_model_provider
GET/api/bannersbanners::list_banners

Usage and analytics

MethodPathHandler
GET/api/statsapi::get_stats
GET/api/stats/historyapi::get_stats_history
GET/api/analyticsanalytics::get_analytics
GET/api/usageapi::get_usage
GET/api/activity/summaryactivity::summary

Alerts

MethodPathHandler
GET/api/alert-routesalerts::list_routes
PUT/api/alert-routesalerts::put_route
DELETE/api/alert-routesalerts::delete_route
GET/api/alert-routes/alarmsalerts::list_topic_alarms
GET/api/alert-budgetalerts::get_budget
PUT/api/alert-budgetalerts::put_budget
GET/api/alert-notifyalerts::get_notify
PUT/api/alert-notifyalerts::put_notify
POST/api/alert-notify/testalerts::test_notify
POST/api/notify/testalerts::test_notify
GET/api/alertsalerts::list_events
GET/api/alerts/eventalerts::get_event

Infrastructure and logs

MethodPathHandler
GET/api/infrastructureinfrastructure::get_infrastructure
POST/api/infrastructure/refreshinfrastructure::refresh_infrastructure
GET/api/infrastructure/repo/:owner/:nameinfrastructure::get_repo_infrastructure
POST/api/infrastructure/repo/:owner/:name/refreshinfrastructure::refresh_repo_infrastructure
GET/api/recommendationslog_analyzer::list_recommendations
GET/api/recommendations/notifylog_analyzer::get_rec_notify
PUT/api/recommendations/notifylog_analyzer::put_rec_notify
POST/api/recommendations/:id/planlog_analyzer::create_plan_from_recommendation
POST/api/recommendations/:id/dismisslog_analyzer::dismiss_recommendation
GET/api/log-findingslog_findings::list_findings
GET/api/log-findings/autofixlog_findings::get_autofix
PUT/api/log-findings/autofixlog_findings::put_autofix
GET/api/log-findings/:id/sampleslog_findings::get_samples
POST/api/log-findings/:id/fixlog_findings::create_fix
POST/api/log-findings/:id/ignorelog_findings::ignore_finding
POST/api/log-findings/:id/acknowledgelog_findings::acknowledge_finding
POST/api/log-findings/:id/reopenlog_findings::reopen_finding

Tests

MethodPathHandler
GET/api/tests/settingstests::get_settings
PUT/api/tests/settingstests::put_settings
GET/api/tests/summarytests::summary
GET/api/tests/runstests::list_runs
GET/api/tests/runs/:run_keytests::get_run
GET/api/tests/failure-groupstests::failure_groups
GET/api/tests/coveragetests::coverage
POST/api/tests/recommendations/:id/accepttests::accept_recommendation
POST/api/tests/recommendations/:id/dismisstests::dismiss_recommendation
GET/api/teststests::list_tests
GET/api/tests/:idtests::get_test
POST/api/tests/:id/quarantinetests::quarantine
POST/api/tests/:id/pintests::pin
POST/api/tests/:id/fixtests::fix

Health and failed messages

MethodPathHandler
GET/api/healthapi::health
GET/api/dlqdlq::list_dlq_messages
POST/api/dlq/redrivedlq::redrive_dlq_message
POST/api/dlq/deletedlq::delete_dlq_message
POST/api/dlq/purgedlq::purge_dlq

Support

MethodPathHandler
GET/api/support/ticketssupport::list
POST/api/support/ticketssupport::create_handler
GET/api/support/tickets/:idsupport::get
POST/api/support/tickets/:id/replysupport::reply
POST/api/support/tickets/:id/resolvesupport::resolve
POST/api/support/tickets/:id/participantssupport::add_people
POST/api/support/tickets/:id/participants/removesupport::remove_people
GET/api/support/badgesupport::badge
GET/api/support/accesssupport_access::get_access
POST/api/support/accesssupport_access::grant_access
DELETE/api/support/accesssupport_access::revoke_access
GET/api/support/viewsupport_access::view_status
DELETE/api/support/viewsupport_access::exit_view

Platform admin

Session cookie, and only for CoderHelm operators listed in the platform configuration.

MethodPathHandler
GET/api/admin/teamsadmin::admin_teams
GET/api/admin/dlqadmin::admin_dlq
GET/api/admin/usage-checkadmin::admin_usage_check
POST/api/admin/dlq/deleteadmin::admin_dlq_delete
GET/api/admin/beta-signupsadmin::beta_signups
POST/api/admin/beta-signups/inviteadmin::invite_beta_signup
GET/api/admin/support/ticketssupport::admin_list_handler
GET/api/admin/support/tickets/:idsupport::admin_get
POST/api/admin/support/tickets/:id/replysupport::admin_reply_handler
POST/api/admin/support/tickets/:id/statussupport::admin_status
POST/api/admin/support/tickets/:id/participantssupport::admin_add_people
POST/api/admin/support/tickets/:id/participants/removesupport::admin_remove_people
POST/api/admin/support/viewsupport_access::start_view

Other

MethodPathHandler
GET/api/rolesroles::list_roles
POST/api/rolesroles::create_role
GET/api/roles/auditroles::list_audit
PUT/api/roles/:role_idroles::update_role
DELETE/api/roles/:role_idroles::delete_role
Edit on GitHub

Webhooks

The webhooks CoderHelm receives from GitHub, Jira and AWS, how each is verified, and what each event does.

Changelog

What changed in CoderHelm, month by month, from the merged pull requests of both repos.

On this page

ServiceSign-inWebhooksEmail linksAccount and teamsUsers and rolesRunsSearchReposPlansReviewer and releasesSkillsTeam toolsConnections (MCP)Data sourcesIntegrationsMemoriesCode graphSettings and instructionsUsage and analyticsAlertsInfrastructure and logsTestsHealth and failed messagesSupportPlatform adminOther