openapi.json 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  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://us.sentry.io/"
  19. },
  20. {
  21. "url": "https://de.sentry.io/"
  22. }
  23. ],
  24. "tags": [
  25. {
  26. "name": "Teams",
  27. "description": "Endpoints for teams",
  28. "x-display-description": false,
  29. "externalDocs": {
  30. "description": "Found an error? Let us know.",
  31. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/teams/&template=api_error_template.md"
  32. }
  33. },
  34. {
  35. "name": "Organizations",
  36. "description": "Endpoints for organizations",
  37. "x-display-description": false,
  38. "externalDocs": {
  39. "description": "Found an error? Let us know.",
  40. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
  41. }
  42. },
  43. {
  44. "name": "Projects",
  45. "description": "Endpoints for projects",
  46. "x-display-description": false,
  47. "externalDocs": {
  48. "description": "Found an error? Let us know.",
  49. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/projects/&template=api_error_template.md"
  50. }
  51. },
  52. {
  53. "name": "Events",
  54. "x-sidebar-name": "Events & Issues",
  55. "description": "Endpoints for events and issues",
  56. "x-display-description": false,
  57. "externalDocs": {
  58. "description": "Found an error? Let us know.",
  59. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/events/&template=api_error_template.md"
  60. }
  61. },
  62. {
  63. "name": "Releases",
  64. "description": "Endpoints for releases",
  65. "x-display-description": false,
  66. "externalDocs": {
  67. "description": "Found an error? Let us know.",
  68. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/releases/&template=api_error_template.md"
  69. }
  70. },
  71. {
  72. "name": "Integration",
  73. "x-sidebar-name": "Integration Platform",
  74. "description": "Endpoints for the integration platform",
  75. "x-display-description": false,
  76. "externalDocs": {
  77. "description": "Found an error? Let us know.",
  78. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md"
  79. }
  80. },
  81. {
  82. "name": "SCIM",
  83. "x-sidebar-name": "SCIM",
  84. "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`.",
  85. "x-display-description": true,
  86. "externalDocs": {
  87. "description": "Found an error? Let us know.",
  88. "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md"
  89. }
  90. }
  91. ],
  92. "paths": {
  93. "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/stats/": {
  94. "$ref": "paths/teams/stats.json"
  95. },
  96. "/api/0/organizations/{organization_id_or_slug}/eventids/{event_id}/": {
  97. "$ref": "paths/organizations/event-id-lookup.json"
  98. },
  99. "/api/0/organizations/{organization_id_or_slug}/repos/": {
  100. "$ref": "paths/organizations/repos.json"
  101. },
  102. "/api/0/organizations/{organization_id_or_slug}/repos/{repo_id}/commits/": {
  103. "$ref": "paths/organizations/repo-commits.json"
  104. },
  105. "/api/0/organizations/{organization_id_or_slug}/shortids/{short_id}/": {
  106. "$ref": "paths/organizations/shortid.json"
  107. },
  108. "/api/0/projects/": {
  109. "$ref": "paths/projects/index.json"
  110. },
  111. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/files/dsyms/": {
  112. "$ref": "paths/projects/dsyms.json"
  113. },
  114. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/users/": {
  115. "$ref": "paths/projects/users.json"
  116. },
  117. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/tags/{key}/values/": {
  118. "$ref": "paths/projects/tag-values.json"
  119. },
  120. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/stats/": {
  121. "$ref": "paths/projects/stats.json"
  122. },
  123. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/": {
  124. "$ref": "paths/projects/user-feedback.json"
  125. },
  126. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/": {
  127. "$ref": "paths/projects/service-hooks.json"
  128. },
  129. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/{hook_id}/": {
  130. "$ref": "paths/projects/service-hook-details.json"
  131. },
  132. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/": {
  133. "$ref": "paths/events/project-event-details.json"
  134. },
  135. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/issues/": {
  136. "$ref": "paths/events/project-issues.json"
  137. },
  138. "/api/0/issues/{issue_id}/tags/{key}/values/": {
  139. "$ref": "paths/events/tag-values.json"
  140. },
  141. "/api/0/issues/{issue_id}/hashes/": {
  142. "$ref": "paths/events/issue-hashes.json"
  143. },
  144. "/api/0/issues/{issue_id}/": {
  145. "$ref": "paths/events/issue-details.json"
  146. },
  147. "/api/0/organizations/{organization_id_or_slug}/releases/": {
  148. "$ref": "paths/releases/organization-releases.json"
  149. },
  150. "/api/0/organizations/{organization_id_or_slug}/releases/{version}/files/": {
  151. "$ref": "paths/releases/release-files.json"
  152. },
  153. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/files/": {
  154. "$ref": "paths/releases/project-release-files.json"
  155. },
  156. "/api/0/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/": {
  157. "$ref": "paths/releases/release-file.json"
  158. },
  159. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/files/{file_id}/": {
  160. "$ref": "paths/releases/project-release-file.json"
  161. },
  162. "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commits/": {
  163. "$ref": "paths/releases/organization-release-commits.json"
  164. },
  165. "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/commits/": {
  166. "$ref": "paths/releases/project-release-commits.json"
  167. },
  168. "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commitfiles/": {
  169. "$ref": "paths/releases/organization-release-commit-files.json"
  170. },
  171. "/api/0/organizations/{organization_id_or_slug}/releases/{version}/deploys/": {
  172. "$ref": "paths/releases/deploys.json"
  173. },
  174. "/api/0/organizations/{organization_id_or_slug}/sentry-app-installations/": {
  175. "$ref": "paths/integration-platform/sentry-app-installations.json"
  176. },
  177. "/api/0/sentry-app-installations/{uuid}/external-issues/": {
  178. "$ref": "paths/integration-platform/sentry-app-external-issues.json"
  179. },
  180. "/api/0/sentry-app-installations/{uuid}/external-issues/{external_issue_id}/": {
  181. "$ref": "paths/integration-platform/sentry-app-external-issue-details.json"
  182. },
  183. "/api/0/organizations/{organization_id_or_slug}/spike-protections/": {
  184. "$ref": "paths/projects/spike-protection.json"
  185. }
  186. },
  187. "components": {
  188. "securitySchemes": {
  189. "auth_token": {
  190. "type": "http",
  191. "scheme": "bearer"
  192. },
  193. "dsn": {
  194. "type": "http",
  195. "scheme": "DSN"
  196. }
  197. }
  198. }
  199. }