sentry/api-docs/openapi.json

{
  "openapi": "3.0.1",
  "info": {
    "title": "API Reference",
    "description": "Sentry Public API",
    "termsOfService": "http://sentry.io/terms/",
    "contact": {
      "email": "partners@sentry.io"
    },
    "license": {
      "name": "Apache 2.0",
      "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
    },
    "version": "v0"
  },
  "servers": [
    {
      "url": "https://sentry.io/"
    }
  ],
  "tags": [
    {
      "name": "Teams",
      "description": "Endpoints for teams",
      "x-display-description": false,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/teams/&template=api_error_template.md"
      }
    },
    {
      "name": "Organizations",
      "description": "Endpoints for organizations",
      "x-display-description": false,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/organizations/&template=api_error_template.md"
      }
    },
    {
      "name": "Projects",
      "description": "Endpoints for projects",
      "x-display-description": false,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/projects/&template=api_error_template.md"
      }
    },
    {
      "name": "Events",
      "x-sidebar-name": "Events & Issues",
      "description": "Endpoints for events and issues",
      "x-display-description": false,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/events/&template=api_error_template.md"
      }
    },
    {
      "name": "Releases",
      "description": "Endpoints for releases",
      "x-display-description": false,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/releases/&template=api_error_template.md"
      }
    },
    {
      "name": "Integration",
      "x-sidebar-name": "Integration Platform",
      "description": "Endpoints for the integration platform",
      "x-display-description": false,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md"
      }
    },
    {
      "name": "SCIM",
      "x-sidebar-name": "SCIM",
      "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`.",
      "x-display-description": true,
      "externalDocs": {
        "description": "Found an error? Let us know.",
        "url": "https://github.com/getsentry/sentry-docs/issues/new/?title=API%20Documentation%20Error:%20/api/integration-platform/&template=api_error_template.md"
      }
    }
  ],
  "paths": {
    "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/": {
      "$ref": "paths/teams/by-slug.json"
    },
    "/api/0/teams/{organization_id_or_slug}/{team_id_or_slug}/stats/": {
      "$ref": "paths/teams/stats.json"
    },
    "/api/0/organizations/": {
      "$ref": "paths/organizations/index.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/eventids/{event_id}/": {
      "$ref": "paths/organizations/event-id-lookup.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/": {
      "$ref": "paths/organizations/details.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/repos/": {
      "$ref": "paths/organizations/repos.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/repos/{repo_id}/commits/": {
      "$ref": "paths/organizations/repo-commits.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/shortids/{short_id}/": {
      "$ref": "paths/organizations/shortid.json"
    },
    "/api/0/projects/": {
      "$ref": "paths/projects/index.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/files/dsyms/": {
      "$ref": "paths/projects/dsyms.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/users/": {
      "$ref": "paths/projects/users.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/tags/{key}/values/": {
      "$ref": "paths/projects/tag-values.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/stats/": {
      "$ref": "paths/projects/stats.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/user-feedback/": {
      "$ref": "paths/projects/user-feedback.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/": {
      "$ref": "paths/projects/service-hooks.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/hooks/{hook_id}/": {
      "$ref": "paths/projects/service-hook-details.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/{event_id}/": {
      "$ref": "paths/events/project-event-details.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/events/": {
      "$ref": "paths/events/project-events.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/issues/": {
      "$ref": "paths/events/project-issues.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/values/": {
      "$ref": "paths/events/tag-values.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/tags/{key}/": {
      "$ref": "paths/events/tag-details.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/hashes/": {
      "$ref": "paths/events/issue-hashes.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/oldest/": {
      "$ref": "paths/events/oldest-event.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/latest/": {
      "$ref": "paths/events/latest-event.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/events/": {
      "$ref": "paths/events/issue-events.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/issues/{issue_id}/": {
      "$ref": "paths/events/issue-details.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/": {
      "$ref": "paths/releases/organization-releases.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/{version}/": {
      "$ref": "paths/releases/organization-release.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/{version}/files/": {
      "$ref": "paths/releases/release-files.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/files/": {
      "$ref": "paths/releases/project-release-files.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/{version}/files/{file_id}/": {
      "$ref": "paths/releases/release-file.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/files/{file_id}/": {
      "$ref": "paths/releases/project-release-file.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commits/": {
      "$ref": "paths/releases/organization-release-commits.json"
    },
    "/api/0/projects/{organization_id_or_slug}/{project_id_or_slug}/releases/{version}/commits/": {
      "$ref": "paths/releases/project-release-commits.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/{version}/commitfiles/": {
      "$ref": "paths/releases/organization-release-commit-files.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/releases/{version}/deploys/": {
      "$ref": "paths/releases/deploys.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/sentry-app-installations/": {
      "$ref": "paths/integration-platform/sentry-app-installations.json"
    },
    "/api/0/sentry-app-installations/{uuid}/external-issues/": {
      "$ref": "paths/integration-platform/sentry-app-external-issues.json"
    },
    "/api/0/sentry-app-installations/{uuid}/external-issues/{external_issue_id}/": {
      "$ref": "paths/integration-platform/sentry-app-external-issue-details.json"
    },
    "/api/0/organizations/{organization_id_or_slug}/spike-protections/": {
      "$ref": "paths/projects/spike-protection.json"
    }
  },
  "components": {
    "securitySchemes": {
      "auth_token": {
        "type": "http",
        "scheme": "bearer"
      },
      "dsn": {
        "type": "http",
        "scheme": "DSN"
      }
    }
  }
}