openapi.json 9.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238
  1. {
  2. "openapi": "3.0.1",
  3. "info": {
  4. "title": "API Reference",
  5. "description": "Sentry Public API",
  6. "termsOfService": "http://sentry.io/terms/",
  7. "contact": {
  8. "email": "partners@sentry.io"
  9. },
  10. "license": {
  11. "name": "Apache 2.0",
  12. "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
  13. },
  14. "version": "v0"
  15. },
  16. "servers": [
  17. {
  18. "url": "https://sentry.io/"
  19. }
  20. ],
  21. "tags": [
  22. {
  23. "name": "Teams",
  24. "description": "Endpoints for teams",
  25. "x-display-description": false,
  26. "externalDocs": {
  27. "description": "Found an error? Let us know.",
  28. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/teams/&template=api_error_template.md"
  29. }
  30. },
  31. {
  32. "name": "Organizations",
  33. "description": "Endpoints for organizations",
  34. "x-display-description": false,
  35. "externalDocs": {
  36. "description": "Found an error? Let us know.",
  37. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
  38. }
  39. },
  40. {
  41. "name": "Projects",
  42. "description": "Endpoints for projects",
  43. "x-display-description": false,
  44. "externalDocs": {
  45. "description": "Found an error? Let us know.",
  46. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/projects/&template=api_error_template.md"
  47. }
  48. },
  49. {
  50. "name": "Events",
  51. "x-sidebar-name": "Events & Issues",
  52. "description": "Endpoints for events and issues",
  53. "x-display-description": false,
  54. "externalDocs": {
  55. "description": "Found an error? Let us know.",
  56. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/events/&template=api_error_template.md"
  57. }
  58. },
  59. {
  60. "name": "Releases",
  61. "description": "Endpoints for releases",
  62. "x-display-description": false,
  63. "externalDocs": {
  64. "description": "Found an error? Let us know.",
  65. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/releases/&template=api_error_template.md"
  66. }
  67. },
  68. {
  69. "name": "Integration",
  70. "x-sidebar-name": "Integration Platform",
  71. "description": "Endpoints for the integration platform",
  72. "x-display-description": false,
  73. "externalDocs": {
  74. "description": "Found an error? Let us know.",
  75. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md"
  76. }
  77. },
  78. {
  79. "name": "SCIM",
  80. "x-sidebar-name": "SCIM",
  81. "description": "System for Cross-Domain Identity Management ([SCIM](http://www.simplecloud.info/)) is a standard implemented by Identity Providers and applications in order to facilitate federated identity management. Through these APIs you can add and delete members as well as teams. Sentry SaaS customers must be on a Business Plan with SAML2 Enabled. SCIM uses a bearer token for authentication that is created when SCIM is enabled. For how to enable SCIM, see our docs [here](/product/accounts/sso/#scim-provisioning).\n Sentry's SCIM API does not currently support syncing passwords, or setting any User attributes other than `active`.",
  82. "x-display-description": true,
  83. "externalDocs": {
  84. "description": "Found an error? Let us know.",
  85. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md"
  86. }
  87. }
  88. ],
  89. "paths": {
  90. "/api/0/teams/{organization_slug}/{team_slug}/": {
  91. "$ref": "paths/teams/by-slug.json"
  92. },
  93. "/api/0/teams/{organization_slug}/{team_slug}/stats/": {
  94. "$ref": "paths/teams/stats.json"
  95. },
  96. "/api/0/organizations/": {
  97. "$ref": "paths/organizations/index.json"
  98. },
  99. "/api/0/organizations/{organization_slug}/eventids/{event_id}/": {
  100. "$ref": "paths/organizations/event-id-lookup.json"
  101. },
  102. "/api/0/organizations/{organization_slug}/": {
  103. "$ref": "paths/organizations/details.json"
  104. },
  105. "/api/0/organizations/{organization_slug}/repos/": {
  106. "$ref": "paths/organizations/repos.json"
  107. },
  108. "/api/0/organizations/{organization_slug}/repos/{repo_id}/commits/": {
  109. "$ref": "paths/organizations/repo-commits.json"
  110. },
  111. "/api/0/organizations/{organization_slug}/stats/": {
  112. "$ref": "paths/organizations/stats.json"
  113. },
  114. "/api/0/organizations/{organization_slug}/sessions/": {
  115. "$ref": "paths/releases/sessions.json"
  116. },
  117. "/api/0/organizations/{organization_slug}/users/": {
  118. "$ref": "paths/organizations/users.json"
  119. },
  120. "/api/0/organizations/{organization_slug}/shortids/{short_id}/": {
  121. "$ref": "paths/organizations/shortid.json"
  122. },
  123. "/api/0/projects/": {
  124. "$ref": "paths/projects/index.json"
  125. },
  126. "/api/0/projects/{organization_slug}/{project_slug}/files/dsyms/": {
  127. "$ref": "paths/projects/dsyms.json"
  128. },
  129. "/api/0/projects/{organization_slug}/{project_slug}/users/": {
  130. "$ref": "paths/projects/users.json"
  131. },
  132. "/api/0/projects/{organization_slug}/{project_slug}/tags/{key}/values/": {
  133. "$ref": "paths/projects/tag-values.json"
  134. },
  135. "/api/0/projects/{organization_slug}/{project_slug}/stats/": {
  136. "$ref": "paths/projects/stats.json"
  137. },
  138. "/api/0/projects/{organization_slug}/{project_slug}/user-feedback/": {
  139. "$ref": "paths/projects/user-feedback.json"
  140. },
  141. "/api/0/projects/{organization_slug}/{project_slug}/hooks/": {
  142. "$ref": "paths/projects/service-hooks.json"
  143. },
  144. "/api/0/projects/{organization_slug}/{project_slug}/hooks/{hook_id}/": {
  145. "$ref": "paths/projects/service-hook-details.json"
  146. },
  147. "/api/0/projects/{organization_slug}/{project_slug}/events/{event_id}/": {
  148. "$ref": "paths/events/project-event-details.json"
  149. },
  150. "/api/0/projects/{organization_slug}/{project_slug}/events/": {
  151. "$ref": "paths/events/project-events.json"
  152. },
  153. "/api/0/projects/{organization_slug}/{project_slug}/issues/": {
  154. "$ref": "paths/events/project-issues.json"
  155. },
  156. "/api/0/organizations/{organization_slug}/issues/{issue_id}/tags/{key}/values/": {
  157. "$ref": "paths/events/tag-values.json"
  158. },
  159. "/api/0/organizations/{organization_slug}/issues/{issue_id}/tags/{key}/": {
  160. "$ref": "paths/events/tag-details.json"
  161. },
  162. "/api/0/organizations/{organization_slug}/issues/{issue_id}/hashes/": {
  163. "$ref": "paths/events/issue-hashes.json"
  164. },
  165. "/api/0/organizations/{organization_slug}/issues/{issue_id}/events/oldest/": {
  166. "$ref": "paths/events/oldest-event.json"
  167. },
  168. "/api/0/organizations/{organization_slug}/issues/{issue_id}/events/latest/": {
  169. "$ref": "paths/events/latest-event.json"
  170. },
  171. "/api/0/organizations/{organization_slug}/issues/{issue_id}/events/": {
  172. "$ref": "paths/events/issue-events.json"
  173. },
  174. "/api/0/organizations/{organization_slug}/issues/{issue_id}/": {
  175. "$ref": "paths/events/issue-details.json"
  176. },
  177. "/api/0/organizations/{organization_slug}/releases/": {
  178. "$ref": "paths/releases/organization-releases.json"
  179. },
  180. "/api/0/organizations/{organization_slug}/releases/{version}/": {
  181. "$ref": "paths/releases/organization-release.json"
  182. },
  183. "/api/0/organizations/{organization_slug}/releases/{version}/files/": {
  184. "$ref": "paths/releases/release-files.json"
  185. },
  186. "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/": {
  187. "$ref": "paths/releases/project-release-files.json"
  188. },
  189. "/api/0/organizations/{organization_slug}/releases/{version}/files/{file_id}/": {
  190. "$ref": "paths/releases/release-file.json"
  191. },
  192. "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/files/{file_id}/": {
  193. "$ref": "paths/releases/project-release-file.json"
  194. },
  195. "/api/0/organizations/{organization_slug}/releases/{version}/commits/": {
  196. "$ref": "paths/releases/organization-release-commits.json"
  197. },
  198. "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/commits/": {
  199. "$ref": "paths/releases/project-release-commits.json"
  200. },
  201. "/api/0/organizations/{organization_slug}/releases/{version}/commitfiles/": {
  202. "$ref": "paths/releases/organization-release-commit-files.json"
  203. },
  204. "/api/0/projects/{organization_slug}/{project_slug}/releases/{version}/resolved/": {
  205. "$ref": "paths/releases/project-issues-resolved-in-release.json"
  206. },
  207. "/api/0/organizations/{organization_slug}/releases/{version}/deploys/": {
  208. "$ref": "paths/releases/deploys.json"
  209. },
  210. "/api/0/organizations/{organization_slug}/sentry-app-installations/": {
  211. "$ref": "paths/integration-platform/sentry-app-installations.json"
  212. },
  213. "/api/0/sentry-app-installations/{uuid}/external-issues/": {
  214. "$ref": "paths/integration-platform/sentry-app-external-issues.json"
  215. },
  216. "/api/0/sentry-app-installations/{uuid}/external-issues/{external_issue_id}/": {
  217. "$ref": "paths/integration-platform/sentry-app-external-issue-details.json"
  218. },
  219. "/api/0/organizations/{organization_slug}/scim/v2/Groups": {
  220. "$ref": "paths/scim/team_index.json"
  221. },
  222. "/api/0/organizations/{organization_slug}/spike-protections/": {
  223. "$ref": "paths/projects/spike-protection.json"
  224. }
  225. },
  226. "components": {
  227. "securitySchemes": {
  228. "auth_token": {
  229. "type": "http",
  230. "scheme": "bearer"
  231. },
  232. "dsn": {
  233. "type": "http",
  234. "scheme": "DSN"
  235. }
  236. }
  237. }
  238. }